Quaternion

fun angle(start: Quaternion, end: Quaternion): Float

Returns the angle between start and end quaternion in degrees.

fun dot(lhs: Quaternion, rhs: Quaternion): Float

Returns the dot product of two quaternions.

fun fromAxisAngle(axis: Vector3, degrees: Float): Quaternion

Creates a new quaternion using an axis/angle to define the rotation.

fun fromEulerAngles(eulerAngles: Vector3): Quaternion

Returns a new quaternion using Euler angles (in degrees) to define the rotation in YXZ (yaw, pitch, roll) order.

fun fromEulerAngles(pitch: Float, yaw: Float, roll: Float): Quaternion

Returns a new quaternion using Euler angles (in degrees) to define the rotation in YXZ (yaw, pitch, roll) order.

fun fromLookTowards(forward: Vector3, up: Vector3): Quaternion

Returns a new quaternion with the specified forward and upward directions.

fun fromRotation(start: Quaternion, end: Quaternion): Quaternion

Returns a new quaternion representing the rotation from one quaternion to another.

fun fromRotation(start: Vector3, end: Vector3): Quaternion

Returns a new quaternion representing the rotation from one vector to another.

fun lerp(start: Quaternion, end: Quaternion, ratio: Float): Quaternion

Returns a new quaternion that is linearly interpolated between start and end using the interpolation amount ratio.

If ratio is outside of the range [0, 1], the returned quaternion will be extrapolated.

fun slerp(start: Quaternion, end: Quaternion, ratio: Float): Quaternion

Returns a new quaternion that is spherically interpolated between start and end using the interpolation amount ratio. If ratio is 0, this returns start. As ratio approaches 1, the result of this function may approach either +end or -end (whichever is closest to start).

If ratio is outside of the range [0, 1], the returned quaternion will be extrapolated.

Quaternion(other: Quaternion)

Creates a new quaternion with the same values as the other quaternion.

fun copy(x: Float = this.x, y: Float = this.y, z: Float = this.z, w: Float = this.w): Quaternion

Returns a copy of the quaternion.

operator fun div(c: Float): Quaternion

Returns a new quaternion with this quaternion divided by a scalar amount.

inline infix fun dot(other: Quaternion): Float

Returns the dot product of this quaternion and the other quaternion.

open operator fun equals(other: Any?): Boolean

Returns true if this quaternion is equal to the other.

inline operator fun minus(other: Quaternion): Quaternion

Returns a new quaternion with the difference of this quaternion and the other quaternion.

inline operator fun plus(other: Quaternion): Quaternion

Returns a new quaternion with the sum of this quaternion and other quaternion.

operator fun times(c: Float): Quaternion

Returns a new quaternion with the product of this quaternion and a scalar amount.

inline operator fun times(other: Quaternion): Quaternion

Returns a new quaternion with the product of this quaternion and the other quaternion. The order of the multiplication is [this] * [other].

inline operator fun times(src: Vector3): Vector3

Rotates a Vector3 by this quaternion.

fun toNormalized(): Quaternion

Returns a new quaternion with a normalized rotation.

inline operator fun unaryMinus(): Quaternion

Flips the sign of the quaternion, but represents the same rotation.

val axisAngle: Pair<Vector3, Float>

Returns this quaternion as an axis/angle (in degrees) pair.

val eulerAngles: Vector3

Returns this quaternion as Euler angles (in degrees) applied in YXZ (yaw, pitch, roll) order.

val inverse: Quaternion

Returns a new quaternion with the inverse rotation. Assumes unit length.

val w: Float

The normalized w component of the quaternion.

val x: Float

The normalized x component of the quaternion.

val y: Float

The normalized y component of the quaternion.

val z: Float

The normalized z component of the quaternion.