OmniGraph Node omni.graph.ui.ReadViewportHoverState

omni.graph.ui.ReadViewportHoverState 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 Hover State (BETA)
__categories	ui
Generated Class Name	OgnReadViewportHoverStateDatabase
Python Module	omni.graph.ui

omni.graph.ui.ReadViewportHoverState Description

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

omni.graph.ui.ReadViewportHoverState Inputs

Name	Type	Default	Required?	Descripton
inputs:useNormalizedCoords	bool	False	Y	When true, the components of 2D position and velocity outputs 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 hover events
	uiName	Viewport
	__default	“Viewport”

omni.graph.ui.ReadViewportHoverState Outputs

Name	Type	Default	Required?	Descripton
outputs:isHovered	bool	None	Y	True if the specified viewport is currently hovered
	uiName	Is Hovered
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 current mouse position if the specified viewport is currently hovered, otherwise (0,0)
	uiName	Position
outputs:velocity	double[2]	None	Y	A vector representing the change in position of the mouse since the previous frame if the specified viewport is currently hovered, otherwise (0,0)
	uiName	Velocity