On Stage Event

Activates the downstream graph execution when the specified ‘Event Name’ from the Stage occurs. Stage Events are emitted when certain USD stage-related actions are performed by the system: Saved: USD file saved. Selection Changed: USD Prim selection has changed. Hierarchy Changed: USD stage hierarchy has changed, e.g. a prim is added, deleted or moved. OmniGraph Start Play: OmniGraph started. OmniGraph Stop Play: OmniGraph stopped. Simulation Start Play: Simulation started. Simulation Stop Play: Simulation stopped. Animation Start Play: Animation playback has started. Animation Stop Play: Animation playback has stopped.

Installation

To use this node enable omni.graph.action_nodes in the Extension Manager.

Inputs

Name

Type

Descripton

Default

Event Name (inputs:eventName)

token

The event of interest

Metadata

allowedTokens = Saved,Selection Changed,Hierarchy Changed,OmniGraph Start Play,OmniGraph Stop Play,Simulation Start Play,Simulation Stop Play,Animation Start Play,Animation Stop Play

Metadata

default = Animation Start Play

Metadata

displayGroup = parameters

Metadata

literalOnly = 1

Only Simulate On Play (inputs:onlyPlayback)

bool

When true, the node is only executed while the Stage is being played.

True

Metadata

literalOnly = 1

Outputs

Name

Type

Descripton

Default

Exec Out (outputs:execOut)

execution

After the stage event is received, signal to the graph that execution can continue downstream.

None

Metadata

Name

Value

Unique ID

omni.graph.action.OnStageEvent

Version

4

Extension

omni.graph.action_nodes

Has State?

True

Implementation Language

Python

Default Memory Type

cpu

Generated Code Exclusions

None

uiName

On Stage Event

Categories

graph:action,event

Generated Class Name

OgnOnStageEventDatabase

Python Module

omni.graph.action_nodes