Class ObservableQuaternion<T>

Represents a rotation quaternion in 3D space.

Type parameters

T

Hierarchy

ObservablePoint
- ObservableQuaternion

Implements

IPoint

Index

Constructors

constructor

Properties

Accessors

array
w
x
y
z

Methods

Constructors

constructor

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

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

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

Properties

Private _array

_array: Float32Array = new Float32Array(4)

_x

_x: number

_y

_y: number

cb

cb: (this: T) => any

Type declaration

- (this: T): any
- Parameters
  - this: T
  Returns any

scope

scope: any

Accessors

array

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

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

Returns Float32Array
- Defined in src/transform/observable-quaternion.ts:16
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/observable-quaternion.ts:71
The w component of the quaternion.

Returns number
- Defined in src/transform/observable-quaternion.ts:75
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/observable-quaternion.ts:35
The x component of the quaternion.

Returns number
Overrides ObservablePoint.x
- Defined in src/transform/observable-quaternion.ts:39
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/observable-quaternion.ts:47
The y component of the quaternion.

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

Parameters
- value: number
Returns void

z

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

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

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

Parameters
- value: number
Returns void

Methods

clone

clone(cb?: (this: T) => any, scope?: any): ObservableQuaternion

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

Parameters
- Default value cb: (this: T) => any = this.cb
  
  Callback when changed.
  - - (this: T): any
    - Parameters
      - this: T
      Returns any
- Default value scope: any = this.scope
  
  Owner of callback.
Returns ObservableQuaternion

copyFrom

copyFrom(p: ObservableQuaternion): this

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

Parameters
- p: ObservableQuaternion
  
  The quaternion to copy from.
Returns this

copyTo

copyTo<T>(p: T): T

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

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

equals

equals(p: ObservableQuaternion): boolean

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

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

set

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

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

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

setEulerAngles

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

- Defined in src/transform/observable-quaternion.ts:88
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>): this

- Defined in src/transform/observable-quaternion.ts:157
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 this

toString

toString(): string

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

Generated using TypeDoc