Hierarchy

  • RelativePosition<number, Unit>
    • RelativeValue

Constructors

  • Parameters

    • Optional referenceObject: any
    • Optional value: number
    • Optional unit: Unit

    Returns RelativeValue

Properties

referenceObjectType: string
referenceObjectUID: string

Reference object UID that this location is relative to

referenceValue: number
timestamp: number

Position recording timestamp

unit: Unit

Accessors

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

    Returns Accuracy<U, any>

    Position accuracy

  • set accuracy(value): void
  • Parameters

    • value: Accuracy<U, any>

    Returns void

  • get probability(): number
  • Get the position probability

    Returns number

    Probability between 0 and 1

  • set probability(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Clone the position

    Returns this

    Cloned relative position

  • Parameters

    • position: this

    Returns boolean

  • Set the accuracy of the absolute position

    Parameters

    • accuracy: number | Accuracy<Unit, any>

      Accuracy object or number

    • Optional unit: Unit

      Optional unit

    Returns this

    instance