Class Orientation2D

Hierarchy (View Summary)

Rotary
- Orientation2D

Constructors

constructor

new Orientation2D(cos?: number, sin?: number): Orientation2D
Parameters
- cos: number = 1
- sin: number = 0
Returns Orientation2D
Inherited from Rotary.constructor
- Defined in packages/math/src/core/angles/rotary.js:17

Properties

cos

cos: number

sin

sin: number

`Static` `Readonly`Identity

Identity: Rotary = ...

`Static` `Readonly`Zero

Zero: Rotary = ...

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
Inherited from Rotary.[iterator]
- Defined in packages/math/src/core/angles/rotary.js:399

clone

clone(): Rotary
Returns Rotary
Inherited from Rotary.clone
- Defined in packages/math/src/core/angles/rotary.js:45

copy

copy(v: Rotary): Orientation2D
Parameters
- v: Rotary
Returns Orientation2D
Inherited from Rotary.copy
- Defined in packages/math/src/core/angles/rotary.js:36

dot

dot(rotary: Rotary): number
Parameters
- rotary: Rotary
Returns number
Inherited from Rotary.dot
- Defined in packages/math/src/core/angles/rotary.js:106

equals

equals(rotary: Rotary): boolean
Parameters
- rotary: Rotary
Returns boolean
Inherited from Rotary.equals
- Defined in packages/math/src/core/angles/rotary.js:123

magnitude

magnitude(): number
Returns number
Inherited from Rotary.magnitude
- Defined in packages/math/src/core/angles/rotary.js:59

magnitudeSquared

magnitudeSquared(): number
Returns number
Inherited from Rotary.magnitudeSquared
- Defined in packages/math/src/core/angles/rotary.js:52

multiply

multiply(rotary: Rotary): Orientation2D
Parameters
- rotary: Rotary
Returns Orientation2D
Inherited from Rotary.multiply
- Defined in packages/math/src/core/angles/rotary.js:86

multiplyScalar

multiplyScalar(scalar: number): Orientation2D
Parameters
- scalar: number
Returns Orientation2D
Inherited from Rotary.multiplyScalar
- Defined in packages/math/src/core/angles/rotary.js:96

normalize

normalize(): Orientation2D
Returns Orientation2D
Inherited from Rotary.normalize
- Defined in packages/math/src/core/angles/rotary.js:66

reverse

reverse(): Orientation2D
Returns Orientation2D
Inherited from Rotary.reverse
- Defined in packages/math/src/core/angles/rotary.js:113

rotate

rotate(angle: number): Orientation2D
Parameters
- angle: number
Returns Orientation2D
Inherited from Rotary.rotate
- Defined in packages/math/src/core/angles/rotary.js:76

set

set(cos: number, sin: number): Orientation2D
Parameters
- cos: number
- sin: number
Returns Orientation2D
Inherited from Rotary.set
- Defined in packages/math/src/core/angles/rotary.js:26

`Static`angleBetween

angleBetween(a: Rotary, b: Rotary): number
Parameters
- a: Rotary
- b: Rotary
Returns number
Inherited from Rotary.angleBetween
- Defined in packages/math/src/core/angles/rotary.js:313

`Static`clone

clone(target: Orientation2D): Rotary
Parameters
- target: Orientation2D
Returns Rotary
- Defined in packages/transform/src/components/2d/orientation.js:16

`Static`copy

copy(source: Orientation2D, target?: Orientation2D): Rotary
Parameters
- source: Orientation2D
- target: Orientation2D = ...
Returns Rotary
Overrides Rotary.copy
- Defined in packages/transform/src/components/2d/orientation.js:9

`Static`deserialize

deserialize(value: RotarySerial, out?: Orientation2D): Rotary
Parameters
- value: RotarySerial
- Optionalout: Orientation2D = ...
Returns Rotary
Overrides Rotary.deserialize
- Defined in packages/transform/src/components/2d/orientation.js:31

`Static`dot

dot(a: Rotary, b: Rotary): number
Parameters
- a: Rotary
- b: Rotary
Returns number
Inherited from Rotary.dot
- Defined in packages/math/src/core/angles/rotary.js:305

`Static`equal

