On Viewport Scrolled (BETA)
Event node which fires when a scroll event occurs in 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 |
|---|---|---|---|
Only Simulate On Play (inputs:onlyPlayback) |
|
When true, the node is only executed while the Stage is being played. |
True |
Metadata |
literalOnly = 1 |
||
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 |
Metadata |
literalOnly = 1 |
||
Viewport (inputs:viewport) |
|
Name of the viewport window to watch for scroll events. |
Viewport |
Metadata |
literalOnly = 1 |
Outputs
Name |
Type |
Descripton |
Default |
|---|---|---|---|
Position (outputs:position) |
|
The position at which the viewport scroll event occurred. |
None |
Scroll Value (outputs:scrollValue) |
|
The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative. |
None |
Scrolled (outputs:scrolled) |
|
When a viewport scroll event occurs in the specified viewport, signal to the graph that execution can continue downstream. |
None |
Metadata
Name |
Value |
|---|---|
Unique ID |
omni.graph.ui_nodes.OnViewportScrolled |
Version |
1 |
Extension |
omni.graph.ui_nodes |
Has State? |
False |
Implementation Language |
C++ |
Default Memory Type |
cpu |
Generated Code Exclusions |
tests |
uiName |
On Viewport Scrolled (BETA) |
Categories |
graph:action,ui |
Generated Class Name |
OgnOnViewportScrolledDatabase |
Python Module |
omni.graph.ui_nodes |