DOM & Scroll Controls
DOM & Scroll Control operators interface the 3D scene engine directly with the surrounding web application document wrapper.
DOM Action Operator for HTML & CSS Updates#
1. Functional Overview
The DOM Action operator provides direct procedural links between the 3D context and the hosting webpage's HTML structure. It allows the scene's event hooks to toggle element classes, inject stylesheet parameters, or retrieve browser input parameters programmatically.
DOM Action
DOM_ACTORGENERAL_ALLDOM Action Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
selector: string | CSS Selector | STRINGTEXT INPUT | "" |
action: "CLICK" | "DOUBLE_CLICK" | "HOVER" | "TYPE_TEXT" | "SET_VALUE" | "SET_ATTRIBUTE" | "GET_ATTRIBUTE" | "GET_PROPERTY" | "ADD_CLASS" | "REMOVE_CLASS" | "TOGGLE_CLASS" | "SET_STYLE" | "SCROLL_TO" | "FOCUS" | Action To Perform | ENUMDROPDOWN | "CLICK" |
payload: string | Text / Value Payload | STRINGTEXT INPUT | "" |
attributeKey: string | Attribute / Property Name | STRINGTEXT INPUT | "" |
shouldWait: boolean | Wait for Element | BOOLTOGGLE | false |
waitTimeout: int | Timeout (ms) | INTRANGE SLIDER | 3000 |
autoScroll: boolean | Scroll Into View First | BOOLTOGGLE | false |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
performAction: () => void | Perform Action | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputData: AirEvent<string> | Output Data | DATA_STRING | AIR_PROPERTY |
onSuccess: AirEvent<void> | On Success | OPERATOR | OPERATOR |
onFailure: AirEvent<string> | On Failure | DATA_STRING | AIR_PROPERTY |
Mouse Data Operator for Screen Pointer Coordinates#
1. Functional Overview
The Mouse Data operator provides ongoing viewport cursor coordinates. It tracks cursor movements across the experience screen, outputting normalized X and Y values (from -1 to +1) through Output X and Output Y, letting visual logic align elements directly with pointer positions.
Mouse Data
MOUSE_DATA_PROVIDERDATA_NUMBERMouse Data Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
outputRange: [number, number] | Min / Max | RANGERANGE SLIDER | [-0.5, 0.5] |
axis: "X" | "Y" | Active Axis | ENUMOPTION SELECTOR | "X" |
invert: boolean | Invert | BOOLTOGGLE | false |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
toggleOnoff: () => void | Toggle On/Off | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
outputValue: AirEvent<float> | Output Value | DATA_FLOAT | AIR_PROPERTY |
Scroll Manager Operator for Scrollytelling#
1. Functional Overview
The Scroll Manager operator tracks the user's current reading/viewing position on the container web page. It converts browser window scroll height coordinates into raw floats or percentage ranges, broadcasting progress values to drive scroll-based 3D animations or parallax effect systems.
Scroll Manager
SCROLLGENERAL_ALLScroll Manager Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
containerUnitIds: any | Scroll Container | STRING_ARRAYUNIT SELECTOR | [] |
destinationMode: "ELEMENT" | "COORDINATES" | "TOP" | "BOTTOM" | Mode | ENUMDROPDOWN | "ELEMENT" |
targetUnitIds: any | Target Unit | STRING_ARRAYUNIT SELECTOR | [] |
targetX: float | X Position (px) | FLOATTEXT INPUT | 0 |
targetY: float | Y Position (px) | FLOATTEXT INPUT | 0 |
offsetY: float | Offset Y (px) | FLOATTEXT INPUT | 0 |
offsetX: float | Offset X (px) | FLOATTEXT INPUT | 0 |
enableObservation: boolean | Enable Triggers | BOOLTOGGLE | false |
observerThreshold: float | Threshold | FLOATRANGE SLIDER | 0.1 |
observerRootMargin: string | Root Margin | STRINGTEXT INPUT | "0px" |
smooth: boolean | Smooth Scroll | BOOLTOGGLE | true |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
scroll: () => void | Scroll | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
onEnterViewport: AirEvent<void> | On Enter Viewport | OPERATOR | OPERATOR |
onLeaveViewport: AirEvent<void> | On Leave Viewport | OPERATOR | OPERATOR |