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

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

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

## Module Contents

### Classes

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

* - {py:obj}`DockPanel <simvx.core.ui.dock.DockPanel>`
  - ```{autodoc2-docstring} simvx.core.ui.dock.DockPanel
    :summary:
    ```
* - {py:obj}`DockContainer <simvx.core.ui.dock.DockContainer>`
  - ```{autodoc2-docstring} simvx.core.ui.dock.DockContainer
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.ui.dock.__all__
:value: >
   ['DockPanel', 'DockContainer']

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

````

`````{py:class} DockPanel(title: str = '', **kwargs)
:canonical: simvx.core.ui.dock.DockPanel

Bases: {py:obj}`simvx.core.ui.widgets.Panel`

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.__init__
```

````{py:attribute} title
:canonical: simvx.core.ui.dock.DockPanel.title
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.title
```

````

````{py:attribute} title_bg_color
:canonical: simvx.core.ui.dock.DockPanel.title_bg_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.title_bg_color
```

````

````{py:attribute} title_text_color
:canonical: simvx.core.ui.dock.DockPanel.title_text_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.title_text_color
```

````

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

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.bg_color
```

````

````{py:attribute} border_color
:canonical: simvx.core.ui.dock.DockPanel.border_color
:value: >
   'ThemeColour(...)'

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.border_color
```

````

````{py:method} set_content(control: simvx.core.ui.core.Control)
:canonical: simvx.core.ui.dock.DockPanel.set_content

```{autodoc2-docstring} simvx.core.ui.dock.DockPanel.set_content
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.ui.dock.DockPanel.process

````

````{py:method} draw(renderer)
:canonical: simvx.core.ui.dock.DockPanel.draw

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} set_focus()
:canonical: simvx.core.ui.dock.DockPanel.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.core.ui.dock.DockPanel.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.core.ui.dock.DockPanel.release_focus

````

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

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.dock.DockPanel.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.dock.DockPanel.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.core.ui.dock.DockPanel.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.core.ui.dock.DockPanel.release_mouse

````

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

````

````{py:method} draw_popup(renderer)
:canonical: simvx.core.ui.dock.DockPanel.draw_popup

````

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

````

````{py:method} popup_input(event)
:canonical: simvx.core.ui.dock.DockPanel.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.core.ui.dock.DockPanel.dismiss_popup

````

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

````

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

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.dock.DockPanel.absolute_z_index
:type: int

````

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

````

````{py:property} rotation
:canonical: simvx.core.ui.dock.DockPanel.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.dock.DockPanel.rotation_degrees
:type: float

````

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

````

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

````

````{py:property} global_rotation
:canonical: simvx.core.ui.dock.DockPanel.global_rotation
:type: float

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} name
:canonical: simvx.core.ui.dock.DockPanel.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.ui.dock.DockPanel.process_mode
:type: simvx.core.descriptors.ProcessMode

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.ui.dock.DockPanel.path
:type: str

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.dock.DockPanel.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.ui.dock.DockPanel.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.ui.dock.DockPanel.queue_free
:value: >
   None

````

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

````

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

````

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

````

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

````

````{py:attribute} get_settings
:canonical: simvx.core.ui.dock.DockPanel.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.ui.dock.DockPanel.__repr__

````

`````

`````{py:class} DockContainer(**kwargs)
:canonical: simvx.core.ui.dock.DockContainer

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

```{autodoc2-docstring} simvx.core.ui.dock.DockContainer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.dock.DockContainer.__init__
```

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

```{autodoc2-docstring} simvx.core.ui.dock.DockContainer.bg_color
```

````

````{py:method} add_panel(panel: simvx.core.ui.dock.DockPanel, position: str = 'center')
:canonical: simvx.core.ui.dock.DockContainer.add_panel

```{autodoc2-docstring} simvx.core.ui.dock.DockContainer.add_panel
```

````

````{py:method} save_layout() -> dict
:canonical: simvx.core.ui.dock.DockContainer.save_layout

```{autodoc2-docstring} simvx.core.ui.dock.DockContainer.save_layout
```

````

````{py:method} restore_layout(data: dict)
:canonical: simvx.core.ui.dock.DockContainer.restore_layout

```{autodoc2-docstring} simvx.core.ui.dock.DockContainer.restore_layout
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.ui.dock.DockContainer.process

````

````{py:method} draw(renderer)
:canonical: simvx.core.ui.dock.DockContainer.draw

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} set_focus()
:canonical: simvx.core.ui.dock.DockContainer.set_focus

````

````{py:method} grab_focus()
:canonical: simvx.core.ui.dock.DockContainer.grab_focus

````

````{py:method} release_focus()
:canonical: simvx.core.ui.dock.DockContainer.release_focus

````

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

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.dock.DockContainer.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.dock.DockContainer.focus_previous_control

````

````{py:method} grab_mouse()
:canonical: simvx.core.ui.dock.DockContainer.grab_mouse

````

````{py:method} release_mouse()
:canonical: simvx.core.ui.dock.DockContainer.release_mouse

````

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

````

````{py:method} draw_popup(renderer)
:canonical: simvx.core.ui.dock.DockContainer.draw_popup

````

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

````

````{py:method} popup_input(event)
:canonical: simvx.core.ui.dock.DockContainer.popup_input

````

````{py:method} dismiss_popup()
:canonical: simvx.core.ui.dock.DockContainer.dismiss_popup

````

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

````

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

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.dock.DockContainer.absolute_z_index
:type: int

````

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

````

````{py:property} rotation
:canonical: simvx.core.ui.dock.DockContainer.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.dock.DockContainer.rotation_degrees
:type: float

````

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

````

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

````

````{py:property} global_rotation
:canonical: simvx.core.ui.dock.DockContainer.global_rotation
:type: float

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} name
:canonical: simvx.core.ui.dock.DockContainer.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.ui.dock.DockContainer.process_mode
:type: simvx.core.descriptors.ProcessMode

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:property} path
:canonical: simvx.core.ui.dock.DockContainer.path
:type: str

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

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

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.dock.DockContainer.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.ui.dock.DockContainer.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.ui.dock.DockContainer.queue_free
:value: >
   None

````

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

````

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

````

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

````

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

````

````{py:attribute} get_settings
:canonical: simvx.core.ui.dock.DockContainer.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.ui.dock.DockContainer.__repr__

````

`````