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

Constructors

constructor

Properties

orientation referenceSpaceUID timestamp unit vector velocity

Accessors

accuracy angularVelocity linearVelocity probability uid x y

Methods

angleTo clone distanceTo equals fromVector hashCode setAccuracy setOrientation toVector3

Constructors

constructor

Properties

orientation

orientation: Orientation

Orientation at recorded position

referenceSpaceUID

referenceSpaceUID: string

Position reference space UID

timestamp

timestamp: number

Position recording timestamp

unit

unit: LengthUnit

Position unit

Protected vector

vector: Vector3

velocity

velocity: Velocity

Velocity at recorded position

Accessors

accuracy

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

  • Position accuracy

    Returns Accuracy<LengthUnit, any>

    Position accuracy

  • set accuracy(value): void

  • Parameters

    • value: Accuracy<LengthUnit, any>

    Returns void

angularVelocity

  • get angularVelocity(): AngularVelocity

  • Get the angular velocity

    Returns AngularVelocity

    Angular velocity

  • set angularVelocity(value): 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): 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): void

  • Parameters

    • value: number

    Returns void

uid

x

  • get x(): number

  • Returns number

  • set x(value): void

  • Parameters

    • value: number

    Returns void

y

  • get y(): number

  • Returns number

  • set y(value): void

  • Parameters

    • value: number

    Returns void

Methods

angleTo

  • angleTo(destination): number

  • 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

  • clone(): this

  • Clone the position

    Returns this

    Cloned position

distanceTo

  • distanceTo(destination, distanceFunction?): number

  • Get the distance from this location to a destination

    Parameters

    • destination: this

      Destination location

    • Optional distanceFunction: DistanceFn

      Distance function to use (default EUCLIDEAN distance)

    Returns number

    Distance between this point and destination

equals

  • equals(position): boolean

  • Parameters

    • position: this

    Returns boolean

fromVector

  • fromVector(vector, unit?): this

  • Parameters

    • vector: Vector3 | Vector2
    • Optional unit: LengthUnit

    Returns this

hashCode

setAccuracy

  • setAccuracy(accuracy, unit?): this

  • Set the accuracy of the absolute position

    Parameters

    • accuracy: number | Accuracy<LengthUnit, any>

      Accuracy object or number

    • Optional unit: Unit

      Optional unit

    Returns this

    instance

setOrientation

  • setOrientation(orientation): this

  • Set the orientation of the position

    Parameters

    • orientation: Orientation

      orientation

    Returns this

    instance

toVector3

  • toVector3(unit?): Vector3

  • Parameters

    • Optional unit: LengthUnit

    Returns Vector3

Settings

Member Visibility

Theme

On This Page

constructororientationreferenceSpaceUIDtimestampunitvectorvelocityaccuracyangularVelocitylinearVelocityprobabilityuidxyangleToclonedistanceToequalsfromVectorhashCodesetAccuracysetOrientationtoVector3