OmniGraph Node omni.graph.ui.ReadPickState

omni.graph.ui.ReadPickState Properties

Name	Value
Version	1
Extension	omni.graph.ui
Has State?	False
Implementation Language	C++
Default Memory Type	cpu
Generated Code Exclusions	None
uiName	Read Pick State (BETA)
__categories	ui
Generated Class Name	OgnReadPickStateDatabase
Python Module	omni.graph.ui

omni.graph.ui.ReadPickState Description

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.

omni.graph.ui.ReadPickState Inputs

Name	Type	Default	Required?	Descripton
inputs:gesture	token	Left Mouse Click	Y	The input gesture to trigger a picking event
	displayGroup	parameters
	allowedTokens	Left Mouse Click,Right Mouse Click,Middle Mouse Click,Left Mouse Press,Right Mouse Press,Middle Mouse Press
	__allowedTokens	{“LeftMouseClick”: “Left Mouse Click”, “RightMouseClick”: “Right Mouse Click”, “MiddleMouseClick”: “Middle Mouse Click”, “LeftMousePress”: “Left Mouse Press”, “RightMousePress”: “Right Mouse Press”, “MiddleMousePress”: “Middle Mouse Press”}
	uiName	Gesture
	__default	“Left Mouse Click”
inputs:trackedPrimPaths	token[]	None		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’)
	uiName	Tracked Prim Paths
inputs:trackedPrims	bundle	None		Optionally specify a set of prims to track whether or not they got picked (only affects the value of ‘Is Tracked Prim Picked’)
	uiName	Tracked Prims
inputs:usePaths	bool	False	Y	When true, ‘Tracked Prim Paths’ is used, otherwise ‘Tracked Prims’ is used
	uiName	Use Paths
	__default	false
inputs:viewport	token	Viewport	Y	Name of the viewport window to watch for picking events
	uiName	Viewport
	__default	“Viewport”

omni.graph.ui.ReadPickState Outputs

Name	Type	Default	Required?	Descripton
outputs:isTrackedPrimPicked	bool	None	Y	True if a tracked prim got picked in the last picking event, or if any prim got picked if no tracked prims are specified
	uiName	Is Tracked Prim Picked
outputs:isValid	bool	None	Y	True if a valid event state was detected and the outputs of this node are valid, and false otherwise
	uiName	Is Valid
outputs:pickedPrimPath	token	None	Y	The path of the prim picked in the last picking event, or an empty string if nothing got picked
	uiName	Picked Prim Path
outputs:pickedWorldPos	pointd[3]	None	Y	The XYZ-coordinates of the point in world space at which the prim got picked, or (0,0,0) if nothing got picked
	uiName	Picked World Position