OmniGraph Node omni.graph.ui.ReadViewportScrollState

omni.graph.ui.ReadViewportScrollState 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 Scroll State (BETA)
__categories	ui
Generated Class Name	OgnReadViewportScrollStateDatabase
Python Module	omni.graph.ui

omni.graph.ui.ReadViewportScrollState Description

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

omni.graph.ui.ReadViewportScrollState Inputs

Name	Type	Default	Required?	Descripton
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 scroll events
	uiName	Viewport
	__default	“Viewport”

omni.graph.ui.ReadViewportScrollState 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 last position at which a viewport scroll event occurred in the specified viewport
	uiName	Position
outputs:scrollValue	float	None	Y	The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative
	uiName	Scroll Value