Read Pick State (BETA)
Read the state of the last picking event from the specified viewport. Note that picking events must be enabled on the specified viewport using a SetViewportMode node.
Installation
To use this node enable omni.graph.ui_nodes in the Extension Manager.
Inputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Gesture (inputs:gesture) |
|
The input gesture to trigger a picking event |
Left Mouse Click |
Metadata |
displayGroup = parameters |
||
Metadata |
allowedTokens = Left Mouse Click,Right Mouse Click,Middle Mouse Click,Left Mouse Press,Right Mouse Press,Middle Mouse Press |
||
Tracked Prim Paths (inputs:trackedPrimPaths) |
|
Optionally specify a set of prims (by paths) to track whether or not they got picked (only affects the value of ‘Is Tracked Prim Picked’) |
None |
Tracked Prims (inputs:trackedPrims) |
|
Optionally specify a set of prims to track whether or not they got picked (only affects the value of ‘Is Tracked Prim Picked’) |
None |
Metadata |
allowMultiInputs = 1 |
||
Use Paths (inputs:usePaths) |
|
When true, ‘Tracked Prim Paths’ is used, otherwise ‘Tracked Prims’ is used |
False |
Viewport (inputs:viewport) |
|
Name of the viewport window to watch for picking events |
Viewport |
Outputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Is Tracked Prim Picked (outputs:isTrackedPrimPicked) |
|
True if a tracked prim got picked in the last picking event, or if any prim got picked if no tracked prims are specified |
None |
Is Valid (outputs:isValid) |
|
True if a valid event state was detected and the outputs of this node are valid, and false otherwise |
None |
Picked Prim (outputs:pickedPrim) |
|
The picked prim, or an empty target if nothing got picked |
None |
Picked Prim Path (outputs:pickedPrimPath) |
|
The path of the prim picked in the last picking event, or an empty string if nothing got picked |
None |
Picked World Position (outputs:pickedWorldPos) |
|
The XYZ-coordinates of the point in world space at which the prim got picked, or (0,0,0) if nothing got picked |
None |
Metadata
Name |
Value |
|---|---|
Unique ID |
omni.graph.ui_nodes.ReadPickState |
Version |
2 |
Extension |
omni.graph.ui_nodes |
Has State? |
False |
Implementation Language |
C++ |
Default Memory Type |
cpu |
Generated Code Exclusions |
tests |
uiName |
Read Pick State (BETA) |
Categories |
ui |
Generated Class Name |
OgnReadPickStateDatabase |
Python Module |
omni.graph.ui_nodes |