Get Started

Spark AR Studio
Spark AR Hub
Features
Learn
Creators
Partners
Blog
Community

Create AR effects for Instagram and Facebook.
Get Started

ReactiveModule Overview

ReactiveModule Overview

QuaternionSignal

QuaternionSignal

Contents

Contents

The QuaternionSignal class monitors rotation in a quaternion representation.

Properties

Property	Description
`eulerAngles`	(get) eulerAngles: PointSignal (set) (Not Available) Represents the Euler angle from the `QuaternionSignal`, representing pitch, yaw, roll respectively. Note: the order of rotations for the Euler angles is the same as in `Transform` class.
`w`	(get) w: ScalarSignal (set) (Not Available) Represents the W component of the quaternion.
`x`	(get) x: ScalarSignal (set) (Not Available) Represents the X component of the quaternion.
`y`	(get) y: ScalarSignal (set) (Not Available) Represents the Y component of the quaternion.
`z`	(get) z: ScalarSignal (set) (Not Available) Represents the Z component of the quaternion.

Methods

Method	Description
`angleAxis`	angleAxis(): Vec4Signal Returns the angle/axis representation of this quaternion. First element in the vector is angle in radians, with last 3 being X, Y, Z axis respectively.
`angleTo`	angleTo(signal: QuaternionSignal): ScalarSignal Returns a signal with the value that is the angular distance between this quaternion and the provided quaternion, in radians.
`conjugate`	conjugate(): QuaternionSignal Returns the rotational conjugate of this quaternion. The conjugate of a quaternion represents the same rotation in the opposite direction about the rotational axis.
`dot`	dot(signal: QuaternionSignal): ScalarSignal Returns a scalar signal with the value that is the dot product of the given signals.
`history`	history(framesCount: number, initialValues?: Array<Rotation>): SignalHistory<Rotation> Returns an object used to access signal values from past frames. The amount of frames tracked is customizable via `framesCount` parameter. Historical signal values are going to be initialized with signal value at call time or using `initialValues` if provided.
`invert`	invert(): QuaternionSignal Returns the rotational conjugate of this quaternion. The conjugate of a quaternion represents the same rotation in the opposite direction about the rotational axis.
`mix`	mix(signal: QuaternionSignal, factor: ScalarSignal \| number): QuaternionSignal Returns a signal with the value that is the linear interpolation between this and another signal by a given factor.
`mul`	mul(signal: QuaternionSignal): QuaternionSignal Returns a signal with the value that is the product of the values of the given signals.
`pinLastValue`	pinLastValue(): QuaternionSignal Returns a new `QuaternionSignal` containing a constant value which is the last value of the specified signal before `pinLastValue` is called.
`slerp`	slerp(signal: QuaternionSignal, factor: ScalarSignal \| number): QuaternionSignal Returns a signal with the value that is the spherical linear interpolation between this and another signal by a given factor.