sceneview/io.github.sceneview.collision/Quaternion

Quaternion

open class Quaternion

A Sceneform quaternion class for floats.

Quaternion operations are Hamiltonian using the right-hand-rule convention.

Constructors

constructor()

Construct Quaternion and set to Identity

constructor(x: Float, y: Float, z: Float, w: Float)

Construct Quaternion and set each value.

constructor(q: Quaternion)

Construct Quaternion using values from another Quaternion

constructor(axis: Vector3, angle: Float)

Construct Quaternion using an axis/angle to define the rotation

constructor(eulerAngles: Vector3)

Construct Quaternion based on eulerAngles.

Properties

open var w: Float

open var x: Float

open var y: Float

open var z: Float

Functions

open fun add(lhs: Quaternion, rhs: Quaternion): Quaternion

Adds two Quaternion's without normalizing

open fun axisAngle(axis: Vector3, degrees: Float): Quaternion

Get a new Quaternion using an axis/angle to define the rotation

open fun equals(other: Any): Boolean

Returns true if the other object is a Quaternion and the dot product is 1.0 +/- a tolerance.

open fun equals(lhs: Quaternion, rhs: Quaternion): Boolean

Compare two Quaternions Tests for equality by calculating the dot product of lhs and rhs.

open fun eulerAngles(eulerAngles: Vector3): Quaternion

Get a new Quaternion using eulerAngles to define the rotation.

open fun getEulerAngles(): Vector3

open fun hashCode(): Int

open fun identity(): Quaternion

Get a Quaternion set to identity

inverseRotateVector

open fun inverseRotateVector(q: Quaternion, src: Vector3): Vector3

open fun inverted(): Quaternion

Get a Quaternion with the opposite rotation

open fun lookRotation(forwardInWorld: Vector3, desiredUpInWorld: Vector3): Quaternion

Get a new Quaternion representing a rotation towards a specified forward direction.

open fun multiply(lhs: Quaternion, rhs: Quaternion): Quaternion

Create a Quaternion by combining two Quaternions multiply(lhs, rhs) is equivalent to performing the rhs rotation then lhs rotation Ordering is important for this operation.

open fun negated(): Quaternion

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

open fun normalize(): Boolean

Rescales the quaternion to the unit length.

open fun normalized(): Quaternion

Get a Quaternion with a matching rotation but scaled to unit length.

open fun rotateVector(q: Quaternion, src: Vector3): Vector3

Rotates a Vector3 by a Quaternion

rotationBetweenVectors

open fun rotationBetweenVectors(start: Vector3, end: Vector3): Quaternion

Get a new Quaternion representing the rotation from one vector to another.

open fun set(q: Quaternion)

Copy values from another Quaternion into this one

open fun set(axis: Vector3, angle: Float)

Update this Quaternion using an axis/angle to define the rotation

open fun set(qx: Float, qy: Float, qz: Float, qw: Float)

Set each value and normalize the Quaternion

open fun setIdentity()

Set the Quaternion to identity

open fun slerp(start: Quaternion, end: Quaternion, t: Float): Quaternion

toNewQuaternion

fun Quaternion.toNewQuaternion(): Quaternion

open fun toString(): String