Class Quaternion

Represents a rotation quaternion in 3D space.

Hierarchy

ObservablePoint
- Quaternion

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number, cb?: () => void, scope?: any): Quaternion

Overrides ObservablePoint.constructor
- Defined in src/transform/quaternion.ts:30
Creates a new observable quaternion.

Parameters
- x: number = 0
  
  The x component.
- y: number = 0
  
  The y component.
- z: number = 0
  
  The z component.
- w: number = 1
  
  The w component.
- cb: () => void = ...
  
  The callback when changed.
  - - (): void
    - Returns void
- scope: any = undefined
  
  The owner of callback.
Returns Quaternion

Properties

_x

_x: number

_y

_y: number

cb

cb: () => any

Type declaration

- (): any
- The callback function triggered when x and/or y are changed
  
  Returns any

scope

scope: any

The owner of the callback

Accessors

array

get array(): Float32Array
set array(value: Float32Array): void

- Defined in src/transform/quaternion.ts:13
Array containing the x, y, z, w values.

Returns Float32Array
- Defined in src/transform/quaternion.ts:17
Array containing the x, y, z, w values.

Parameters
- value: Float32Array
Returns void

w

get w(): number
set w(value: number): void

- Defined in src/transform/quaternion.ts:72
The w component of the quaternion.

Returns number
- Defined in src/transform/quaternion.ts:76
The w component of the quaternion.

Parameters
- value: number
Returns void

x

get x(): number
set x(value: number): void

Overrides ObservablePoint.x
- Defined in src/transform/quaternion.ts:36
The x component of the quaternion.

Returns number
Overrides ObservablePoint.x
- Defined in src/transform/quaternion.ts:40
The x component of the quaternion.

Parameters
- value: number
Returns void

y

get y(): number
set y(value: number): void

Overrides ObservablePoint.y
- Defined in src/transform/quaternion.ts:48
The y component of the quaternion.

Returns number
Overrides ObservablePoint.y
- Defined in src/transform/quaternion.ts:52
The y component of the quaternion.

Parameters
- value: number
Returns void

z

get z(): number
set z(value: number): void

- Defined in src/transform/quaternion.ts:60
The z component of the quaternion.

Returns number
- Defined in src/transform/quaternion.ts:64
The z component of the quaternion.

Parameters
- value: number
Returns void

Methods

clone

clone(cb?: () => any, scope?: any): Quaternion

Overrides ObservablePoint.clone
- Defined in src/transform/quaternion.ts:98
Creates a clone of this quaternion.

Parameters
- cb: () => any = ...
  
  Callback when changed.
  - - (): any
    - The callback function triggered when x and/or y are changed
      
      Returns any
- scope: any = ...
  
  Owner of callback.
Returns Quaternion

copyFrom

copyFrom(p: Quaternion): Quaternion

Overrides ObservablePoint.copyFrom
- Defined in src/transform/quaternion.ts:106
Copies x, y, z, and w from the given quaternion.

Parameters
- p: Quaternion
  
  The quaternion to copy from.
Returns Quaternion

copyTo

copyTo<T>(p: T): T

Overrides ObservablePoint.copyTo
- Defined in src/transform/quaternion.ts:121
Copies x, y, z and w into the given quaternion.

Type parameters
- T: IPoint<T>
Parameters
- p: T
  
  The quaternion to copy to.
Returns T

equals

equals(p: Quaternion): boolean

Overrides ObservablePoint.equals
- Defined in src/transform/quaternion.ts:132
Returns true if the given quaternion is equal to this quaternion.

Parameters
- p: Quaternion
  
  The quaternion to check.
Returns boolean

normalize

normalize(out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:166
Normalize the quaternion.

Parameters
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

set

set(x: number, y?: number, z?: number, w?: number): Quaternion

Overrides ObservablePoint.set
- Defined in src/transform/quaternion.ts:143
Sets the quaternion to new x, y, z and w components.

Parameters
- x: number
  
  X component to set.
- y: number = x
  
  Y component to set.
- z: number = x
  
  Z component to set.
- w: number = x
  
  W component to set.
Returns Quaternion

setEulerAngles

setEulerAngles(x: number, y: number, z: number): void

- Defined in src/transform/quaternion.ts:89
Sets the euler angles in degrees.

Parameters
- x: number
  
  The x angle.
- y: number
  
  The y angle.
- z: number
  
  The z angle.
Returns void

setFrom

setFrom(array: ArrayLike<number>): Quaternion

- Defined in src/transform/quaternion.ts:158
Sets the quaternion to a new x, y, z and w components.

Parameters
- array: ArrayLike<number>
  
  The array containing x, y, z and w, expected length is 4.
Returns Quaternion

toString

toString(): string

Inherited from ObservablePoint.toString
- Defined in node_modules/@pixi/math/index.d.ts:573
Returns string

Static conjugate

conjugate(a: Quaternion, out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:200
Calculates the conjugate of a quaternion if the quaternion is normalized.

Parameters
- a: Quaternion
  
  The quaternion to calculate conjugate of.
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

Static fromEuler

fromEuler(x: number, y: number, z: number, out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:190
Creates a quaternion from the given euler angle x, y, z.

Parameters
- x: number
  
  X axis to rotate around in degrees.
- y: number
  
  Y axis to rotate around in degrees.
- z: number
  
  Z axis to rotate around in degrees.
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

Static rotateX

rotateX(a: Quaternion, rad: number, out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:211
Rotates a quaternion by the given angle about the X axis.

Parameters
- a: Quaternion
  
  The quaternion to rotate.
- rad: number
  
  The angle (in radians) to rotate.
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

Static rotateY

rotateY(a: Quaternion, rad: number, out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:222
Rotates a quaternion by the given angle about the Y axis.

Parameters
- a: Quaternion
  
  The quaternion to rotate.
- rad: number
  
  The angle (in radians) to rotate.
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

Static rotateZ

rotateZ(a: Quaternion, rad: number, out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:233
Rotates a quaternion by the given angle about the Z axis.

Parameters
- a: Quaternion
  
  The quaternion to rotate.
- rad: number
  
  The angle (in radians) to rotate.
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

Static slerp

slerp(a: Quaternion, b: Quaternion, t: number, out?: Quaternion): Quaternion

- Defined in src/transform/quaternion.ts:178
Performs a spherical linear interpolation between two quaternions.

Parameters
- a: Quaternion
  
  The first quaternion.
- b: Quaternion
  
  The second quaternion.
- t: number
  
  The interpolation amount, in the range [0-1], between the two inputs.
- out: Quaternion = ...
  
  The receiving quaternion. If not supplied, a new quaternion will be created.
Returns Quaternion

Generated using TypeDoc