Class AcGeQuaternion

Constructors

constructor

new AcGeQuaternion(
    x?: number,
    y?: number,
    z?: number,
    w?: number,
): AcGeQuaternion
Create one instance of this class
Parameters
- Optionalx: number
  Input x coordinate
- Optionaly: number
  Input y coordinate
- Optionalz: number
  Input z coordinate
- Optionalw: number
  Input w coordinate
Returns AcGeQuaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:16

Accessors

w

get w(): number
W cooridinate

Returns number
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:57
set w(value: number): void
Parameters
- value: number
Returns void
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:58

x

get x(): number
X cooridinate

Returns number
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:42
set x(value: number): void
Parameters
- value: number
Returns void
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:43

y

get y(): number
Y cooridinate

Returns number
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:47
set y(value: number): void
Parameters
- value: number
Returns void
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:48

z

get z(): number
Z cooridinate

Returns number
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:52
set z(value: number): void
Parameters
- value: number
Returns void
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:53

Methods

_onChange

_onChange(callback: () => void): this
Parameters
- callback: () => void
Returns this
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:226

_onChangeCallback

_onChangeCallback(): void
Returns void
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:227

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:228

angleTo

angleTo(q: AcGeQuaternion): number
Return the angle between this quaternion and quaternion q in radians.
Parameters
- q: AcGeQuaternion
  Input one quaternion
Returns number
Return the angle between this quaternion and quaternion q in radians.
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:112

clone

clone(): AcGeQuaternion
Create a new quaternion with identical x, y, z and w properties to this one.

Returns AcGeQuaternion
Return cloned instance
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:72

conjugate

conjugate(): this
Return the rotational conjugate of this quaternion. The conjugate of a quaternion represents the same rotation in the opposite direction about the rotational axis.

Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:137

copy

copy(quaternion: AcGeQuaternion): this
Copy the x, y, z and w properties of q into this quaternion.
Parameters
- quaternion: AcGeQuaternion
  Input the quaternion copied from
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:78

dot

dot(v: AcGeQuaternion): number
Calculate the dot product of quaternions v and this one.
Parameters
- v: AcGeQuaternion
  Input one quaternion
Returns number
Return the dot product of quaternions v and this one
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:143

equals

equals(quaternion: AcGeQuaternion): boolean
Compare the x, y, z and w properties of v to the equivalent properties of this quaternion to determine if they represent the same rotation.
Parameters
- quaternion: AcGeQuaternion
  Input quaternion that this quaternion will be compared to.
Returns boolean
Return true if the specified quaternion and this quaternion represent the same rotation.
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:210

fromArray

fromArray(array: number[], offset?: number): this
Set this quaternion's x, y, z and w properties from an array.
Parameters
- array: number[]
  Input an array of format (x, y, z, w) used to construct the quaternion.
- Optionaloffset: number
  Input an optional offset into the array
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:217

identity

identity(): this
Set this quaternion to the identity quaternion; that is, to the quaternion that represents "no rotation".

Returns this
Return this quaternion.
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:126

invert

invert(): this
Invert this quaternion - calculates the conjugate. The quaternion is assumed to have unit length.

Returns this
Return this quaternion.
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:131

length

length(): number
Compute the Euclidean length (straight-line length) of this quaternion, considered as a 4 dimensional vector.

Returns number
Return the Euclidean length (straight-line length) of this quaternion.
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:156

lengthSq

lengthSq(): number
Compute the squared Euclidean length (straight-line length) of this quaternion, considered as a 4 dimensional vector. This can be useful if you are comparing the lengths of two quaternions, as this is a slightly more efficient calculation than length().

Returns number
Return the squared Euclidean length (straight-line length) of this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:150

multiply

multiply(q: AcGeQuaternion): this
Multiply this quaternion by q.
Parameters
- q: AcGeQuaternion
  Input one quaternion to multiply
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:168

multiplyQuaternions

multiplyQuaternions(a: AcGeQuaternion, b: AcGeQuaternion): this
Sets this quaternion to a x b.
Parameters
- a: AcGeQuaternion
  Input one quaternion
- b: AcGeQuaternion
  Input one quaternion
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:181

normalize

normalize(): this
Normalize this quaternion - that is, calculated the quaternion that performs the same rotation as this one, but has length equal to 1.

Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:162

premultiply

premultiply(q: AcGeQuaternion): this
Pre-multiply this quaternion by q.
Parameters
- q: AcGeQuaternion
  Input one quaternion
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:174

random

random(): this
Set this quaternion to a uniformly random, normalized quaternion.

Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:203

rotateTowards

rotateTowards(q: AcGeQuaternion, step: number): this
Rotate this quaternion by a given angular step to the defined quaternion q. The method ensures that the final quaternion will not overshoot q.
Parameters
- q: AcGeQuaternion
  Input the target quaternion.
- step: number
  Input the angular step in radians.
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:120

set

set(x: number, y: number, z: number, w: number): this
Set x, y, z, w properties of this quaternion.
Parameters
- x: number
  Input x coordinate
