Get Started

Create AR effects for Instagram and Meta.
Get Started

Scripting API

SceneModule

Transform

Transform

Contents

Contents

The Transform class describes an object transform for a scene.

Properties

Property	Description
`forward`	(get) forward: VectorSignal (set) (Not Available)
`position`	(get) position: PointSignal (set) position: PointSignal Specifies the object position along the X, Y and Z axis of the object's local coordinate system.
`right`	(get) right: VectorSignal (set) (Not Available)
`rotation`	(get) rotation: QuaternionSignal (set) rotation: QuaternionSignal Specifies the object rotation along the X, Y and Z axis of the object's local coordinate system.
`rotationX`	(get) rotationX: ScalarSignal (set) rotationX: ScalarSignal Specifies the object rotation about the X-axis of the object's local coordinate system, in radians. Note: the rotations are applied to the object in Z-Y-X order. The X rotation is applied first to the object, therefore it is always performed in the object's local coordinate system.
`rotationY`	(get) rotationY: ScalarSignal (set) rotationY: ScalarSignal Specifies the object rotation about the Y-axis of the object's local coordinate system, in radians. Note: the rotations are applied to the object in Z-Y-X order. The Y rotation is applied second to the object, therefore if the `rotationX` is not zero, then `rotationY` is applied not in the object's local coordinate system but in the rotated one.
`rotationZ`	(get) rotationZ: ScalarSignal (set) rotationZ: ScalarSignal Specifies the object rotation about the Z-axis of the object's local coordinate system, in radians. Note: the rotations are applied to the object in Z-Y-X order. The Z rotation is applied last to the object, therefore if the `rotationX` or `rotationY` is not zero, then `rotationZ` is applied not in the object's local coordinate system but in the rotated one.
`scale`	(get) scale: PointSignal (set) scale: PointSignal \| VectorSignal Specifies the object scale along the X, Y and Z axis.
`scaleX`	(get) scaleX: ScalarSignal (set) scaleX: ScalarSignal Specifies the object scale along the X-axis of the object's local coordinate system.
`scaleY`	(get) scaleY: ScalarSignal (set) scaleY: ScalarSignal Specifies the object scale along the Y-axis of the object's local coordinate system.
`scaleZ`	(get) scaleZ: ScalarSignal (set) scaleZ: ScalarSignal Specifies the object scale along the Z-axis of the object's local coordinate system.
`up`	(get) up: VectorSignal (set) (Not Available)
`x`	(get) x: ScalarSignal (set) x: ScalarSignal Specifies the object offset along the X-axis of the object's local coordinate system.
`y`	(get) y: ScalarSignal (set) y: ScalarSignal Specifies the object offset along the Y-axis of the object's local coordinate system.
`z`	(get) z: ScalarSignal (set) z: ScalarSignal Specifies the object offset along the Z-axis of the object's local coordinate system.

Methods

Method	Description
`lookAt`	lookAt(targetPosition: PointSignal, selfUp?: VectorSignal): TransformSignal Creates a scene object transform with rotation in direction of target. Default `selfUp` is `ReactiveModule.vector(0, 1, 0)`. Note: The self needs to be pointing the scene object alongside the X axis.
`toSignal`	toSignal(): TransformSignal Returns a signal for a given transformation.