Spatial & Motion

Published Updated
Handle 3D coordinate vectors, orbital rotation cycles, follow tracking behavior, and bounding box math.

Spatial & Motion operators drive the movement, rotation, alignment, and hierarchical visibility of 3D objects in the scene space.

Auto Rotate Operator for Continuous 3D Spin#

Operator<DocsSdkOperatorsSpatialAutoRotate>: Spins a 3D object continuously around designated coordinate axes at a set speed.

1. Functional Overview

The Auto Rotate operator manages constant rotational loops. It applies continuous, frame-rate-independent angular changes to a target object. Users configure rotation speed on X, Y, or Z axes independently to drive spinning showcases or orbiting assets.

Auto Rotate

DATA_ROTATIONAL.AUTO_ROTATE
Operator
Operator Type
AUTO_ROTATE
Operator Group
DATA_ROTATIONAL

Auto Rotate Properties Details

Property & TypeDisplay NameSystem TypeDefault
speedX: float
Speed (X)
FLOAT
RANGE SLIDER
0
speedY: float
Speed (Y)
FLOAT
RANGE SLIDER
0.2
speedZ: float
Speed (Z)
FLOAT
RANGE SLIDER
0
rotationDirectionControl: "Reverse X" | "Reverse Y" | "Reverse Z"
rotationDirectionControl
ENUM
DROPDOWN
[]
dynamicSpeed: boolean
Dynamic Speed
BOOL
TOGGLE
false
amplitude: float
Amplitude
FLOAT
RANGE SLIDER
0.15
frequency: float
Frequency
FLOAT
RANGE SLIDER
0.1
limitRotation: boolean
Limit Rotation
BOOL
TOGGLE
false
rotationRangeX: [number, number]
Range (X)
RANGE
RANGE SLIDER
[0, 360]
rotationRangeY: [number, number]
Range (Y)
RANGE
RANGE SLIDER
[0, 360]
rotationRangeZ: [number, number]
Range (Z)
RANGE
RANGE SLIDER
[0, 360]
rotationBehavior: "Ping-Pong" | "Loop"
Rotation Behavior
ENUM
DROPDOWN
"Ping-Pong"
easingFunction: "LINEAR" | "EASE_IN" | "EASE_OUT" | "EASE_IN_OUT"
Easing Function
ENUM
DROPDOWN
"EASE_IN_OUT"

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Bounds Operator for 3D Dimensions & Overlaps#

Operator<DocsSdkOperatorsSpatialBoundingBox>: Calculates 3D dimensions and checks bounding box overlaps for collision detection.

1. Functional Overview

The Bounds operator computes coordinate bounds. It processes the active dimensions of target 3D meshes, outputting their precise X/Y/Z bounding sizes, and monitors collision coordinate gates to trigger outputs when objects intersect.

Bounds

DATA_NUMBER.BOUNDS
Operator
Operator Type
BOUNDS
Operator Group
DATA_NUMBER

Bounds Properties Details

Property & TypeDisplay NameSystem TypeDefault
unitIds: any
Units
STRING_ARRAY
UNIT SELECTOR
[]
padding: float
Padding
FLOAT
RANGE SLIDER
0

@Output

@Output & TypeDisplay Name@Output TypeGroup
bottom: AirEvent<void>
Bottom
OPERATOROPERATOR
top: AirEvent<void>
Top
OPERATOROPERATOR
left: AirEvent<void>
Left
OPERATOROPERATOR
right: AirEvent<void>
Right
OPERATOROPERATOR
front: AirEvent<void>
Front
OPERATOROPERATOR
back: AirEvent<void>
Back
OPERATOROPERATOR

Child Visibility Operator for Object Hierarchies#

Operator<DocsSdkOperatorsSpatialChildVisibility>: Show, hide, or cycle active display states of nested child meshes within a parent object hierarchy.

1. Functional Overview

The Child Visibility Manager toggles sub-components within composite assemblies. By targeting a parent node, the operator can search, show, or hide specific child nodes, or cycle through children sequentially, making it ideal for step-by-step assemblies.

Child Visibility Manager

GENERAL_ALL.CHILD_VISIBILITY
Operator
Operator Type
CHILD_VISIBILITY
Operator Group
GENERAL_ALL

Child Visibility Manager Properties Details

Property & TypeDisplay NameSystem TypeDefault
targetUnitIds: any
Target Parent Unit
STRING_ARRAY
UNIT SELECTOR
[]
startIndex: float
Start Index
FLOAT
TEXT INPUT
0
loop: boolean
Loop Navigation
BOOL
TOGGLE
false

@Input

@Input & TypeDisplay Name@Input TypeGroup
next: (payload: float) => void
Next
DATA_FLOATAIR_PROPERTY
previous: (payload: float) => void
Previous
DATA_FLOATAIR_PROPERTY
setIndex: (payload: float) => void
Set Index
DATA_FLOATAIR_PROPERTY