equal(rot1: Rotary, rot2: Rotary): boolean
Parameters
- rot1: Rotary
- rot2: Rotary
Returns boolean
Inherited from Rotary.equal
- Defined in packages/math/src/core/angles/rotary.js:374

`Static`fromAngle

fromAngle(angle: number, out?: Rotary): Rotary
Parameters
- angle: number
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.fromAngle
- Defined in packages/math/src/core/angles/rotary.js:322

`Static`fromRotationMatrix

fromRotationMatrix(matrix: Matrix2, out?: Rotary): Rotary
Parameters
- matrix: Matrix2
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.fromRotationMatrix
- Defined in packages/math/src/core/angles/rotary.js:333

`Static`fuzzyEqual

fuzzyEqual(rot1: Rotary, rot2: Rotary, tolerance?: number): boolean
Parameters
- rot1: Rotary
- rot2: Rotary
- Optionaltolerance: number
Returns boolean
Inherited from Rotary.fuzzyEqual
- Defined in packages/math/src/core/angles/rotary.js:386

`Static`identity

identity(out?: Rotary): Rotary
Parameters
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.identity
- Defined in packages/math/src/core/angles/rotary.js:193

`Static`magnitude

magnitude(q: Rotary): number
Parameters
- q: Rotary
Returns number
Inherited from Rotary.magnitude
- Defined in packages/math/src/core/angles/rotary.js:223

`Static`magnitudeSquared

magnitudeSquared(q: Rotary): number
Parameters
- q: Rotary
Returns number
Inherited from Rotary.magnitudeSquared
- Defined in packages/math/src/core/angles/rotary.js:215

`Static`multiply

multiply(rotation1: Rotary, rotation2: Rotary, out?: Rotary): Rotary
Parameters
- rotation1: Rotary
- rotation2: Rotary
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.multiply
- Defined in packages/math/src/core/angles/rotary.js:267

`Static`multiplyScalar

multiplyScalar(rotation: Rotary, scalar: number, out?: Rotary): Rotary
Parameters
- rotation: Rotary
- scalar: number
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.multiplyScalar
- Defined in packages/math/src/core/angles/rotary.js:282

`Static`normalize

normalize(q: Rotary, out?: Rotary): Rotary
Parameters
- q: Rotary
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.normalize
- Defined in packages/math/src/core/angles/rotary.js:232

`Static`random

random(): Rotary
Returns Rotary
Inherited from Rotary.random
- Defined in packages/math/src/core/angles/rotary.js:393

`Static`reverse

reverse(rotation: Rotary, out?: Rotary): Rotary
Parameters
- rotation: Rotary
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.reverse
- Defined in packages/math/src/core/angles/rotary.js:293

`Static`rotate

rotate(angle: number, out?: Rotary): Rotary
Parameters
- angle: number
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.rotate
- Defined in packages/math/src/core/angles/rotary.js:251

`Static`serialize

serialize(value: Orientation2D): { cos: number; sin: number }
Parameters
- value: Orientation2D
Returns { cos: number; sin: number }
Overrides Rotary.serialize
- Defined in packages/transform/src/components/2d/orientation.js:23

`Static`set

set(cos: number, sin: number, out?: Rotary): Rotary
Parameters
- cos: number
- sin: number
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.set
- Defined in packages/math/src/core/angles/rotary.js:133

`Static`slerp

slerp(a: Rotary, b: Rotary, t: number, out?: Rotary): Rotary
Parameters
- a: Rotary
- b: Rotary
- t: number
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.slerp
- Defined in packages/math/src/core/angles/rotary.js:359

`Static`toAngle

toAngle(out: Rotary): number
Parameters
- out: Rotary
Returns number
Inherited from Rotary.toAngle
- Defined in packages/math/src/core/angles/rotary.js:343

`Static`validateSerial

validateSerial(value: unknown): value is RotarySerial
Parameters
- value: unknown
Returns value is RotarySerial
Inherited from Rotary.validateSerial
- Defined in packages/math/src/core/angles/rotary.js:177

`Static`zero

zero(out?: Rotary): Rotary
Parameters
- out: Rotary = ...
Returns Rotary
Inherited from Rotary.zero
- Defined in packages/math/src/core/angles/rotary.js:204