StageUpdate
- class omni.stageupdate.StageUpdate
Bases:
pybind11_object
Methods
__init__
(*args, **kwargs)create_stage_update_node
(self, display_name, ...)get_stage_update_nodes
(self)set_stage_update_node_enabled
(self, index, ...)Toggle Simulation Node enable/disable.
set_stage_update_node_order
(self, index, order)Change Simulation Node order.
Subscribes to Simulation Node(s) change events.
- __init__(*args, **kwargs)
- create_stage_update_node(self: omni.stageupdate._stageupdate.StageUpdate, display_name: str, on_attach_fn: Callable[[int, float], None] = None, on_detach_fn: Callable[[], None] = None, on_update_fn: Callable[[float, float], None] = None, on_prim_add_fn: Callable[[str], None] = None, on_prim_or_property_change_fn: Callable[[str], None] = None, on_prim_remove_fn: Callable[[str], None] = None, on_raycast_fn: Callable[[carb::Float3, carb::Float3, bool], None] = None) omni.stageupdate._stageupdate.StageUpdateNode
- get_stage_update_nodes(self: omni.stageupdate._stageupdate.StageUpdate) tuple
- set_stage_update_node_enabled(self: omni.stageupdate._stageupdate.StageUpdate, index: int, enabled: bool) None
Toggle Simulation Node enable/disable.
- Parameters
index (int) – Simulation Node index in tuple, returned by `get_stage_update_nodes`.
enabled (bool) – Enable/disable toggle.
- set_stage_update_node_order(self: omni.stageupdate._stageupdate.StageUpdate, index: int, order: int) None
Change Simulation Node order.
- Parameters
index (int) – Simulation Node index in tuple, returned by `get_stage_update_nodes`.
order (int) – Order to sort on.
- subscribe_to_stage_update_node_change_events(self: omni.stageupdate._stageupdate.StageUpdate, fn: Callable[[], None]) carb::Subscription
Subscribes to Simulation Node(s) change events.
Event is triggered when nodes are added, removed, toggled.
See
Subscription
for more information on subscribing mechanism.- Parameters
fn – The callback to be called on change.
- Returns
The subscription holder.