@openhps/geospatial
    Preparing search index...

    Class AbstractLocation

    An abstract location is identified by a unique identifier (UID). It generates a random location based on the UID allowing it to be used in fingerprinting algorithms.

    Hierarchy

    • Absolute2DPosition
      • AbstractLocation
    Index
    orientation: Orientation

    Orientation at recorded position

    referenceSpaceUID: string

    Position reference space UID

    timestamp: number

    Position recording timestamp

    unit: LengthUnit

    Position unit

    vector: Vector3
    velocity: Velocity

    Velocity at recorded position

    • 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

    • 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

    • 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

    • 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

    • get x(): number

      Returns number

    • set x(value: number): void

      Parameters

      • value: number

      Returns void

    • get y(): number

      Returns number

    • set y(value: number): void

      Parameters

      • value: number

      Returns void

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

      Parameters

      • destination: Absolute2DPosition

        Destination position

      Returns number

      Bearing in radians from this position to destination

    • Clone the position

      Returns this

      Cloned position

    • Get the distance from this location to a destination

      Parameters

      • destination: this

        Destination location

      • OptionaldistanceFunction: DistanceFn

        Distance function to use (default EUCLIDEAN distance)

      Returns number

      Distance between this point and destination

    • Check if this position equals another position

      Parameters

      • position: this

        Other position

      Returns boolean

    • Parameters

      • vector: Vector3 | Vector2
      • Optionalunit: LengthUnit

      Returns 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

    • Set the orientation of the position

      Parameters

      • orientation: Orientation

        orientation

      Returns this

      instance

    • Parameters

      • Optionalunit: LengthUnit

      Returns Vector3