voxelcore/doc/en/scripting/builtins/libquat.md

quat library

Quaternions manipulation library.

Quaternions can be created as a table of 4 numbers: {w, x, y, z}

Quaternion from matrix - quat.from_mat4(...)

-- creates a quaternion based on the rotation matrix
quat.from_mat4(m: matrix)

-- writes a quaternion from the rotation matrix to dst
quat.from_mat4(m: matrix, dst: quat)

Quaternion of Euler angles - quat.from_euler(...)

-- creates quaternion from euler angles passed as XYZ (pitch, yaw, roll)
-- angles in degrees
quat.from_euler(euler: vec3) -> quat

-- writes quaternion from euler angles passed as XYZ (pitch, yaw, roll) to dst
-- angles in degrees
quat.from_euler(euler: vec3, dst: quat)

Quaternion composition - quat.mul(...)

-- multiplies quaternions
quat.mul(a: quat, b: quat) -> quat

-- writes a quaternions multiplication result to dst
quat.mul(a: quat, b: quat, dst: quat)

3D vector rotation - quat.mul_vec3(...)

-- rotates vector by quaternion
quat.mul_vec3(a: quat, b: vec3) -> vec3

-- writes rotated vector by quaternion to dst
quat.mul_vec3(a: quat, b: vec3, dst: vec3)

Spherical linear interpolation - quat.slerp(...)

The interpolation always take the short path and the rotation is performed at constant speed.

-- creates a quaternion as an interpolation between a and b,
-- where t is interpolation factor
quat.slerp(a: quat, b: quat, t: number)

-- writes a quaternion as an interpolation between a and b to dst,
-- where t is interpolation factor
quat.slerp(a: quat, b: quat, t: number, dst: quat)

Casting to string - quat.tostring(...)

-- returns a string representing the contents of the quaternion
quat.tostring(q: quat)