Read Viewport Scroll State (BETA)
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.
Installation
To use this node enable omni.graph.ui_nodes in the Extension Manager.
Inputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Use Normalized Coords (inputs:useNormalizedCoords) |
|
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. |
False |
Viewport (inputs:viewport) |
|
Name of the viewport window to watch for scroll events |
Viewport |
Outputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Is Valid (outputs:isValid) |
|
True if a valid event state was detected and the outputs of this node are valid, and false otherwise |
None |
Position (outputs:position) |
|
The last position at which a viewport scroll event occurred in the specified viewport |
None |
Scroll Value (outputs:scrollValue) |
|
The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative |
None |
Metadata
Name |
Value |
|---|---|
Unique ID |
omni.graph.ui_nodes.ReadViewportScrollState |
Version |
1 |
Extension |
omni.graph.ui_nodes |
Has State? |
False |
Implementation Language |
C++ |
Default Memory Type |
cpu |
Generated Code Exclusions |
tests |
uiName |
Read Viewport Scroll State (BETA) |
Categories |
ui |
Generated Class Name |
OgnReadViewportScrollStateDatabase |
Python Module |
omni.graph.ui_nodes |