Header menu logo Nu

Quaternion Module

Functions and values

Function or value Description

quat x y z w

Full Usage: quat x y z w

Parameters:
    x : float32
    y : float32
    z : float32
    w : float32

Returns: Quaternion
Modifiers: inline
x : float32
y : float32
z : float32
w : float32
Returns: Quaternion

quatEq q q2

Full Usage: quatEq q q2

Parameters:
Returns: bool
Modifiers: inline
q : Quaternion
q2 : Quaternion
Returns: bool

quatEqApprox v v2 epsilon

Full Usage: quatEqApprox v v2 epsilon

Parameters:
Returns: bool
v : Quaternion
v2 : Quaternion
epsilon : float32
Returns: bool

quatIdentity

Full Usage: quatIdentity

Returns: Quaternion
Returns: Quaternion

quatNeq q q2

Full Usage: quatNeq q q2

Parameters:
Returns: bool
Modifiers: inline
q : Quaternion
q2 : Quaternion
Returns: bool

quatNeqApprox v v2 epsilon

Full Usage: quatNeqApprox v v2 epsilon

Parameters:
Returns: bool
Modifiers: inline
v : Quaternion
v2 : Quaternion
epsilon : float32
Returns: bool

Type extensions

Type extension Description

this.AxisAngle

Full Usage: this.AxisAngle

Parameters:
    () : unit

Returns: Vector3 * float32

Derive an axis angle from the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3 * float32

this.AxisAngle

Full Usage: this.AxisAngle

Returns: Vector3 * float32

Derive an axis angle from the quaternion.

Extended Type: Quaternion

Returns: Vector3 * float32

this.Back

Full Usage: this.Back

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

The back vector of the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.Back

Full Usage: this.Back

Returns: Vector3
Modifiers: inline

The back vector of the quaternion.

Extended Type: Quaternion

Returns: Vector3

Quaternion.CreateLookAt(source, destination, up)

Full Usage: Quaternion.CreateLookAt(source, destination, up)

Parameters:
Returns: Quaternion

Create a look-at rotation.

Extended Type: Quaternion

source : Vector3
destination : Vector3
up : Vector3
Returns: Quaternion

this.Down

Full Usage: this.Down

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

The down vector of the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.Down

Full Usage: this.Down

Returns: Vector3
Modifiers: inline

The down vector of the quaternion.

Extended Type: Quaternion

Returns: Vector3

this.Forward

Full Usage: this.Forward

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

The forward vector of the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.Forward

Full Usage: this.Forward

Returns: Vector3
Modifiers: inline

The forward vector of the quaternion.

Extended Type: Quaternion

Returns: Vector3

this.Inverted

Full Usage: this.Inverted

Parameters:
    () : unit

Returns: Quaternion
Modifiers: inline

The inverted value of a quaternion.

Extended Type: Quaternion

() : unit
Returns: Quaternion

this.Inverted

Full Usage: this.Inverted

Returns: Quaternion
Modifiers: inline

The inverted value of a quaternion.

Extended Type: Quaternion

Returns: Quaternion

this.Left

Full Usage: this.Left

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

The left vector of the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.Left

Full Usage: this.Left

Returns: Vector3
Modifiers: inline

The left vector of the quaternion.

Extended Type: Quaternion

Returns: Vector3

this.Normalized

Full Usage: this.Normalized

Parameters:
    () : unit

Returns: Quaternion

Normalize the quaternion.

Extended Type: Quaternion

() : unit
Returns: Quaternion

this.Normalized

Full Usage: this.Normalized

Returns: Quaternion

Normalize the quaternion.

Extended Type: Quaternion

Returns: Quaternion

this.Right

Full Usage: this.Right

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

The right vector of the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.Right

Full Usage: this.Right

Returns: Vector3
Modifiers: inline

The right vector of the quaternion.

Extended Type: Quaternion

Returns: Vector3

this.RightUpForward

Full Usage: this.RightUpForward

Parameters:
    () : unit

Returns: Vector3 * Vector3 * Vector3
Modifiers: inline

Right, up, and forward quaternion vectors.

Extended Type: Quaternion

() : unit
Returns: Vector3 * Vector3 * Vector3

this.RightUpForward

Full Usage: this.RightUpForward

Returns: Vector3 * Vector3 * Vector3
Modifiers: inline

Right, up, and forward quaternion vectors.

Extended Type: Quaternion

Returns: Vector3 * Vector3 * Vector3

this.RollPitchYaw

Full Usage: this.RollPitchYaw

Parameters:
    () : unit

Returns: Vector3

Decompose the quaternion into roll, pitch, and yaw angles.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.RollPitchYaw

Full Usage: this.RollPitchYaw

Returns: Vector3

Decompose the quaternion into roll, pitch, and yaw angles.

Extended Type: Quaternion

Returns: Vector3

this.Up

Full Usage: this.Up

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

The up vector of the quaternion.

Extended Type: Quaternion

() : unit
Returns: Vector3

this.Up

Full Usage: this.Up

Returns: Vector3
Modifiers: inline

The up vector of the quaternion.

Extended Type: Quaternion

Returns: Vector3

Type something to start searching.