Class RelativePosition<T, U>

constructor

• new RelativePosition<T = number, U extends Unit = Unit>(
      referenceObject?: any,
      value?: T,
      unit?: U,
  ): RelativePosition<T, U>

  Type Parameters

  • T = number
  • U extends Unit = Unit

  Parameters

  • OptionalreferenceObject: any
  • Optionalvalue: T
  • Optionalunit: 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: Accuracy<U, any>): 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: number): void

  Position probability

  Parameters

  • value: number

  Returns void

clone

• clone(): this

  Clone the position

  Returns this

  Cloned relative position

equals

• equals(position: this): boolean

  Check if this position equals another position

  Parameters

  • position: this

    Other position

  Returns boolean

setAccuracy

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

  Set the accuracy of the absolute position

  Parameters

  • accuracy: number | Accuracy<U, any>

    Accuracy object or number

  • Optionalunit: U

    Optional unit

  Returns this

  instance