simvx.core.reflection_probe

ReflectionProbe3D — Cubemap reflection capture probe for 3D scenes.

Module Contents

Classes

ReflectionProbe3D

Cubemap reflection capture probe.

Data

log

API

simvx.core.reflection_probe.log

‘getLogger(…)’

class simvx.core.reflection_probe.ReflectionProbe3D(size=None, origin_offset=None, **kwargs)

Bases: simvx.core.nodes_3d.node3d.Node3D

Cubemap reflection capture probe.

Captures a cubemap from a point in the scene and applies it as an environment map to meshes within the probe’s influence box. Supports parallax-corrected box projection for accurate indoor reflections.

The probe influence volume is an axis-aligned box centred on world_position + origin_offset with half-extents given by size.

Example::

probe = ReflectionProbe3D(
    size=(5, 3, 5),
    box_projection=True,
    interior=True,
)
room.add_child(probe)

Initialization

size

‘Property(…)’

origin_offset

‘Property(…)’

box_projection

‘Property(…)’

intensity

‘Property(…)’

max_distance

‘Property(…)’

update_mode

‘Property(…)’

interior

‘Property(…)’

ambient_mode

‘Property(…)’

ambient_colour

‘Property(…)’

cull_mask

‘Property(…)’

enable_shadows

‘Property(…)’

cubemap_updated

‘Signal(…)’

property capture_position: simvx.core.math.types.Vec3

World-space position where the cubemap is captured from.

request_update() → None

Mark this probe for cubemap recapture on the next frame.

The rendering backend checks _update_requested each frame and, after capturing, increments _cubemap_version and emits cubemap_updated.

set_cull_mask_layer(index: int, enabled: bool = True) → None

Enable or disable a specific cull mask layer (0-31).

is_cull_mask_layer_enabled(index: int) → bool

Check if a specific cull mask layer is enabled (0-31).

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

Return wireframe box lines for the probe influence volume.

Draws 12 edges of an axis-aligned box centred on capture_position with half-extents size.

render_layer

‘Property(…)’

property position

property rotation: simvx.core.math.types.Quat

property scale

property rotation_degrees: simvx.core.math.types.Vec3

property world_position: simvx.core.math.types.Vec3

property world_rotation: simvx.core.math.types.Quat

property world_scale: simvx.core.math.types.Vec3

property forward: simvx.core.math.types.Vec3

property right: simvx.core.math.types.Vec3

property up: simvx.core.math.types.Vec3

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

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

rotate(axis: tuple[float, float, float] | numpy.ndarray, angle: float)

rotate_x(angle: float)

rotate_y(angle: float)

rotate_z(angle: float)

look_at(target: tuple[float, float, float] | numpy.ndarray, up=None)

set_render_layer(index: int, enabled: bool = True) → None

is_on_render_layer(index: int) → bool

wrap_bounds(bounds: tuple[float, float, float] | numpy.ndarray, margin: float = 1.0)

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__()