On Viewport Scrolled (BETA)

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.

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)

bool

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)

token

Name of the viewport window to watch for scroll events

Viewport

Only Simulate On Play (onlyPlayback)

bool

When true, the node is only computed while Stage is being played

True

Outputs

Name

Type

Description

Default

Scrolled (scrolled)

execution

Enabled when a viewport scroll event occurs in the specified viewport

Scroll Value (scrollValue)

float

The number of mouse wheel clicks scrolled up if positive, or scrolled down if negative

Position (position)

double[2]

The position at which the viewport scroll event occurred