Class Rotary

constructor

• new Rotary(cos?: number, sin?: number): Rotary

  Creates a rotary from cosine and sine.

  Parameters

  • Optionalcos: number
  • Optionalsin: number

  Returns Rotary

cos

sin

Static ReadonlyIdentity

Static ReadonlyZero

[iterator]

• "[iterator]"(): IterableIterator<number>

  Iterates over rotary components in order.

  Returns IterableIterator<number>

clone

• clone(): Rotary

  Creates a new rotary with the same components.

  Returns Rotary

copy

• copy(v: Rotary): this

  Copies another rotary into this one.

  Parameters

  • v: Rotary

  Returns this

dot

• dot(rotary: Rotary): number

  Computes the dot product with another rotary.

  Parameters

  • rotary: Rotary

  Returns number

equals

• equals(rotary: Rotary): boolean

  Checks component-wise equality.

  Parameters

  • rotary: Rotary

  Returns boolean

magnitude

• magnitude(): number

  Returns the magnitude of this rotary.

  Returns number

magnitudeSquared

• magnitudeSquared(): number

  Returns the squared magnitude of this rotary.

  Returns number

multiply

• multiply(rotary: Rotary): Rotary

  Multiplies this rotary by another.

  Parameters

  • rotary: Rotary

  Returns Rotary

multiplyScalar

• multiplyScalar(scalar: number): Rotary

  Multiplies this rotary by a scalar.

  Parameters

  • scalar: number

  Returns Rotary

normalize

• normalize(): Rotary

  Normalizes this rotary in place.

  Returns Rotary

reverse

• reverse(): Rotary

  Negates the sine component.

  Returns Rotary

rotate

• rotate(angle: number): Rotary

  Rotates this rotary by an angle.

  Parameters

  • angle: number

  Returns Rotary

serialize

• serialize(): RotaryLike

  Serializes this rotary.

  Returns RotaryLike

set

• set(cos: number, sin: number): this

  Sets this rotary from cosine and sine.

  Parameters

  • cos: number
  • sin: number

  Returns this

StaticangleBetween

• angleBetween(a: Rotary, b: Rotary): number

  Returns the angular distance between two rotaries.

  Parameters

  • a: Rotary
  • b: Rotary

  Returns number

Staticcopy

• copy(rotary: Rotary, out?: Rotary): Rotary

  Copies a rotary into an output rotary.

  Parameters

  • rotary: Rotary
  • Optionalout: Rotary

  Returns Rotary

Staticdeserialize

• deserialize(value: RotaryLike, out?: Rotary): Rotary

  Deserializes a rotary from an object.

  Parameters

  • value: RotaryLike
  • Optionalout: Rotary

  Returns Rotary

Staticdot

• dot(a: Rotary, b: Rotary): number

  Computes the dot product between two rotaries.

  Parameters

  • a: Rotary
  • b: Rotary

  Returns number

Staticequal

• equal(rot1: Rotary, rot2: Rotary): boolean

  Checks component-wise equality for two rotaries.

  Parameters

  • rot1: Rotary
  • rot2: Rotary

  Returns boolean

StaticfromAngle

• fromAngle(angle: number, out?: Rotary): Rotary

  Builds a rotary from an angle.

  Parameters

  • angle: number
  • Optionalout: Rotary

  Returns Rotary

StaticfromRotationMatrix

• fromRotationMatrix(matrix: Matrix2, out?: Rotary): Rotary

  Builds a rotary from a rotation matrix.

  Parameters

  • matrix: Matrix2
  • Optionalout: Rotary

  Returns Rotary

StaticfuzzyEqual

• fuzzyEqual(rot1: Rotary, rot2: Rotary, tolerance?: number): boolean

  Checks approximate equality for two rotaries.

  Parameters

  • rot1: Rotary
  • rot2: Rotary
  • Optionaltolerance: number

  Returns boolean

Staticidentity

• identity(out?: Rotary): Rotary

  Writes the identity rotary.

  Parameters

  • Optionalout: Rotary

  Returns Rotary

Staticmagnitude

• magnitude(q: Rotary): number

  Computes the magnitude of a rotary.

  Parameters

  • q: Rotary

  Returns number

StaticmagnitudeSquared

• magnitudeSquared(q: Rotary): number

  Computes the squared magnitude of a rotary.

  Parameters

  • q: Rotary

  Returns number

Staticmultiply

• multiply(rotation1: Rotary, rotation2: Rotary, out?: Rotary): Rotary

  Multiplies two rotaries.

  Parameters

  • rotation1: Rotary
  • rotation2: Rotary
  • Optionalout: Rotary

  Returns Rotary

StaticmultiplyScalar

• multiplyScalar(rotation: Rotary, scalar: number, out?: Rotary): Rotary

  Multiplies a rotary by a scalar.

  Parameters

  • rotation: Rotary
  • scalar: number
  • Optionalout: Rotary

  Returns Rotary

Staticnormalize

• normalize(q: Rotary, out?: Rotary): Rotary

  Normalizes a rotary.

  Parameters

  • q: Rotary
  • Optionalout: Rotary

  Returns Rotary

Staticrandom

• random(): Rotary

  Creates a uniformly random unit rotary.

  Returns Rotary

Staticreverse

• reverse(rotation: Rotary, out?: Rotary): Rotary

  Negates the sine component of a rotary.

  Parameters

  • rotation: Rotary
  • Optionalout: Rotary

  Returns Rotary

Staticrotate

• rotate(angle: number, out?: Rotary): Rotary

  Rotates a rotary by an angle.

  Parameters

  • angle: number
  • Optionalout: Rotary

  Returns Rotary

Staticserialize

• serialize(value: Rotary): RotaryLike

  Serializes a rotary to an object.

  Parameters

  • value: Rotary

  Returns RotaryLike

Staticset

• set(cos: number, sin: number, out?: Rotary): Rotary

  Creates or overwrites a rotary from cosine and sine.

  Parameters

  • cos: number
  • sin: number
  • Optionalout: Rotary

  Returns Rotary

Staticslerp

• slerp(a: Rotary, b: Rotary, t: number, out?: Rotary): Rotary

  Spherically interpolates between two rotaries.

  Parameters

  • a: Rotary
  • b: Rotary
  • t: number
  • Optionalout: Rotary

  Returns Rotary

StatictoAngle

• toAngle(out: Rotary): number

  Converts a rotary to an angle in radians.

  Parameters

  • out: Rotary

  Returns number

StaticvalidateSerial

• validateSerial(value: unknown): value is RotaryLike

  Checks whether a value is a valid rotary serial.

  Parameters

  • value: unknown

  Returns value is RotaryLike

Staticzero

• zero(out?: Rotary): Rotary

  Writes the zero rotary.

  Parameters

  • Optionalout: Rotary

  Returns Rotary