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, you must enable omni.graph.ui_nodes in the Extension Manager.
Inputs#
Name |
Type |
Description |
Default |
|---|---|---|---|
Use Normalized Coords (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 (viewport) |
|
Name of the viewport window to watch for scroll events |
Viewport |
Outputs#
Name |
Type |
Description |
Default |
|---|---|---|---|
Scroll Value (scrollValue) |
|
The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative |
|
Position (position) |
|
The last position at which a viewport scroll event occurred in the specified viewport |
|
Is Valid (isValid) |
|
True if a valid event state was detected and the outputs of this node are valid, and false otherwise |