OmniGraph Node omni.graph.ui.OnViewportScrolled

omni.graph.ui.OnViewportScrolled 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 Scrolled (BETA)
__categories	graph:action,ui
Generated Class Name	OgnOnViewportScrolledDatabase
Python Module	omni.graph.ui

omni.graph.ui.OnViewportScrolled Description

Event node which fires when a viewport scroll 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.OnViewportScrolled Inputs

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

omni.graph.ui.OnViewportScrolled Outputs

Name	Type	Default	Required?	Descripton
outputs:position	double[2]	None	Y	The position at which the viewport scroll event occurred
	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
outputs:scrolled	execution	None	Y	Enabled when a viewport scroll event occurs in the specified viewport
	uiName	Scrolled