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: Accuracy<LengthUnit, any>): 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: AngularVelocity): 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: LinearVelocity): 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: number): void

  Position probability

  Parameters

  • value: number

  Returns void

AbstractangleTo

• angleTo(destination: this): number

  Get the angle in radians from this position to a destination

  Parameters

  • destination: this

    Destination position

  Returns number

  Bearing in radians from this position to destination

clone

• clone(): this

  Clone the position

  Returns this

  Cloned position

distanceTo

• distanceTo(destination: this, distanceFunction?: DistanceFn): number

  Get the distance from this location to a destination

  Parameters

  • destination: this

    Destination location

  • OptionaldistanceFunction: DistanceFn = EUCLIDEAN

    Distance function to use (default EUCLIDEAN distance)

  Returns number

  Distance between this point and destination

equals

• equals(position: this): boolean

  Check if this position equals another position

  Parameters

  • position: this

    Other position

  Returns boolean

AbstractfromVector

• fromVector(vector: Vector3, unit?: LengthUnit): this

  Parameters

  • vector: Vector3
  • Optionalunit: LengthUnit

  Returns this

setAccuracy

• setAccuracy(accuracy: number | Accuracy<LengthUnit, any>, unit?: Unit): this

  Set the accuracy of the absolute position

  Parameters

  • accuracy: number | Accuracy<LengthUnit, any>

    Accuracy object or number

  • Optionalunit: Unit

    Optional unit

  Returns this

  instance

setOrientation

• setOrientation(orientation: Orientation): this

  Set the orientation of the position

  Parameters

  • orientation: Orientation

    orientation

  Returns this

  instance

AbstracttoVector3

• toVector3(unit?: LengthUnit): Vector3

  Parameters

  • Optionalunit: LengthUnit

  Returns Vector3