Class quat

A quaternion, used to represent rotation.

Example

// Rotate a SceneObject around the world Y axis
//@input SceneObject obj

// Degrees to rotate by
var degrees = 90 * getDeltaTime();

// Convert degrees to radians
var radians = degrees * (Math.PI / 180);

// Axis to rotate around
var axis = vec3.up();

// Rotation we will apply to the object's current rotation
var rotationToApply = quat.angleAxis(radians, axis);

// Get the object's current world rotation
var oldRotation = script.obj.getTransform().getWorldRotation();

// Get the new rotation by rotating the old rotation by rotationToApply
var newRotation = rotationToApply.multiply(oldRotation);

// Set the object's world rotation to the new rotation
script.obj.getTransform().setWorldRotation(newRotation);

Constructors

constructor

Properties

w x y z

Methods

dot equal getAngle getAxis invert multiply multiplyVec3 normalize toEulerAngles toString

Constructors

constructor

  • new quat(w, x, y, z): quat

  • Creates a new quat.

    Parameters

    • w: number
    • x: number
    • y: number
    • z: number

    Returns quat

Properties

w

w: number

w component of the quat.

x

x: number

x component of the quat.

y

y: number

y component of the quat.

z

z: number

z component of the quat.

Methods

dot

  • dot(quat): number

  • Returns the dot product of the two quats.

    Parameters

    Returns number

equal

  • equal(b): boolean

  • Returns whether this quat and b are equal.

    Parameters

    Returns boolean

getAngle

  • getAngle(): number

  • Returns the rotation angle of the quat.

    Returns number

getAxis

  • getAxis(): vec3

  • Returns the rotation axis of the quat.

    Returns vec3

invert

  • invert(): quat

  • Returns an inverted version of the quat.

    Returns quat

multiply

  • multiply(b): quat

  • Returns the product of this quat and b.

    Parameters

    Returns quat

multiplyVec3

  • multiplyVec3(vec3): vec3

  • Returns the result of rotating direction vector vec3 by this quat.

    Parameters

    Returns vec3

normalize

  • normalize(): void

  • Normalizes the quat.

    Returns void

toEulerAngles

  • toEulerAngles(): vec3

  • Returns an euler angle representation of the quat, in radians.

    Returns vec3

toString

  • toString(): string

  • Returns a string representation of the quat.

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods