OmniGraph Node omni.graph.ui.OnViewportClicked

omni.graph.ui.OnViewportClicked 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 Viewport Clicked (BETA)
__categories	graph:action,ui
Generated Class Name	OgnOnViewportClickedDatabase
Python Module	omni.graph.ui

omni.graph.ui.OnViewportClicked Description

Event node which fires when a viewport click event occurs in the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.

omni.graph.ui.OnViewportClicked Inputs

Name	Type	Default	Required?	Descripton
inputs:gesture	token	Left Mouse Click	Y	The input gesture to trigger viewport click events
	displayGroup	parameters
	literalOnly	1
	allowedTokens	Left Mouse Click,Right Mouse Click,Middle Mouse Click
	__allowedTokens	{“LeftMouseClick”: “Left Mouse Click”, “RightMouseClick”: “Right Mouse Click”, “MiddleMouseClick”: “Middle Mouse Click”}
	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:useNormalizedCoords	bool	False	Y	When true, the components of the 2D position output are scaled to between 0 and 1, where 0 is top/left and 1 is bottom/right. When false, components are in viewport render resolution pixels.
	literalOnly	1
	uiName	Use Normalized Coords
	__default	false
inputs:viewport	token	Viewport	Y	Name of the viewport window to watch for click events
	literalOnly	1
	uiName	Viewport
	__default	“Viewport”

omni.graph.ui.OnViewportClicked Outputs

Name	Type	Default	Required?	Descripton
outputs:clicked	execution	None	Y	Enabled when the specified input gesture triggers a viewport click event in the specified viewport
	uiName	Clicked
outputs:position	double[2]	None	Y	The position at which the viewport click event occurred
	uiName	Position