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

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

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

## Module Contents

### Classes

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

* - {py:obj}`TreeItem <simvx.core.ui.tree.TreeItem>`
  - ```{autodoc2-docstring} simvx.core.ui.tree.TreeItem
    :summary:
    ```
* - {py:obj}`TreeView <simvx.core.ui.tree.TreeView>`
  - ```{autodoc2-docstring} simvx.core.ui.tree.TreeView
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.ui.tree.__all__
:value: >
   ['TreeItem', 'TreeView']

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

````

`````{py:class} TreeItem(text: str = '', children: list[simvx.core.ui.tree.TreeItem] | None = None, expanded: bool = True, data: typing.Any = None)
:canonical: simvx.core.ui.tree.TreeItem

```{autodoc2-docstring} simvx.core.ui.tree.TreeItem
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.tree.TreeItem.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.ui.tree.TreeItem.__slots__
:value: >
   ('text', 'children', 'expanded', 'data', 'parent')

```{autodoc2-docstring} simvx.core.ui.tree.TreeItem.__slots__
```

````

````{py:method} add_child(item: simvx.core.ui.tree.TreeItem) -> simvx.core.ui.tree.TreeItem
:canonical: simvx.core.ui.tree.TreeItem.add_child

```{autodoc2-docstring} simvx.core.ui.tree.TreeItem.add_child
```

````

````{py:method} remove_child(item: simvx.core.ui.tree.TreeItem)
:canonical: simvx.core.ui.tree.TreeItem.remove_child

```{autodoc2-docstring} simvx.core.ui.tree.TreeItem.remove_child
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.ui.tree.TreeItem.__repr__

````

`````

`````{py:class} TreeView(root: simvx.core.ui.tree.TreeItem | None = None, **kwargs)
:canonical: simvx.core.ui.tree.TreeView

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

```{autodoc2-docstring} simvx.core.ui.tree.TreeView
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.tree.TreeView.__init__
```

````{py:attribute} bg_color
:canonical: simvx.core.ui.tree.TreeView.bg_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.tree.TreeView.bg_color
```

````

````{py:attribute} text_color
:canonical: simvx.core.ui.tree.TreeView.text_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.tree.TreeView.text_color
```

````

````{py:attribute} select_color
:canonical: simvx.core.ui.tree.TreeView.select_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.tree.TreeView.select_color
```

````

````{py:attribute} hover_color
:canonical: simvx.core.ui.tree.TreeView.hover_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.tree.TreeView.hover_color
```

````

````{py:attribute} arrow_color
:canonical: simvx.core.ui.tree.TreeView.arrow_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.tree.TreeView.arrow_color
```

````

````{py:method} draw(renderer)
:canonical: simvx.core.ui.tree.TreeView.draw

````

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

````

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

````

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

````

````{py:method} get_theme() -> simvx.core.ui.core.Theme
:canonical: simvx.core.ui.tree.TreeView.get_theme

````

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

````

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

````

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

````

````{py:method} set_anchor_preset(preset: simvx.core.ui.core.AnchorPreset)
:canonical: simvx.core.ui.tree.TreeView.set_anchor_preset

````

````{py:method} set_focus()
:canonical: simvx.core.ui.tree.TreeView.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.core.ui.tree.TreeView.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.core.ui.tree.TreeView.release_focus

````

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

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.tree.TreeView.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.tree.TreeView.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.core.ui.tree.TreeView.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.core.ui.tree.TreeView.release_mouse

````

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

````

````{py:method} draw_popup(renderer)
:canonical: simvx.core.ui.tree.TreeView.draw_popup

````

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

````

````{py:method} popup_input(event)
:canonical: simvx.core.ui.tree.TreeView.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.core.ui.tree.TreeView.dismiss_popup

````

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

````

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

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.tree.TreeView.absolute_z_index
:type: int

````

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

````

````{py:property} rotation
:canonical: simvx.core.ui.tree.TreeView.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.tree.TreeView.rotation_degrees
:type: float

````

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

````

````{py:property} global_position
:canonical: simvx.core.ui.tree.TreeView.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.ui.tree.TreeView.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.ui.tree.TreeView.global_scale
:type: simvx.core.math.types.Vec2

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} name
:canonical: simvx.core.ui.tree.TreeView.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.ui.tree.TreeView.process_mode
:type: simvx.core.descriptors.ProcessMode

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.ui.tree.TreeView.find

````

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

````

````{py:property} path
:canonical: simvx.core.ui.tree.TreeView.path
:type: str

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.tree.TreeView.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.ui.tree.TreeView.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.ui.tree.TreeView.queue_free
:value: >
   None

````

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

````

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

````

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

````

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

````

````{py:attribute} get_settings
:canonical: simvx.core.ui.tree.TreeView.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.ui.tree.TreeView.__repr__

````

`````