OmniGraph Node omni.graph.action.OnStageEvent¶
omni.graph.action.OnStageEvent Properties¶
Name |
Value |
---|---|
Version |
2 |
Extension |
omni.graph.action |
Has State? |
True |
Implementation Language |
Python |
Default Memory Type |
cpu |
Generated Code Exclusions |
None |
uiName |
On Stage Event |
__categories |
graph:action,event |
__language |
Python |
Generated Class Name |
OgnOnStageEventDatabase |
Python Module |
omni.graph.action |
omni.graph.action.OnStageEvent Description¶
- Executes when the specified Stage Event occurs. Stage Events are emitted when certain USD stage-related actions are performed by the system:
Saved: USD file saved. Save Failed: Failed to save USD. Opening: USD stage is opening. Opened: USD stage is opened successfully. Open Failed: USD stage failed to open. Closing: USD stage is about to close. This is a good opportunity to shutdown anything depends on USD stage. Closed: USD stage is fully closed. Selection Changed: USD Prim selection has changed. Assets Loaded: Current batch of async asset loading has been completed. Assets Load Aborted: Current batch of async asset loading has been aborted. Gizmo Tracking Changed: Started or stopped tracking (hovering) on a gizmo Mdl Param Loaded: MDL parameter is loaded for a MDL UsdShadeShader. Settings Loaded: Stage settings have loaded Settings Saving: Stage settings are being saved OmniGraph Start Play: OmniGraph updates have started OmniGraph Stop Play: OmniGraph updates have been stopped Simulation Start Play: Simulation updates have started Simulation Stop Play: Simulation updates have been stopped Animation Start Play: Animation playback has started Animation Stop Play: Animation playback has stopped
omni.graph.action.OnStageEvent Inputs¶
Name |
Type |
Default |
Required? |
Descripton |
---|---|---|---|---|
inputs:eventName |
token |
Y |
The event of interest |
|
allowedTokens |
Assets Loaded,Assets Load Aborted,Closed,Closing,Gizmo Tracking Changed,MDL Param Loaded,Opened,Open Failed,Saved,Save Failed,Selection Changed,Settings Saving,OmniGraph Start Play,OmniGraph Stop Play,Simulation Start Play,Simulation Stop Play,Animation Start Play,Animation Stop Play |
|||
default |
Animation Start Play |
|||
displayGroup |
parameters |
|||
literalOnly |
1 |
|||
__allowedTokens |
{“AssetLoaded”: “Assets Loaded”, “AssetLoadAborted”: “Assets Load Aborted”, “Closed”: “Closed”, “Closing”: “Closing”, “GizmoTrackingChanged”: “Gizmo Tracking Changed”, “MDLParamLoaded”: “MDL Param Loaded”, “Opened”: “Opened”, “OpenFailed”: “Open Failed”, “Saved”: “Saved”, “SaveFailed”: “Save Failed”, “SelectionChanged”: “Selection Changed”, “SettingsSaving”: “Settings Saving”, “OmniGraphStart”: “OmniGraph Start Play”, “OmniGraphStop”: “OmniGraph Stop Play”, “SimulationStart”: “Simulation Start Play”, “SimulationStop”: “Simulation Stop Play”, “AnimationStart”: “Animation Start Play”, “AnimationStop”: “Animation Stop Play”} |
|||
inputs:onlyPlayback |
bool |
True |
Y |
When true, the node is only computed while Stage is being played. |
literalOnly |
1 |
|||
uiName |
Only Simulate On Play |
|||
__default |
true |
omni.graph.action.OnStageEvent Outputs¶
Name |
Type |
Default |
Required? |
Descripton |
---|---|---|---|---|
outputs:execOut |
execution |
None |
Y |
The execution output |