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

angleAxis angleBetween dot equal fromEulerAngles fromEulerVec fromRotationMat fromRotationMat4 getAngle getAxis invert lerp lookAt multiply multiplyVec3 normalize quatIdentity rotationFromTo slerp toEulerAngles toString

Constructors

constructor

  • new quat(w: number, x: number, y: number, z: number): 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

StaticangleAxis

  • angleAxis(angle: number, axis: vec3): quat

    Returns a new quat with angle angle and axis axis.

    Parameters

    • angle: number
    • axis: vec3

    Returns quat

StaticangleBetween

  • angleBetween(a: quat, b: quat): number

    Returns the angle between a and b.

    Parameters

    Returns number

dot

  • dot(quat: quat): number

    Returns the dot product of the two quats.

    Parameters

    Returns number

equal

  • equal(b: quat): boolean

    Returns whether this quat and b are equal.

    Parameters

    Returns boolean

StaticfromEulerAngles

  • fromEulerAngles(x: number, y: number, z: number): quat

    Returns a new quat using the euler angles x, y, z (in radians).

    Parameters

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

    Returns quat

StaticfromEulerVec

  • fromEulerVec(eulerVec: vec3): quat

    Returns a new quat using the euler angle eulerVec (in radians).

    Parameters

    Returns quat

StaticfromRotationMat

  • fromRotationMat(rotationMat: mat3): quat

    Creates a quaternion from a matrix.

    Parameters

    Returns quat

StaticfromRotationMat4

  • fromRotationMat4(rotationMat4: mat4): quat

    Creates a quaternion from a mat4.

    Parameters

    Returns quat

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

Staticlerp

  • lerp(a: quat, b: quat, t: number): quat

    Returns a new quat linearly interpolated between a and b.

    Parameters

    Returns quat

StaticlookAt

  • lookAt(forward: vec3, up: vec3): quat

    Returns a new quat with a forward vector forward and up vector up.

    Parameters

    Returns quat

multiply

  • multiply(b: quat): quat

    Returns the product of this quat and b.

    Parameters

    Returns quat

multiplyVec3

  • multiplyVec3(vec3: vec3): vec3

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

    Parameters

    Returns vec3

normalize

  • normalize(): void

    Normalizes the quat.

    Returns void

StaticquatIdentity

  • quatIdentity(): quat

    Returns the identity quaternion.

    Returns quat

StaticrotationFromTo

  • rotationFromTo(from: vec3, to: vec3): quat

    Returns a rotation quat between direction vectors from and to.

    Parameters

    Returns quat

Staticslerp

  • slerp(a: quat, b: quat, t: number): quat

    Returns a new quat spherically linearly interpolated between a and b.

    Parameters

    Returns quat

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
MMNEPVFCICPMFPCPTTAAATR