OmniGraph Node omni.graph.ui.OnPicked

omni.graph.ui.OnPicked Properties

Name	Value
Version	1
Extension	omni.graph.ui
Has State?	False
Implementation Language	C++
Default Memory Type	cpu
Generated Code Exclusions	None
uiName	On Picked (BETA)
__categories	graph:action,ui
Generated Class Name	OgnOnPickedDatabase
Python Module	omni.graph.ui

omni.graph.ui.OnPicked Description

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.

omni.graph.ui.OnPicked Inputs

Name	Type	Default	Required?	Descripton
inputs:gesture	token	Left Mouse Click	Y	The input gesture to trigger a picking event
	displayGroup	parameters
	literalOnly	1
	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:onlyPlayback	bool	True	Y	When true, the node is only computed while Stage is being played.
	literalOnly	1
	uiName	Only Simulate On Play
	__default	true
inputs:trackedPrims	bundle	None		Optionally specify a set of tracked prims that will cause ‘Picked’ to fire when picked
	literalOnly	1
	uiName	Tracked Prims
inputs:viewport	token	Viewport	Y	Name of the viewport window to watch for picking events
	literalOnly	1
	uiName	Viewport
	__default	“Viewport”

omni.graph.ui.OnPicked Outputs

Name	Type	Default	Required?	Descripton
outputs:isTrackedPrimPicked	bool	None	Y	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)
	uiName	Is Tracked Prim Picked
outputs:missed	execution	None	Y	Enabled when an attempted picking did not pick a tracked prim, or when nothing gets picked if no tracked prims are specified
	uiName	Missed
outputs:picked	execution	None	Y	Enabled when a tracked prim is picked, or when any prim is picked if no tracked prims are specified
	uiName	Picked
outputs:pickedPrimPath	token	None	Y	The path of the picked prim, 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
outputs:trackedPrimPaths	token[]	None	Y	A list of the paths of the prims specified in ‘Tracked Prims’
	uiName	Tracked Prim Paths