simvx.core.nodes_2d.path

Path2D and PathFollow2D – 2D path-following nodes.

Module Contents

Classes

Path2D

Holds a Curve2D for path-following, positioned in 2D space.

PathFollow2D

Moves along a parent Path2D’s curve based on progress.

API

class simvx.core.nodes_2d.path.Path2D(**kwargs)[source]

Bases: simvx.core.nodes_2d.node2d.Node2D

Holds a Curve2D for path-following, positioned in 2D space.

Initialization

gizmo_colour

‘Property(…)’

get_gizmo_lines() → list[tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2]][source]

Return connected line segments sampling the curve.

z_index

‘Property(…)’

z_as_relative

‘Property(…)’

render_layer

‘Property(…)’

set_render_layer(index: int, enabled: bool = True) → None
is_on_render_layer(index: int) → bool
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 world_position: simvx.core.math.types.Vec2
property world_rotation: float
property world_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, colour=None)
wrap_screen(margin: float = 20)
strict_errors: ClassVar[bool]

True

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, recursive: bool = True) → 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
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)
clear_children()
destroy()
property app
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]
__repr__()
class simvx.core.nodes_2d.path.PathFollow2D(**kwargs)[source]

Bases: simvx.core.nodes_2d.node2d.Node2D

Moves along a parent Path2D’s curve based on progress.

Must be a child of a Path2D node. Updates position (and optionally rotation) each frame based on the current progress along the curve.

Initialization

h_offset

‘Property(…)’

v_offset

‘Property(…)’

rotates

‘Property(…)’

loop

‘Property(…)’

cubic_interp

‘Property(…)’

loop_completed

‘Signal(…)’

property progress: float

Distance along the curve (0 to curve length).

property progress_ratio: float

Normalized progress (0.0 to 1.0).

process(dt: float)[source]
z_index

‘Property(…)’

z_as_relative

‘Property(…)’

render_layer

‘Property(…)’

set_render_layer(index: int, enabled: bool = True) → None
is_on_render_layer(index: int) → bool
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 world_position: simvx.core.math.types.Vec2
property world_rotation: float
property world_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, colour=None)
wrap_screen(margin: float = 20)
strict_errors: ClassVar[bool]

True

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, recursive: bool = True) → 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
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)
clear_children()
destroy()
property app
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]
__repr__()