Class AbsolutePositionAbstract

constructor

• new AbsolutePosition(): AbsolutePosition

• Returns AbsolutePosition

orientation

referenceSpaceUID

timestamp

unit

velocity

accuracy

• get accuracy(): Accuracy<LengthUnit, any>

• Position accuracy

  Returns Accuracy<LengthUnit, any>

  Position accuracy
• set accuracy(value): void

• Position accuracy

  Parameters

  • value: Accuracy<LengthUnit, any>

  Returns void

angularVelocity

• get angularVelocity(): AngularVelocity

• Get the angular velocity

  Returns AngularVelocity

  Angular velocity
• set angularVelocity(value): void

• Set the angular velocity

  Parameters

  • value: AngularVelocity

  Returns void

linearVelocity

• get linearVelocity(): LinearVelocity

• Get the linear velocity

  Returns LinearVelocity

  Linear velocity
• set linearVelocity(value): void

• Set the linear velocity

  Parameters

  • value: LinearVelocity

  Returns void

probability

• get probability(): number

• Get the position probability

  Returns number

  Probability between 0 and 1
• set probability(value): void

• Position probability

  Parameters

  • value: number

  Returns void

Abstract angleTo

• angleTo(destination): number

• Get the angle in radians from this position to a destination

  Parameters

  • destination: AbsolutePosition

    Destination position

  Returns number

  Bearing in radians from this position to destination

clone

• clone(): AbsolutePosition

• Clone the position

  Returns AbsolutePosition

  Cloned position

distanceTo

• distanceTo(destination, distanceFunction?): number

• Get the distance from this location to a destination

  Parameters

  • destination: AbsolutePosition

    Destination location

  • Optional distanceFunction: DistanceFn = EUCLIDEAN

    Distance function to use (default EUCLIDEAN distance)

  Returns number

  Distance between this point and destination

equals

• equals(position): boolean

• Check if this position equals another position

  Parameters

  • position: AbsolutePosition

    Other position

  Returns boolean

Abstract fromVector

• fromVector(vector, unit?): AbsolutePosition

• Parameters

  • vector: Vector3

  • Optional unit: LengthUnit

  Returns AbsolutePosition

setAccuracy

• setAccuracy(accuracy, unit?): AbsolutePosition

• Set the accuracy of the absolute position

  Parameters

  • accuracy: number | Accuracy<LengthUnit, any>

    Accuracy object or number

  • Optional unit: Unit

    Optional unit

  Returns AbsolutePosition

  instance

Abstract toVector3

• toVector3(unit?): Vector3

• Parameters

  • Optional unit: LengthUnit

  Returns Vector3