`simvx.core.ui.menu`¶

Menu widgets – MenuItem, PopupMenu, MenuBar.

Module Contents¶

Classes¶

`MenuItem`	Data for a single menu entry (text, callback, shortcut, or separator).
`PopupMenu`	Dropdown popup showing a vertical list of MenuItems.
`MenuBar`	Horizontal menu bar with named dropdown popups.

Data¶

API¶

simvx.core.ui.menu.__all__¶: [‘MenuItem’, ‘PopupMenu’, ‘MenuBar’]

class simvx.core.ui.menu.MenuItem(text: str = '', callback: collections.abc.Callable = None, shortcut: str = '', separator: bool = False)¶

Data for a single menu entry (text, callback, shortcut, or separator).

Initialization

__slots__¶: (‘text’, ‘callback’, ‘shortcut’, ‘separator’)

class simvx.core.ui.menu.PopupMenu(items: list[simvx.core.ui.menu.MenuItem] = None, **kwargs)¶

Bases: simvx.core.ui.core.Control

Dropdown popup showing a vertical list of MenuItems.

Initialization

bg_color¶: ‘ThemeColour(…)’

hover_color¶: ‘ThemeColour(…)’

text_color¶: ‘ThemeColour(…)’

shortcut_color¶: ‘ThemeColour(…)’

separator_color¶: ‘ThemeColour(…)’

border_color¶: ‘ThemeColour(…)’

show(x: float, y: float)¶: Position the menu and make it visible.

hide()¶: Close the menu.

is_popup_point_inside(point) → bool¶

popup_input(event)¶

dismiss_popup()¶

draw(renderer)¶

draw_popup(renderer)¶: Draw menu as an overlay (on top of everything).

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)¶

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¶

process(dt: float) → 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.menu.MenuBar(**kwargs)¶

Bases: simvx.core.ui.core.Control

Horizontal menu bar with named dropdown popups.

Initialization

BAR_HEIGHT¶: 28.0

bg_color¶: ‘ThemeColour(…)’

text_color¶: ‘ThemeColour(…)’

hover_color¶: ‘ThemeColour(…)’

add_menu(name: str, items: list[simvx.core.ui.menu.MenuItem]) → simvx.core.ui.menu.PopupMenu¶: Add a named dropdown menu to the bar.

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¶

process(dt: float) → 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__()¶