Class: Quaternion

Functions

Name	Description
.new()
.new(w,x,y,z)
.newAngleAxis(angle,axis)
.newIdentity()
.newRandom()

Methods

Name	Description
:__add(other)
:__div(other)
:__eq(other)
:__le(other)
:__lt(other)
:__mul(other)
:__sub(other)
:__unm()
:angle()
:axis()
:conjugate()
:dot(other)
:eulerAngles()	Returns euler angles, pitch as x, yaw as y, roll as z.
:inverse()
:isinf()	Returns true if x holds a positive infinity or negative infinity
:isnan()	Returns true if x holds a NaN (not a number)
:length()
:lerp(other,a)
:mat3Cast()
:mat4Cast()
:normalized()
:pitch()
:roll()
:rotate(angle,axis)	Returns a new rotated quaternion
:slerp(other,a)
:yaw()

Fields

Name	Type	Description
w	number
x	number
y	number
z	number

Function declarations

Function: new

function Quaternion.new() end

Returns:

• Quaternion

Function: new

function Quaternion.new(
    w,
    x,
    y,
    z
) end

Parameters:

• w (number)
• x (number)
• y (number)
• z (number)

Returns:

• Quaternion

Function: newAngleAxis

function Quaternion.newAngleAxis(
    angle,
    axis
) end

Parameters:

• angle (number) - Angle in radians
• axis (Vector3f)

Returns:

• Quaternion

Function: newIdentity

function Quaternion.newIdentity() end

Returns:

• Quaternion

Function: newRandom

function Quaternion.newRandom() end

Returns:

• Quaternion

Method declarations

Method: __add

function Quaternion:__add(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• Quaternion

Method: __div

function Quaternion:__div(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• number|Quaternion

Method: __eq

function Quaternion:__eq(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• Quaternion

Method: __le

function Quaternion:__le(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• boolean

Method: __lt

function Quaternion:__lt(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• boolean

Method: __mul

function Quaternion:__mul(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• number|Quaternion

Method: __sub

function Quaternion:__sub(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• Quaternion

Method: __unm

function Quaternion:__unm() end

Returns:

• Quaternion

Method: angle

function Quaternion:angle() end

Returns:

• number

Method: axis

function Quaternion:axis() end

Returns:

• Vector3f

Method: conjugate

function Quaternion:conjugate() end

Returns:

• Quaternion

Method: dot

function Quaternion:dot(
    other
) end

Parameters:

• other (Quaternion)

Returns:

• number

Method: eulerAngles

Returns euler angles, pitch as x, yaw as y, roll as z. The result is expressed in radians.

function Quaternion:eulerAngles() end

Returns:

• Vector3f

Method: inverse

function Quaternion:inverse() end

Returns:

• Quaternion

Method: isinf

Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. Returns false otherwise, including for implementations with no infinity

function Quaternion:isinf() end

Returns:

• Vector4b

Method: isnan

Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. Returns false otherwise, including for implementations with no NaN representations.

function Quaternion:isnan() end

Returns:

• Vector4b

Method: length

function Quaternion:length() end

Returns:

• number

Method: lerp

function Quaternion:lerp(
    other,
    a
) end

Parameters:

• other (Quaternion)
• a (number) - Interpolation factor

Returns:

• Quaternion

Method: mat3Cast

function Quaternion:mat3Cast() end

Returns:

• Matrix3x3f

Method: mat4Cast

function Quaternion:mat4Cast() end

Returns:

• Matrix4x4f

Method: normalized

function Quaternion:normalized() end

Returns:

• Quaternion

Method: pitch

function Quaternion:pitch() end

Returns:

• number

Method: roll

function Quaternion:roll() end

Returns:

• number

Method: rotate

Returns a new rotated quaternion

function Quaternion:rotate(
    angle,
    axis
) end

Parameters:

• angle (number) - Angle in radians
• axis (Vector3f) - Axis of rotation

Returns:

• Quaternion

Method: slerp

function Quaternion:slerp(
    other,
    a
) end

Parameters:

• other (Quaternion)
• a (number) - Interpolation factor

Returns:

• Quaternion

Method: yaw

function Quaternion:yaw() end

Returns:

• number

Field declarations

Field: w

Type: number

Field: x

Type: number

Field: y

Type: number

Field: z

Type: number