Quat | Creator3dAPI

quaternion

Hierarchy

ValueType
- Quat

Index

Constructors

constructor

Properties

w
x
y
z
IDENTITY

Methods

Constructors

constructor

newQuat(other: Quat): Quat
newQuat(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Quat

- Defined in cocos/core/math/quat.ts:680
Parameters
- other: Quat
Returns Quat
- Defined in cocos/core/math/quat.ts:682
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
- Optional w: undefined | number
Returns Quat

Properties

w

w: number

w component.

x

x: number

x component.

y

y: number

y component.

z

z: number

z component.

Static IDENTITY

IDENTITY: {} = Object.freeze(new Quat())

Type declaration

Methods

clone

clone(): Quat

Overrides ValueType.clone
- Defined in cocos/core/math/quat.ts:705
clone the current Quat

Returns Quat

equals

equals(other: Quat, epsilon?: number): boolean

Overrides ValueType.equals
- Defined in cocos/core/math/quat.ts:746
Check whether the quaternion approximately equals another one

Parameters
- other: Quat
  
  Comparative quaternion
- Default value epsilon: number = EPSILON
  
  The error allowed. It`s should be a non-negative number.
Returns boolean

Returns true' when the components of the two quaternions are equal within the specified error range; otherwise, returnsfalse'.

getEulerAngles

getEulerAngles(out: Vec3): IVec3Like

- Defined in cocos/core/math/quat.ts:768
Convert quaternion to Euler angles

Parameters
- out: Vec3
  
  the output vector
Returns IVec3Like

length

length(): number

- Defined in cocos/core/math/quat.ts:800
Calculates the length of the quaternion

Returns number

lengthSqr

lengthSqr(): number

- Defined in cocos/core/math/quat.ts:808
Calculates the squared length of the quaternion

Returns number

lerp

lerp(to: Quat, ratio: number): this

- Defined in cocos/core/math/quat.ts:778
Calculate the linear interpolation result between this quaternion and another one with given ratio

Parameters
- to: Quat
  
  The target quaternion
- ratio: number
  
  The interpolation coefficient. The range is [0,1].
Returns this

set

set(other: Quat): Quat
set(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Quat

Overrides ValueType.set
- Defined in cocos/core/math/quat.ts:715
Set values with another quaternion

Parameters
- other: Quat
  
  Specified quaternion
Returns Quat

this
Overrides ValueType.set
- Defined in cocos/core/math/quat.ts:722
Set the value of each component of the current quaternion

Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
- Optional w: undefined | number
Returns Quat

this

slerp

slerp(to: Quat, ratio: number): this

- Defined in cocos/core/math/quat.ts:792
Calculates the spherical interpolation result between this quaternion and another one with the given ratio

Parameters
- to: Quat
  
  The target quaternion
- ratio: number
  
  The interpolation coefficient. The range is [0,1].
Returns this

strictEquals

strictEquals(other: Quat): boolean

- Defined in cocos/core/math/quat.ts:759
Check whether the current quaternion strictly equals other quaternion

Parameters
- other: Quat
  
  Comparative quaternion
Returns boolean

Returns true' when the components of the two quaternions are equal within the specified error range; otherwise, returnsfalse'.

toString

toString(): string

Inherited from ValueType.toString
- Defined in cocos/core/value-types/value-type.ts:95
Convert the current object to a string. The base version of this method will returns an empty string.

Returns string

The string representation of the current object

Static calculateW

calculateW<Out>(out: Out, a: Out): Out

- Defined in cocos/core/math/quat.ts:273
Calculates the w component with xyz components, considering the given quaternion normalized

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
Returns Out

Static clone

clone<Out>(a: Out): Quat

- Defined in cocos/core/math/quat.ts:51
Obtain a copy of the given quaternion

Type parameters
- Out: IQuatLike
Parameters
- a: Out
Returns Quat

Static conjugate

conjugate<Out>(out: Out, a: Out): Out

- Defined in cocos/core/math/quat.ts:382
Conjugating a quaternion, it's equivalent to the inverse of the unit quaternion, but more efficient

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
Returns Out

Static copy

copy<Out, QuatLike>(out: Out, a: QuatLike): Out

- Defined in cocos/core/math/quat.ts:59
Copy the given quaternion to the out quaternion

Type parameters
- Out: IQuatLike
- QuatLike: IQuatLike
Parameters
- out: Out
- a: QuatLike
Returns Out

Static dot

dot<Out>(a: Out, b: Out): number

- Defined in cocos/core/math/quat.ts:286
Quaternion dot product (scalar product)

Type parameters
- Out: IQuatLike
Parameters
- a: Out
- b: Out
Returns number

Static equals

equals(a: IQuatLike, b: IQuatLike, epsilon?: number): boolean

- Defined in cocos/core/math/quat.ts:651
Check whether two quaternions are approximately equal

Parameters
- a: IQuatLike
- b: IQuatLike
- Default value epsilon: number = EPSILON
Returns boolean

Static fromArray

fromArray(out: IQuatLike, arr: IWritableArrayLike<number>, ofs?: number): IQuatLike

- Defined in cocos/core/math/quat.ts:631
Array to a quaternion

Parameters
- out: IQuatLike
- arr: IWritableArrayLike<number>
- Default value ofs: number = 0
  
  Array Start Offset
Returns IQuatLike

Static fromAxes

fromAxes<Out, VecLike>(out: Out, xAxis: VecLike, yAxis: VecLike, zAxis: VecLike): Out

- Defined in cocos/core/math/quat.ts:426
Calculated the quaternion represents the given coordinates, considering all given vectors are normalized and mutually perpendicular

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- xAxis: VecLike
- yAxis: VecLike
- zAxis: VecLike
Returns Out

Static fromAxisAngle

fromAxisAngle<Out, VecLike>(out: Out, axis: VecLike, rad: number): Out

- Defined in cocos/core/math/quat.ts:450
Calculates the quaternion from a given rotary shaft and a radian rotation around it.

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- axis: VecLike
- rad: number
Returns Out

Static fromEuler

fromEuler<Out>(out: Out, x: number, y: number, z: number): Out

- Defined in cocos/core/math/quat.ts:513
Calculates the quaternion with Euler angles, the rotation order is YZX

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- x: number
- y: number
- z: number
Returns Out

Static fromMat3

fromMat3<Out>(out: Out, m: Mat3): Out

- Defined in cocos/core/math/quat.ts:464
Calculates the quaternion with the three-dimensional transform matrix, considering no scale included in the matrix

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- m: Mat3
Returns Out

Static fromViewUp

fromViewUp<Out, VecLike>(out: Out, view: VecLike, up?: Vec3): Out

- Defined in cocos/core/math/quat.ts:441
Calculates the quaternion with the up direction and the direction of the viewport

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- view: VecLike
  
  The view direction, it`s must be normalized.
- Optional up: Vec3
  
  The view up direction, it`s must be normalized, default value is (0, 1, 0).
Returns Out

Static getAxisAngle

getAxisAngle<Out, VecLike>(outAxis: VecLike, q: Out): number

- Defined in cocos/core/math/quat.ts:128
Gets the rotation axis and the arc of rotation from the quaternion

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- outAxis: VecLike
  
  output axis
- q: Out
  
  input quaternion
Returns number

radius of rotation

Static identity

identity<Out>(out: Out): Out

- Defined in cocos/core/math/quat.ts:83
Sets the out quaternion to an identity quaternion

Type parameters
- Out: IQuatLike
Parameters
- out: Out
Returns Out

Static invert

invert<Out, QuatLike>(out: Out, a: QuatLike): Out

- Defined in cocos/core/math/quat.ts:365
Sets the inverse of the given quaternion to out quaternion

Type parameters
- Out: IQuatLike
- QuatLike: IQuatLike
Parameters
- out: Out
- a: QuatLike
Returns Out

Static len

len<Out>(a: Out): number

- Defined in cocos/core/math/quat.ts:394
Calculates the length of the quaternion

Type parameters
- Out: IQuatLike
Parameters
- a: Out
Returns number

Static lengthSqr

lengthSqr<Out>(a: Out): number

- Defined in cocos/core/math/quat.ts:402
Calculates the squared length of the quaternion

Type parameters
- Out: IQuatLike
Parameters
- a: Out
Returns number

Static lerp

lerp<Out>(out: Out, a: Out, b: Out, t: number): Out

- Defined in cocos/core/math/quat.ts:294
Element by element linear interpolation: A + t * (B - A)

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: Out
- t: number
Returns Out

Static multiply

multiply<Out, QuatLike_1, QuatLike_2>(out: Out, a: QuatLike_1, b: QuatLike_2): Out

- Defined in cocos/core/math/quat.ts:148
Quaternion multiplication and save the results to out quaternion

Type parameters
- Out: IQuatLike
- QuatLike_1: IQuatLike
- QuatLike_2: IQuatLike
Parameters
- out: Out
- a: QuatLike_1
- b: QuatLike_2
Returns Out

Static multiplyScalar

multiplyScalar<Out>(out: Out, a: Out, b: number): Out

- Defined in cocos/core/math/quat.ts:164
Quaternion scalar multiplication and save the results to out quaternion

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: number
Returns Out

Static normalize

normalize<Out>(out: Out, a: Out): Out

- Defined in cocos/core/math/quat.ts:410
Normalize the given quaternion

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
Returns Out

Static rotateAround

rotateAround<Out, VecLike>(out: Out, rot: Out, axis: VecLike, rad: number): Out

- Defined in cocos/core/math/quat.ts:247
Sets the out quaternion to represent a radian rotation around a given rotation axis in world space

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- rot: Out
- axis: VecLike
  
  axis of rotation, normalized by default
- rad: number
  
  radius of rotation
Returns Out

Static rotateAroundLocal

rotateAroundLocal<Out, VecLike>(out: Out, rot: Out, axis: VecLike, rad: number): Out

- Defined in cocos/core/math/quat.ts:263
Sets the out quaternion to represent a radian rotation around a given rotation axis in local space

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- rot: Out
- axis: VecLike
  
  axis of rotation
- rad: number
  
  radius of rotation
Returns Out

Static rotateX

rotateX<Out>(out: Out, a: Out, rad: number): Out

- Defined in cocos/core/math/quat.ts:189
Sets the out quaternion to represent a radian rotation around x axis

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- rad: number
  
  radius of rotation
Returns Out

Static rotateY

rotateY<Out>(out: Out, a: Out, rad: number): Out

- Defined in cocos/core/math/quat.ts:208
Sets the out quaternion to represent a radian rotation around y axis

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- rad: number
  
  radius of rotation
Returns Out

Static rotateZ

rotateZ<Out>(out: Out, a: Out, rad: number): Out

- Defined in cocos/core/math/quat.ts:227
Sets the out quaternion to represent a radian rotation around z axis

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- rad: number
  
  radius of rotation
Returns Out

Static rotationTo

rotationTo<Out, VecLike>(out: Out, a: VecLike, b: VecLike): Out

- Defined in cocos/core/math/quat.ts:95
Sets the out quaternion with the shortest path orientation between two vectors, considering both vectors normalized

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- a: VecLike
- b: VecLike
Returns Out

Static scaleAndAdd

scaleAndAdd<Out>(out: Out, a: Out, b: Out, scale: number): Out

- Defined in cocos/core/math/quat.ts:176
Quaternion multiplication and addition: A + B * scale

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: Out
- scale: number
Returns Out

Static set

set<Out>(out: Out, x: number, y: number, z: number, w: number): Out

- Defined in cocos/core/math/quat.ts:71
Sets the out quaternion with values of each component

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- x: number
- y: number
- z: number
- w: number
Returns Out

Static slerp

slerp<Out, QuatLike_1, QuatLike_2>(out: Out, a: QuatLike_1, b: QuatLike_2, t: number): Out

- Defined in cocos/core/math/quat.ts:306
Spherical quaternion interpolation

Type parameters
- Out: IQuatLike
- QuatLike_1: IQuatLike
- QuatLike_2: IQuatLike
Parameters
- out: Out
- a: QuatLike_1
- b: QuatLike_2
- t: number
Returns Out

Static sqlerp

sqlerp<Out>(out: Out, a: Out, b: Out, c: Out, d: Out, t: number): Out

- Defined in cocos/core/math/quat.ts:354
Spherical quaternion interpolation with two control points

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: Out
- c: Out
- d: Out
- t: number
Returns Out

Static strictEquals

strictEquals(a: IQuatLike, b: IQuatLike): boolean

- Defined in cocos/core/math/quat.ts:643
Check whether two quaternions are equal

Parameters
- a: IQuatLike
- b: IQuatLike
Returns boolean

Static toArray

toArray<Out>(out: Out, q: IQuatLike, ofs?: number): Out

- Defined in cocos/core/math/quat.ts:618
Converts quaternion to an array

Type parameters
- Out: IWritableArrayLike<number>
Parameters
- out: Out
- q: IQuatLike
- Default value ofs: number = 0
  
  Array Start Offset
Returns Out

Static toAxisX

toAxisX(out: IVec3Like, q: IQuatLike): IVec3Like

- Defined in cocos/core/math/quat.ts:537
This returns the X-axis vector of the quaternion

Parameters
- out: IVec3Like
- q: IQuatLike
Returns IVec3Like

Static toAxisY

toAxisY(out: IVec3Like, q: IQuatLike): IVec3Like

- Defined in cocos/core/math/quat.ts:551
This returns the Y-axis vector of the quaternion

Parameters
- out: IVec3Like
- q: IQuatLike
Returns IVec3Like

Static toAxisZ

toAxisZ(out: IVec3Like, q: IQuatLike): IVec3Like

- Defined in cocos/core/math/quat.ts:566
This returns the Z-axis vector of the quaternion

Parameters
- out: IVec3Like
- q: IQuatLike
Returns IVec3Like

Static toEuler

toEuler(out: IVec3Like, q: IQuatLike, outerZ?: undefined | false | true): IVec3Like

- Defined in cocos/core/math/quat.ts:582
Converts the quaternion to angles, result angle x, y in the range of [-180, 180], z in the range of [-90, 90] interval, the rotation order is YZX

Parameters
- out: IVec3Like
- q: IQuatLike
- Optional outerZ: undefined | false | true
  
  change z value range to [-180, -90] U [90, 180]
Returns IVec3Like

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

other: Quat

Returns Quat

Parameters

Optional x: undefined | number

Optional y: undefined | number

Optional z: undefined | number

Optional w: undefined | number

Returns Quat

Properties

w

x

y

z

Static IDENTITY

Type declaration

Methods

clone

Returns Quat

equals

Parameters

other: Quat

Default value epsilon: number = EPSILON

Returns boolean

getEulerAngles

Parameters

out: Vec3

Returns IVec3Like

length

Returns number

lengthSqr

Returns number

lerp

Parameters

to: Quat

ratio: number

Returns this

set

Parameters

other: Quat

Returns Quat

Parameters

Optional x: undefined | number

Optional y: undefined | number

Optional z: undefined | number

Optional w: undefined | number

Returns Quat

slerp

Parameters

to: Quat

ratio: number

Returns this

strictEquals

Parameters

other: Quat

Returns boolean

toString

Returns string

Static calculateW

Type parameters

Out: IQuatLike

Parameters

out: Out

a: Out

Returns Out

Static clone

Type parameters

Out: IQuatLike

Parameters

a: Out

Returns Quat

Static conjugate

Type parameters