simvx.core.ui.containers

Layout containers — HBox, VBox, Margin, Grid.

Module Contents

Classes

Container	Base class for layout containers.
HBoxContainer	Arranges children left-to-right.
VBoxContainer	Arranges children top-to-bottom.
MarginContainer	Adds margin around a single child.
GridContainer	Arranges children in a grid.

Data

__all__

API

simvx.core.ui.containers.__all__

[‘Container’, ‘HBoxContainer’, ‘VBoxContainer’, ‘MarginContainer’, ‘GridContainer’]

class simvx.core.ui.containers.Container(**kwargs)

Bases: simvx.core.ui.core.Control

Base class for layout containers.

Arranges children according to layout rules. Subclasses override _update_layout() to define how children are positioned.

Initialization

separation

‘Property(…)’

ready()

add_child(node)

remove_child(node)

mark_layout_dirty()

Mark this container for layout recalculation.

process(dt: float)

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

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

enter_tree() → None

exit_tree() → None

physics_process(dt: float) → None

draw(renderer) → 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.containers.HBoxContainer(**kwargs)

Bases: simvx.core.ui.containers.Container

Arranges children left-to-right.

Example: hbox = HBoxContainer() hbox.add_child(Button(“One”)) hbox.add_child(Button(“Two”))

Initialization

alignment

‘Property(…)’

separation

‘Property(…)’

ready()

add_child(node)

remove_child(node)

mark_layout_dirty()

process(dt: float)

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

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

enter_tree() → None

exit_tree() → None

physics_process(dt: float) → None

draw(renderer) → 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.containers.VBoxContainer(**kwargs)

Bases: simvx.core.ui.containers.Container

Arranges children top-to-bottom.

Example: vbox = VBoxContainer() vbox.add_child(Label(“Title”)) vbox.add_child(Button(“Start”))

Initialization

alignment

‘Property(…)’

separation

‘Property(…)’

ready()

add_child(node)

remove_child(node)

mark_layout_dirty()

process(dt: float)

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

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

enter_tree() → None

exit_tree() → None

physics_process(dt: float) → None

draw(renderer) → 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.containers.MarginContainer(margin: float = 10.0, **kwargs)

Bases: simvx.core.ui.containers.Container

Adds margin around a single child.

Example: margin = MarginContainer(margin=20) margin.add_child(Panel())

Initialization

margin_value

‘Property(…)’

separation

‘Property(…)’

ready()

add_child(node)

remove_child(node)

mark_layout_dirty()

process(dt: float)

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

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

enter_tree() → None

exit_tree() → None

physics_process(dt: float) → None

draw(renderer) → 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.containers.GridContainer(columns: int = 2, **kwargs)

Bases: simvx.core.ui.containers.Container

Arranges children in a grid.

Example: grid = GridContainer(columns=3) for i in range(9): grid.add_child(Button(f”Btn {i}”))

Initialization

columns

‘Property(…)’

separation

‘Property(…)’

ready()

add_child(node)

remove_child(node)

mark_layout_dirty()

process(dt: float)

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

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

enter_tree() → None

exit_tree() → None

physics_process(dt: float) → None

draw(renderer) → 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__()