Class RelativePosition<T, U>

constructor

• new RelativePosition<T, U>(referenceObject?, value?, unit?): RelativePosition<T, U>

• Type Parameters

  • T = number

  • U extends Unit = Unit

  Parameters

  • Optional referenceObject: any

  • Optional value: T

  • Optional unit: U

  Returns RelativePosition<T, U>

referenceObjectType

referenceObjectUID

referenceValue

timestamp

unit

accuracy

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

• Position accuracy

  Returns Accuracy<U, any>

  Position accuracy
• set accuracy(value): void

• Position accuracy

  Parameters

  • value: Accuracy<U, any>

  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

clone

• clone(): this

• Clone the position

  Returns this

  Cloned relative position

equals

• equals(position): boolean

• Check if this position equals another position

  Parameters

  • position: this

    Other position

  Returns boolean

setAccuracy

• setAccuracy(accuracy, unit?): this

• Set the accuracy of the absolute position

  Parameters

  • accuracy: number | Accuracy<U, any>

    Accuracy object or number

  • Optional unit: U

    Optional unit

  Returns this

  instance