Class ObservableQuaternion

Represents a rotation quaternion in 3D space.

Hierarchy

ObservablePoint3D
- ObservableQuaternion

Index

Constructors

constructor

Properties

_w
cb
scope
x
y

Accessors

w
z

Methods

Constructors

constructor

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

Overrides ObservablePoint3D.constructor
- Defined in src/transform/observable-quaternion.ts:12
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

_w

_w: number

Protected cb

cb: () => void

The callback when changed.

Type declaration

- (): void
- Returns void

Protected scope

scope: any

The owner of callback.

x

x: number

X coord

memberof: PIXI.IPoint#
member: {number} x

y

y: number

Y coord

memberof: PIXI.IPoint#
member: {number} y

Accessors

w

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

- Defined in src/transform/observable-quaternion.ts:40
W component of the quaternion.

Returns number
- Defined in src/transform/observable-quaternion.ts:44
W component of the quaternion.

Parameters
- value: number
Returns void

z

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

Inherited from ObservablePoint3D.z
- Defined in src/transform/observable-point.ts:25
Position on the z axis relative to the local coordinates of the parent.

Returns number
Inherited from ObservablePoint3D.z
- Defined in src/transform/observable-point.ts:29
Position on the z axis relative to the local coordinates of the parent.

Parameters
- value: number
Returns void

Methods

clone

clone(cb?: undefined | ((...params: any[]) => any), scope?: any): ObservableQuaternion

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

Parameters
- Optional cb: undefined | ((...params: any[]) => any)
  
  Callback when changed.
- Optional scope: any
  
  Owner of callback.
Returns ObservableQuaternion

copyFrom

copyFrom(p: IPoint): this

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

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

copyTo

copyTo(p: IPoint): any

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

Parameters
- p: IPoint
  
  The quaternion to copy to.
Returns any

equals

equals(p: IPoint): boolean

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

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

set

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

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

Parameters
- x: number
  
  X component to set.
- Optional y: undefined | number
  
  Y component to set.
- Optional z: undefined | number
  
  Z component to set.
- Optional w: undefined | number
  
  W component to set.
Returns this

setEulerAngles

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

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

Overrides ObservablePoint3D.setFrom
- Defined in src/transform/observable-quaternion.ts:116
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

Generated using TypeDoc