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, you must enable omni.graph.ui_nodes in the Extension Manager.

Inputs

Name

Type

Description

Default

Tracked Prim Paths (trackedPrimPaths)

token[]

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’)

Use Paths (usePaths)

bool

When true, ‘Tracked Prim Paths’ is used, otherwise ‘Tracked Prims’ is used

False

Tracked Prims (trackedPrims)

target

Optionally specify a set of prims to track whether or not they got picked (only affects the value of ‘Is Tracked Prim Picked’)

Viewport (viewport)

token

Name of the viewport window to watch for picking events

Viewport

Gesture (gesture)

token

The input gesture to trigger a picking event

Left Mouse Click

Outputs

Name

Type

Description

Default

Picked Prim Path (pickedPrimPath)

token

The path of the prim picked in the last picking event, or an empty string if nothing got picked

Picked Prim (pickedPrim)

target

The picked prim, or an empty target if nothing got picked

Picked World Position (pickedWorldPos)

pointd[3]

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)

bool

True if a tracked prim got picked in the last picking event, or if any prim got picked if no tracked prims are specified

Is Valid (isValid)

bool

True if a valid event state was detected and the outputs of this node are valid, and false otherwise