`simvx.core.ui.dock`¶

DockPanel / DockContainer — dockable panel layout system.

Provides an IDE-style docking layout where panels can be placed at cardinal positions (left, right, top, bottom, center) using a binary split tree of SplitContainers.

Module Contents¶

Classes¶

`DockPanel`	Panel with a title bar header and a content area.
`DockContainer`	IDE-style docking container that arranges DockPanels using splits.

Data¶

__all__

API¶

simvx.core.ui.dock.__all__¶: [‘DockPanel’, ‘DockContainer’]

class simvx.core.ui.dock.DockPanel(title: str = '', **kwargs)¶

Bases: simvx.core.ui.widgets.Panel

Panel with a title bar header and a content area.

The title bar is 24 px tall and drawn at the top of the panel. Content is positioned below the title bar. Use set_content() to assign a child control as the panel body.

Example: dock_panel = DockPanel(name=”Inspector”) dock_panel.set_content(some_control)

Initialization

title¶: ‘Property(…)’

title_bg_color¶: ‘ThemeColour(…)’

title_text_color¶: ‘ThemeColour(…)’

bg_color¶: ‘ThemeColour(…)’

border_color¶: ‘ThemeColour(…)’

set_content(control: simvx.core.ui.core.Control)¶

Set the content control displayed below the title bar.

If a previous content control exists it is removed first. The content is added as a child and automatically positioned.

Args: control: The Control to display inside this panel.

process(dt: float)¶

draw(renderer)¶

size_x¶: ‘Property(…)’

size_y¶: ‘Property(…)’

property size: simvx.core.math.types.Vec2¶

get_theme() → simvx.core.ui.core.Theme¶

get_rect() → tuple[float, float, float, float]¶

get_global_rect() → tuple[float, float, float, float]¶

is_point_inside(point) → bool¶

set_anchor_preset(preset: simvx.core.ui.core.AnchorPreset)¶

set_focus()¶

grab_focus()¶

release_focus()¶

has_focus() → bool¶

focus_next_control()¶

focus_previous_control()¶

grab_mouse()¶

release_mouse()¶

set_drag_preview(control: simvx.core.ui.core.Control)¶

draw_popup(renderer)¶

is_popup_point_inside(point) → bool¶

popup_input(event)¶

dismiss_popup()¶

z_index¶: ‘Property(…)’

z_as_relative¶: ‘Property(…)’

property absolute_z_index: int¶

property position: simvx.core.math.types.Vec2¶

property rotation: float¶

property rotation_degrees: float¶

property scale: simvx.core.math.types.Vec2¶

property global_position: simvx.core.math.types.Vec2¶

property global_rotation: float¶

property global_scale: simvx.core.math.types.Vec2¶

property forward: simvx.core.math.types.Vec2¶

property right: simvx.core.math.types.Vec2¶

translate(offset: tuple[float, float] | numpy.ndarray)¶

rotate(radians: float)¶

rotate_deg(degrees: float)¶

look_at(target: tuple[float, float] | numpy.ndarray)¶

transform_points(points: list[simvx.core.math.types.Vec2]) → list[simvx.core.math.types.Vec2]¶

draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)¶

wrap_screen(margin: float = 20)¶

script_error_raised¶: ‘Signal(…)’

classmethod __init_subclass__(**kwargs)¶

property name: str¶

property process_mode: simvx.core.descriptors.ProcessMode¶

reset_error() → None¶

add_child(node: simvx.core.node.Node) → simvx.core.node.Node¶

remove_child(node: simvx.core.node.Node)¶

reparent(new_parent: simvx.core.node.Node)¶

get_node(path: str) → simvx.core.node.Node¶

find_child(name: str, recursive: bool = False) → simvx.core.node.Node | None¶

find(node_type: type) → simvx.core.node.Node | None¶

find_all(node_type: type, recursive: bool = True) → list¶

property path: str¶

add_to_group(group: str)¶

remove_from_group(group: str)¶

is_in_group(group: str) → bool¶

ready() → None¶

enter_tree() → None¶

exit_tree() → None¶

physics_process(dt: float) → None¶

input_event(event: simvx.core.events.InputEvent) → None¶

input(event: simvx.core.events.TreeInputEvent) → None¶

unhandled_input(event: simvx.core.events.TreeInputEvent) → None¶

start_coroutine(gen: simvx.core.descriptors.Coroutine) → simvx.core.descriptors.CoroutineHandle¶

stop_coroutine(gen_or_handle)¶

destroy()¶

queue_free¶: None

property tree: simvx.core.scene_tree.SceneTree¶

get_tree() → simvx.core.scene_tree.SceneTree¶

__getitem__(key: str)¶

classmethod get_properties() → dict[str, simvx.core.descriptors.Property]¶

get_settings¶: None

__repr__()¶

class simvx.core.ui.dock.DockContainer(**kwargs)¶

Bases: simvx.core.ui.core.Control

IDE-style docking container that arranges DockPanels using splits.

Panels are added with a position hint (“center”, “left”, “right”, “top”, “bottom”). The first panel becomes the center; subsequent panels wrap the existing content in a SplitContainer.

Example: dock = DockContainer() dock.size = Vec2(1200, 800)

scene_panel = DockPanel(title="Scene")
inspector = DockPanel(title="Inspector")
console = DockPanel(title="Console")

dock.add_panel(scene_panel, "center")
dock.add_panel(inspector, "right")
dock.add_panel(console, "bottom")

Initialization

bg_color¶: ‘ThemeColour(…)’

add_panel(panel: simvx.core.ui.dock.DockPanel, position: str = 'center')¶

Add a DockPanel at the given position.

Args: panel: The DockPanel to add. position: One of “center”, “left”, “right”, “top”, “bottom”. “left”/”right” create a vertical split. “top”/”bottom” create a horizontal split.

save_layout() → dict¶

Serialize the current dock layout to a dictionary.

Returns: A dict describing the split tree and panel names, suitable for JSON serialization.

restore_layout(data: dict)¶

Restore a previously saved layout.

Panels are looked up by title from the internal _panels list. Any panels not found in the data are ignored.

Args: data: Layout dictionary as returned by save_layout().