OmniGraph Node omni.graph.ui.ReadViewportClickState

omni.graph.ui.ReadViewportClickState 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 Viewport Click State (BETA)
__categories	ui
Generated Class Name	OgnReadViewportClickStateDatabase
Python Module	omni.graph.ui

omni.graph.ui.ReadViewportClickState Description

Read the state of the last viewport click event from the specified viewport. Note that viewport mouse events must be enabled on the specified viewport using a SetViewportMode node.

omni.graph.ui.ReadViewportClickState Inputs

Name	Type	Default	Required?	Descripton
inputs:gesture	token	Left Mouse Click	Y	The input gesture to trigger viewport click events
	displayGroup	parameters
	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: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.
	uiName	Use Normalized Coords
	__default	false
inputs:viewport	token	Viewport	Y	Name of the viewport window to watch for click events
	uiName	Viewport
	__default	“Viewport”

omni.graph.ui.ReadViewportClickState Outputs

Name	Type	Default	Required?	Descripton
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:position	double[2]	None	Y	The position at which the specified input gesture last triggered a viewport click event in the specified viewport
	uiName	Position