@Output

@Output & TypeDisplay Name@Output TypeGroup
onFirst: AirEvent<void>
On First
OPERATOROPERATOR
onLast: AirEvent<void>
On Last
OPERATOROPERATOR
onNotFirst: AirEvent<void>
On Not First
OPERATOROPERATOR
onNotLast: AirEvent<void>
On Not Last
OPERATOROPERATOR
currentIndex: AirEvent<float>
Current Index
DATA_FLOATAIR_PROPERTY

Follow Operator for Pointer & Entity Tracking#

Operator<DocsSdkOperatorsSpatialFollow>: Commands a target 3D object to dynamically track the real-time position of the user's mouse/pointer or another scene entity.

1. Functional Overview

The Follow operator animates movement tracking paths in 3D scene space. It configures a source object to follow either the pointer viewport coordinates or another specific scene entity's mesh transform. Motion dynamics are customized via the speed property, smoothing friction ranges, and configurable mathematical easing curves (easingFunction).

Follow

DATA_VECTOR3.FOLLOW
Operator
Operator Type
FOLLOW
Operator Group
DATA_VECTOR3

Follow Properties Details

Property & TypeDisplay NameSystem TypeDefault
followTargetType: "Mouse" | "Object"
Follow Target
ENUM
OPTION SELECTOR
"Mouse"
targetUnitId: any
Target Object
STRING_ARRAY
UNIT SELECTOR
[]
followRotation: boolean
Follow Rotation
BOOL
TOGGLE
false
speed: float
Movement Speed
FLOAT
RANGE SLIDER
1
delay: float
Delay (seconds)
FLOAT
RANGE SLIDER
0
easingFunction: "LINEAR" | "EASE_IN" | "EASE_OUT" | "EASE_IN_OUT"
Easing Function
ENUM
DROPDOWN
"LINEAR"
smoothing: float
Smoothing
FLOAT
RANGE SLIDER
0.25

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Look At Operator for Camera & Object Targeting#

Operator<DocsSdkOperatorsSpatialLookAt>: Automatically rotates a target 3D object to constantly face another focal entity or active viewport camera.

1. Functional Overview

The Look At operator applies aim constraints on 3D objects. It computes real-time rotational coordinates required to align a mesh's forward axis toward a designated target or the viewer's camera, with options to limit rotation to specific coordinate planes (e.g. Y-axis only).

Look At

DATA_ROTATIONAL.LOOK_AT
Operator
Operator Type
LOOK_AT
Operator Group
DATA_ROTATIONAL

Look At Properties Details

Property & TypeDisplay NameSystem TypeDefault
lookAtTargetType: "MOUSE" | "OBJECT"
Look at target
ENUM
OPTION SELECTOR
"MOUSE"
lookAtTargetUnitId: any
Target Object
STRING_ARRAY
UNIT SELECTOR
[]
smoothing: float
Smoothness
FLOAT
RANGE SLIDER
0.5

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Orbit Operator for Circular Path Rotations#

Operator<DocsSdkOperatorsSpatialOrbit>: Causes a target 3D object to rotate in a circular orbital path around a focal center object.

1. Functional Overview

The Orbit operator drives turntable and orbital movement loops. By referencing a central anchor scene object, the operator rotates the target body in a circular trajectory. Radial offset distances, height offsets, and rotational speed bounds are fully customized through inspector attributes.

Orbit

DATA_VECTOR3.ORBIT
Operator
Operator Type
ORBIT
Operator Group
DATA_VECTOR3

Orbit Properties Details

Property & TypeDisplay NameSystem TypeDefault
tilt: float
Tilt
FLOAT
RANGE SLIDER
0
orbitSpeed: float
Speed
FLOAT
RANGE SLIDER
0.15
orbitRadius: float
Radius
FLOAT
RANGE SLIDER
0.2
limitOrbit: boolean
Limit Orbit
BOOL
TOGGLE
false
orbitRange: [number, number]
Orbit Range
RANGE
RANGE SLIDER
[0, 360]
orbitBehavior: "Ping-Pong" | "Loop"
Orbit Behavior
ENUM
DROPDOWN
"Ping-Pong"
easingFunction: "LINEAR" | "EASE_IN" | "EASE_OUT" | "EASE_IN_OUT"
Easing Function
ENUM
DROPDOWN
"EASE_IN_OUT"

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Pointer Rotate Operator for Drag Gestures#

Operator<DocsSdkOperatorsSpatialPointerRotate>: Allows users to directly rotate 3D models using drag mouse gestures.

1. Functional Overview

The Pointer Rotate operator enables mouse interaction. When a user clicks and drags a mesh inside the viewport, the operator translates mouse coordinates into 3D rotational offsets. Friction settings (damping) can be adjusted to enable smooth spin inertia.

Pointer Rotate

