Class Rotator

An orthogonal rotation in 3d space

Hierarchy

Rotator

Implements

Iterable<number>

Index

Constructors

constructor

Properties

0
1
2
pitch
roll
yaw

Methods

Constructors

constructor

new Rotator(pitch: number, yaw: number, roll: number): Rotator

- Defined in index.d.ts:287
Make a rotator {Pitch, Yaw, Roll} from rotation values

Parameters
- pitch: number
  
  Rotation around Y axis in degrees
- yaw: number
  
  Rotation around Z axis in degrees
- roll: number
  
  Rotation around X axis in degrees
Returns Rotator

Properties

0

0: number

Index for pitch

1

1: number

Index for yaw

2

2: number

Index for roll

pitch

pitch: number

Pitch (degrees) around Y axis

roll

roll: number

Roll (degrees) around X axis

yaw

yaw: number

Yaw (degrees) around Z axis

Methods

[Symbol.iterator]

[Symbol.iterator](): Iterator<number>

- Defined in index.d.ts:322
Returns Iterator<number>

clone

clone(): Rotator

- Defined in index.d.ts:327
Return a copy of this Rotator

Returns Rotator

compose

compose(b: Rotator | [pitch: number, yaw: number, roll: number]): Rotator

- Defined in index.d.ts:335
Combine 2 rotations to give the resulting rotation of first applying this rotator, then b

Parameters
- b: Rotator | [pitch: number, yaw: number, roll: number]
Returns Rotator

equals

equals(b: Rotator | [pitch: number, yaw: number, roll: number], errorTolerance: number): boolean

- Defined in index.d.ts:345
Return true if this rotator is equal to rotator b (a == b) within a specified error tolerance

Parameters
- b: Rotator | [pitch: number, yaw: number, roll: number]
  
  Rotator to compare to
- errorTolerance: number
  
  Maximum total difference
Returns boolean

getForwardVector

getForwardVector(): Vector

- Defined in index.d.ts:349
Return world forward vector rotated by this rotation

Returns Vector

getInverse

getInverse(): Rotator

- Defined in index.d.ts:379
Return the inverse rotation that can reverse the rotation defined by this rotator. For rotations around multiple axis, this is not generally the same as the result from negate.

Returns Rotator

getRightVector

getRightVector(): Vector

- Defined in index.d.ts:353
Return world right vector rotated by this rotation

Returns Vector

getUpVector

getUpVector(): Vector

- Defined in index.d.ts:357
Return world up vector rotated by this rotation

Returns Vector

multiply

multiply(b: number): Rotator

- Defined in index.d.ts:362
Return rotator representing this rotation scaled by b

Parameters
- b: number
  
  Factor to multiply with
Returns Rotator

negate

negate(): Rotator

- Defined in index.d.ts:366
Return negated rotator. For the inverse rotation, use getInverse.

Returns Rotator

rotateVector

rotateVector(v: Vector | [x: number, y: number, z: number]): Vector

- Defined in index.d.ts:370
Return a vector rotated by this rotation

Parameters
- v: Vector | [x: number, y: number, z: number]
Returns Vector

toString

toString(): string

- Defined in index.d.ts:331
Convert to a string in the form 'P= Y= R='

Returns string

toVector

toVector(): Vector

- Defined in index.d.ts:339
Get the X direction vector after this rotation

Returns Vector

unrotateVector

unrotateVector(v: Vector | [x: number, y: number, z: number]): Vector

- Defined in index.d.ts:374
Return a vector rotated by the inverse of this rotation

Parameters
- v: Vector | [x: number, y: number, z: number]
Returns Vector

Static fromAxisAngle

fromAxisAngle(axis: Vector | [x: number, y: number, z: number], angle: number): Rotator

- Defined in index.d.ts:408
Create a rotation from an axis and and angle

Parameters
- axis: Vector | [x: number, y: number, z: number]
  
  The axis to rotate around
- angle: number
  
  The amount of rotation in degrees
Returns Rotator

Static interpolateTo

interpolateTo(current: Rotator | [pitch: number, yaw: number, roll: number], target: Rotator | [pitch: number, yaw: number, roll: number], deltaTime: number, interpSpeed: number): Rotator

- Defined in index.d.ts:387
Smoothly interpolate towards a varying target rotation

Parameters
- current: Rotator | [pitch: number, yaw: number, roll: number]
  
  Current rotation
- target: Rotator | [pitch: number, yaw: number, roll: number]
  
  Target rotation
- deltaTime: number
  
  Time since last tick
- interpSpeed: number
  
  Interpolation speed
Returns Rotator

Static interpolateToConstant

interpolateToConstant(current: Rotator | [pitch: number, yaw: number, roll: number], target: Rotator | [pitch: number, yaw: number, roll: number], deltaTime: number, interpSpeed: number): Rotator

- Defined in index.d.ts:395
Smoothly interpolate towards a varying target rotation at a constant rate

Parameters
- current: Rotator | [pitch: number, yaw: number, roll: number]
  
  Current rotation
- target: Rotator | [pitch: number, yaw: number, roll: number]
  
  Target rotation
- deltaTime: number
  
  Time since last tick
- interpSpeed: number
  
  Interpolation speed
Returns Rotator

Static lerp

lerp(a: Rotator | [pitch: number, yaw: number, roll: number], b: Rotator | [pitch: number, yaw: number, roll: number], alpha: number, bShortestPath: boolean): Rotator

- Defined in index.d.ts:402
Linearly interpolate between a and b based on alpha

Parameters
- a: Rotator | [pitch: number, yaw: number, roll: number]
  
  First rotation
- b: Rotator | [pitch: number, yaw: number, roll: number]
  
  Second rotation
- alpha: number
  
  Result is 100% of a when alpha=0 and 100% of b when alpha=1
- bShortestPath: boolean
Returns Rotator