# {py:mod}`simvx.core.ui.virtual_controls`

```{py:module} simvx.core.ui.virtual_controls
```

```{autodoc2-docstring} simvx.core.ui.virtual_controls
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`VirtualJoystick <simvx.core.ui.virtual_controls.VirtualJoystick>`
  - ```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualJoystick
    :summary:
    ```
* - {py:obj}`VirtualDPad <simvx.core.ui.virtual_controls.VirtualDPad>`
  - ```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualDPad
    :summary:
    ```
* - {py:obj}`VirtualButton <simvx.core.ui.virtual_controls.VirtualButton>`
  - ```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualButton
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`log <simvx.core.ui.virtual_controls.log>`
  - ```{autodoc2-docstring} simvx.core.ui.virtual_controls.log
    :summary:
    ```
* - {py:obj}`__all__ <simvx.core.ui.virtual_controls.__all__>`
  - ```{autodoc2-docstring} simvx.core.ui.virtual_controls.__all__
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.core.ui.virtual_controls.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.ui.virtual_controls.log
```

````

````{py:data} __all__
:canonical: simvx.core.ui.virtual_controls.__all__
:value: >
   ['VirtualJoystick', 'VirtualDPad', 'VirtualButton']

```{autodoc2-docstring} simvx.core.ui.virtual_controls.__all__
```

````

`````{py:class} VirtualJoystick(**kwargs)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick

Bases: {py:obj}`simvx.core.ui.core.Control`

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualJoystick
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualJoystick.__init__
```

````{py:attribute} dead_zone
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.dead_zone
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualJoystick.dead_zone
```

````

````{py:attribute} radius
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.radius
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualJoystick.radius
```

````

````{py:method} draw(renderer)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.draw

````

````{py:attribute} size_x
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.size_y
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.size
:type: simvx.core.math.types.Vec2

````

````{py:attribute} touch_mode
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.touch_mode
:type: str
:value: >
   'mouse'

````

````{py:property} theme
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.mouse_over
:type: bool

````

````{py:property} focused
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.focused
:type: bool

````

````{py:property} disabled
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_theme

````

````{py:method} queue_redraw()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.queue_redraw

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_minimum_size

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_global_rect

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.is_point_inside

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.release_focus

````

````{py:method} has_focus() -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.has_focus

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.release_mouse

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.set_drag_preview

````

````{py:method} draw_popup(renderer)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.draw_popup

````

````{py:method} is_popup_point_inside(point) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.is_popup_point_inside

````

````{py:method} popup_input(event)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.dismiss_popup

````

````{py:attribute} z_index
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.find_all

````

````{py:property} path
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.destroy

````

````{py:property} app
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.app

````

````{py:property} tree
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.ui.virtual_controls.VirtualJoystick.__repr__

````

`````

`````{py:class} VirtualDPad(**kwargs)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad

Bases: {py:obj}`simvx.core.ui.core.Control`

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualDPad
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualDPad.__init__
```

````{py:method} draw(renderer)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.draw

````

````{py:attribute} size_x
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.size_y
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.size
:type: simvx.core.math.types.Vec2

````

````{py:attribute} touch_mode
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.touch_mode
:type: str
:value: >
   'mouse'

````

````{py:property} theme
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.mouse_over
:type: bool

````

````{py:property} focused
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.focused
:type: bool

````

````{py:property} disabled
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_theme

````

````{py:method} queue_redraw()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.queue_redraw

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_minimum_size

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_global_rect

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.is_point_inside

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.release_focus

````

````{py:method} has_focus() -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.has_focus

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.release_mouse

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.set_drag_preview

````

````{py:method} draw_popup(renderer)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.draw_popup

````

````{py:method} is_popup_point_inside(point) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.is_popup_point_inside

````

````{py:method} popup_input(event)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.dismiss_popup

````

````{py:attribute} z_index
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.find_all

````

````{py:property} path
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.destroy

````

````{py:property} app
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.app

````

````{py:property} tree
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.ui.virtual_controls.VirtualDPad.__repr__

````

`````

`````{py:class} VirtualButton(**kwargs)
:canonical: simvx.core.ui.virtual_controls.VirtualButton

Bases: {py:obj}`simvx.core.ui.core.Control`

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualButton
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualButton.__init__
```

````{py:attribute} label
:canonical: simvx.core.ui.virtual_controls.VirtualButton.label
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualButton.label
```

````

````{py:attribute} button_radius
:canonical: simvx.core.ui.virtual_controls.VirtualButton.button_radius
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.virtual_controls.VirtualButton.button_radius
```

````

````{py:method} draw(renderer)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.draw

````

````{py:attribute} size_x
:canonical: simvx.core.ui.virtual_controls.VirtualButton.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.core.ui.virtual_controls.VirtualButton.size_y
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.core.ui.virtual_controls.VirtualButton.size
:type: simvx.core.math.types.Vec2

````

````{py:attribute} touch_mode
:canonical: simvx.core.ui.virtual_controls.VirtualButton.touch_mode
:type: str
:value: >
   'mouse'

````

````{py:property} theme
:canonical: simvx.core.ui.virtual_controls.VirtualButton.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.core.ui.virtual_controls.VirtualButton.mouse_over
:type: bool

````

````{py:property} focused
:canonical: simvx.core.ui.virtual_controls.VirtualButton.focused
:type: bool

````

````{py:property} disabled
:canonical: simvx.core.ui.virtual_controls.VirtualButton.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_theme

````

````{py:method} queue_redraw()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.queue_redraw

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_minimum_size

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_global_rect

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualButton.is_point_inside

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.enums.AnchorPreset)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.release_focus

````

````{py:method} has_focus() -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualButton.has_focus

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.release_mouse

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.set_drag_preview

````

````{py:method} draw_popup(renderer)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.draw_popup

````

````{py:method} is_popup_point_inside(point) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualButton.is_popup_point_inside

````

````{py:method} popup_input(event)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.dismiss_popup

````

````{py:attribute} z_index
:canonical: simvx.core.ui.virtual_controls.VirtualButton.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.ui.virtual_controls.VirtualButton.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.ui.virtual_controls.VirtualButton.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualButton.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.virtual_controls.VirtualButton.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.ui.virtual_controls.VirtualButton.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.ui.virtual_controls.VirtualButton.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.virtual_controls.VirtualButton.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.ui.virtual_controls.VirtualButton.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.core.ui.virtual_controls.VirtualButton.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.ui.virtual_controls.VirtualButton.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.ui.virtual_controls.VirtualButton.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.ui.virtual_controls.VirtualButton.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.ui.virtual_controls.VirtualButton.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.ui.virtual_controls.VirtualButton.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.core.ui.virtual_controls.VirtualButton.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.ui.virtual_controls.VirtualButton.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.ui.virtual_controls.VirtualButton.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.ui.virtual_controls.VirtualButton.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.ui.virtual_controls.VirtualButton.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.ui.virtual_controls.VirtualButton.find_all

````

````{py:property} path
:canonical: simvx.core.ui.virtual_controls.VirtualButton.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.ui.virtual_controls.VirtualButton.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.physics_process

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.ui.virtual_controls.VirtualButton.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.ui.virtual_controls.VirtualButton.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.destroy

````

````{py:property} app
:canonical: simvx.core.ui.virtual_controls.VirtualButton.app

````

````{py:property} tree
:canonical: simvx.core.ui.virtual_controls.VirtualButton.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.ui.virtual_controls.VirtualButton.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.ui.virtual_controls.VirtualButton.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.ui.virtual_controls.VirtualButton.__repr__

````

`````