- y: number
  Input y coordinate
- z: number
  Input z coordinate
- w: number
  Input w coordinate
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:67

setFromAxisAngle

setFromAxisAngle(axis: AcGeVector3dLike, angle: number): this
Set this quaternion from rotation specified by axis and angle. Axis is assumed to be normalized, angle is in radians.
Parameters
- axis: AcGeVector3dLike
  Input one normalized axis
- angle: number
  Input one angle in radians
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:93

setFromEuler

setFromEuler(euler: AcGeEuler, update?: boolean): this
Sets this quaternion from the rotation specified by euler angle.
Parameters
- euler: AcGeEuler
  Input one euler angle
- Optionalupdate: boolean
  Input one flag whether to trigger change callback function
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:85

setFromRotationMatrix

setFromRotationMatrix(m: AcGeMatrix3d): this
Set this quaternion from rotation component of the specified matrix.
Parameters
- m: AcGeMatrix3d
  Input a Matrix4 of which the upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled).
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:99

setFromUnitVectors

setFromUnitVectors(vFrom: AcGeVector3d, vTo: AcGeVector3d): this
Set this quaternion to the rotation required to rotate direction vector vFrom to direction vector vTo.
Parameters
- vFrom: AcGeVector3d
  Input one normalized direction vector
- vTo: AcGeVector3d
  Input one normalized direction vector
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:106

slerp

slerp(qb: AcGeQuaternion, t: number): this
Handles the spherical linear interpolation between quaternions. t represents the amount of rotation between this quaternion (where t is 0) and qb (where t is 1).
Parameters
- qb: AcGeQuaternion
  Input the other quaternion rotation
- t: number
  Input interpolation factor in the closed interval [0, 1].
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:189

slerpQuaternions

slerpQuaternions(qa: AcGeQuaternion, qb: AcGeQuaternion, t: number): this
Perform a spherical linear interpolation between the given quaternions and stores the result in this quaternion.
Parameters
- qa: AcGeQuaternion
  Input one quaternion rotation
- qb: AcGeQuaternion
  Input the other quaternion rotation
- t: number
  Input interpolation factor in the closed interval [0, 1].
Returns this
Return this quaternion
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:198

toArray

toArray(array?: number[], offset?: number): number[]
Return the numerical elements of this quaternion in an array of format [x, y, z, w].
Parameters
- Optionalarray: number[]
  Input an optional array to store the quaternion. If not specified, a new array will be created.
- Optionaloffset: number
  (optional) if specified, the result will be copied into this Array.
Returns number[]
Return an array
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:224

toJSON

toJSON(): number[]
Returns number[]
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:225

`Static`multiplyQuaternionsFlat

multiplyQuaternionsFlat(
    dst: number[],
    dstOffset: number,
    src0: number[],
    srcOffset0: number,
    src1: number[],
    srcOffset1: number,
): number[]
This multiplication implementation assumes the quaternion data are managed in flat arrays.
Parameters
- dst: number[]
  Input the output array.
- dstOffset: number
  Input an offset into the output array.
- src0: number[]
  Input the source array of the starting quaternion.
- srcOffset0: number
  Input an offset into the array src0.
- src1: number[]
  Input the source array of the target quaternion.
- srcOffset1: number
  Input an offset into the array src1.
Returns number[]
Return an array
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:38

`Static`slerpFlat

slerpFlat(
    dst: number[],
    dstOffset: number,
    src0: number[],
    srcOffset0: number,
    src1: number[],
    srcOffset1: number,
    t: number,
): void
This SLERP implementation assumes the quaternion data are managed in flat arrays.
Parameters
- dst: number[]
  Input the output array
- dstOffset: number
  Input an offset into the output array
- src0: number[]
  Input the source array of the starting quaternion.
- srcOffset0: number
  Input an offset into the array src0.
- src1: number[]
  Input the source array of the target quaternion.
- srcOffset1: number
  Input an offset into the array src1.
- t: number
  Input normalized interpolation factor (between 0 and 1).
Returns void
- Defined in geometry-engine/lib/math/AcGeQuaternion.d.ts:27

Class AcGeQuaternion

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcGeQuaternion

Accessors

w

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

z

Returns number

Parameters

Returns void

Methods

_onChange

Parameters

Returns this

_onChangeCallback

Returns void

[iterator]

Returns Generator<number, void, unknown>

angleTo

Parameters

Returns number

clone

Returns AcGeQuaternion

conjugate

Returns this

copy

Parameters

Returns this

dot

Parameters

Returns number

equals

Parameters

Returns boolean

fromArray

Parameters

Returns this

identity

Returns this

invert

Returns this

length

Returns number

lengthSq

Returns number

multiply

Parameters

Returns this

multiplyQuaternions

Parameters

Returns this

normalize

Returns this

premultiply

Parameters

Returns this

random

Returns this

rotateTowards

Parameters

Returns this

set

Parameters

Returns this

`Static`multiplyQuaternionsFlat

`Static`slerpFlat