DATA_ROTATIONAL.POINTER_ROTATE
Operator
Operator Type
POINTER_ROTATE
Operator Group
DATA_ROTATIONAL

Pointer Rotate Properties Details

Property & TypeDisplay NameSystem TypeDefault
mix: float
Output Mix
FLOAT
RANGE SLIDER
1
smoothness: float
Smoothness
FLOAT
RANGE SLIDER
0.25
deceleration: float
Deceleration
FLOAT
RANGE SLIDER
0.25
verticalSpeed: float
Vertical Speed
FLOAT
RANGE SLIDER
0.5
horizontalSpeed: float
Horizontal Speed
FLOAT
RANGE SLIDER
0.5
axisLock: "Lock X" | "Lock Y"
Axis Lock
ENUM
DROPDOWN
[]
invertAxes: "Invert X" | "Invert Y"
Invert Axes
ENUM
DROPDOWN
[]
pointerInteractionMode: "PointerDown" | "PointerMove"
Pointer Interaction Mode
ENUM
DROPDOWN
"PointerDown"
resetTransitionTime: float
Reset Transition Time (sec)
FLOAT
RANGE SLIDER
1
resetOnInactivity: boolean
Reset Rotation On Inactivity
BOOL
TOGGLE
false
inactivityTimeout: float
Inactivity Timeout (sec)
FLOAT
RANGE SLIDER
5

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR
reset: () => void
Reset
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Proximity Operator for Distance Thresholds#

Operator<DocsSdkOperatorsSpatialProximity>: Calculates the real-time distance between the active camera and a target 3D coordinate point, triggering proximity thresholds.

1. Functional Overview

The Proximity operator monitors user proximity. It computes distances between the user's viewport camera and a 3D target. When this distance falls below a defined threshold (triggerDistance), it fires the Near trigger, and fires the Far trigger when the user moves away.

Proximity

GENERAL_TRIGGERS.PROXIMITY
Operator
Operator Type
PROXIMITY
Operator Group
GENERAL_TRIGGERS

Proximity Properties Details

Property & TypeDisplay NameSystem TypeDefault
useViewerPosition: boolean
Use Viewer Position
BOOL
TOGGLE
true
distanceFromTargetUnitIds: any
Distance From
STRING_ARRAY
UNIT SELECTOR
[]
distanceToTargetUnitIds: any
Distance To
STRING_ARRAY
UNIT SELECTOR
[]
distance: float
Distance
FLOAT
TEXT INPUT
0

@Output

@Output & TypeDisplay Name@Output TypeGroup
onEnter: AirEvent<void>
On Enter
OPERATOROPERATOR
onExit: AirEvent<void>
On Exit
OPERATOROPERATOR

Vector 3 Rotation Operator for Euler Angles#

Operator<DocsSdkOperatorsSpatialRotationVector3>: Conversions between individual Euler angles and structured 3D rotational coordinate vectors.

1. Functional Overview

The Vector 3 Rotation operator formats rotational inputs. It handles standard conversions between separate Pitch/Yaw/Roll floating degree parameters and structured rotational vectors, ensuring alignment commands are resolved correctly by 3D rendering engines.

Vector 3

DATA_ROTATIONAL.ROTATION_VECTOR3
Operator
Operator Type
ROTATION_VECTOR3
Operator Group
DATA_ROTATIONAL

Vector 3 Properties Details

Property & TypeDisplay NameSystem TypeDefault
inputQuat: IQuaternion
Input Rotation
ROTATIONAL_SYSTEM
VECTOR MULTI INPUT
{x: 0, y: 0, z: 0, w: 1}
x: float
x
FLOAT
TEXT INPUT
0
y: float
y
FLOAT
TEXT INPUT
0
z: float
z
FLOAT
TEXT INPUT
0

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Vector3 Operator for Coordinate Compositions#

Operator<DocsSdkOperatorsSpatialVector3>: Combines separate floating-point X, Y, and Z values into a structured 3D coordinate vector payload, or breaks down an incoming vector into its individual components.

1. Functional Overview

The Vector3 operator bridges individual float properties with multi-dimensional 3D vector variables. It exposes separate inline input controls for x, y, and z configuration fields, combining them into a unified position/scale coordinate that is dispatched from its Output Value @Output, or conversely decomposes incoming vector streams into float channels.

Vector3

DATA_VECTOR3.VECTOR3
Operator
Operator Type
VECTOR3
Operator Group
DATA_VECTOR3

Vector3 Properties Details

Property & TypeDisplay NameSystem TypeDefault
inputVector: IVector3
Input Vector3
VECTOR3
VECTOR MULTI INPUT
{x: 0, y: 0, z: 0}
x: float
x
FLOAT
TEXT INPUT
0
y: float
y
FLOAT
TEXT INPUT
0
z: float
z
FLOAT
TEXT INPUT
0

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<any>
Output Value
DATA_VECTOR3AIR_PROPERTY