On Picked (BETA)
Event node which fires when a picking event occurs in the specified viewport. Note that picking events must be enabled on the specified viewport using a SetViewportMode node.
Installation
To use this Node, you must enable omni.graph.ui_nodes
in the Extension Manager.
Inputs
Name |
Type |
Description |
Default |
---|---|---|---|
Tracked Prims (trackedPrims) |
|
Optionally specify a set of tracked prims that will cause ‘Picked’ to fire when picked |
|
Viewport (viewport) |
|
Name of the viewport window to watch for picking events |
Viewport |
Gesture (gesture) |
|
The input gesture to trigger a picking event |
Left Mouse Click |
Only Simulate On Play (onlyPlayback) |
|
When true, the node is only computed while Stage is being played. |
True |
Outputs
Name |
Type |
Description |
Default |
---|---|---|---|
Picked (picked) |
|
Enabled when a tracked prim is picked, or when any prim is picked if no tracked prims are specified |
|
Missed (missed) |
|
Enabled when an attempted picking did not pick a tracked prim, or when nothing gets picked if no tracked prims are specified |
|
Picked Prim Path (pickedPrimPath) |
|
The path of the picked prim, or an empty string if nothing got picked |
|
Picked Prim (pickedPrim) |
|
The picked prim, or an empty target if nothing got picked |
|
Picked World Position (pickedWorldPos) |
|
The XYZ-coordinates of the point in world space at which the prim got picked, or (0,0,0) if nothing got picked |
|
Is Tracked Prim Picked (isTrackedPrimPicked) |
|
True if a tracked prim got picked, or if any prim got picked if no tracked prims are specified (will always be true when ‘Picked’ fires, and false when ‘Missed’ fires) |
|
Tracked Prim Paths (trackedPrimPaths) |
|
A list of the paths of the prims specified in ‘Tracked Prims’ |