Class Absolute2DPosition
Hierarchy-Diagram
Legend
class
abstract class
Hierarchy
- AbsolutePosition
- Absolute2DPosition
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Absolute2DPosition(x?: number, y?: number, unit?: LengthUnit): Absolute2DPosition -
Parameters
-
Optionalx: number -
Optionaly: number -
unit: LengthUnit = LengthUnit.METER
Returns Absolute2DPosition
-
Properties
orientation
Orientation at recorded position
reference
Position reference space UID
timestamp
Position recording timestamp
unit
Position unit
Protected vector
velocity
Velocity at recorded position
Accessors
accuracy
- get accuracy(): Accuracy<LengthUnit, any>
-
Position accuracy
Returns
Position accuracy
Returns Accuracy<LengthUnit, any>
- set accuracy(value: Accuracy<LengthUnit, any>): void
-
Position accuracy
Parameters
-
value: Accuracy<LengthUnit, any>
Returns void
-
angular
- get angularVelocity(): AngularVelocity
-
Get the angular velocity
Returns
Angular velocity
Returns AngularVelocity
- set angularVelocity(value: AngularVelocity): void
-
Set the angular velocity
Parameters
-
value: AngularVelocity
Returns void
-
linear
- get linearVelocity(): LinearVelocity
-
Get the linear velocity
Returns
Linear velocity
Returns LinearVelocity
- set linearVelocity(value: LinearVelocity): void
-
Set the linear velocity
Parameters
-
value: LinearVelocity
Returns void
-
probability
- get probability(): number
-
Get the position probability
Returns
Probability between 0 and 1
Returns number
- set probability(value: number): void
-
Position probability
Parameters
-
value: number
Returns void
-
x
- get x(): number
-
Returns number
- set x(value: number): void
-
Parameters
-
value: number
Returns void
-
y
- get y(): number
-
Returns number
- set y(value: number): void
-
Parameters
-
value: number
Returns void
-
Methods
angle
- angle
To(destination: Absolute2DPosition): number -
Get the angle in radians from this position to a destination
Returns
Bearing in radians from this position to destination
Parameters
-
destination: Absolute2DPosition
Destination position
Returns number
-
clone
- clone(): Absolute2DPosition
-
Clone the position
Returns
Cloned position
Returns Absolute2DPosition
distance
- distance
To(destination: Absolute2DPosition, distanceFunction??: DistanceFn): number -
Get the distance from this location to a destination
Returns
Distance between this point and destination
Parameters
-
destination: Absolute2DPosition
Destination location
-
OptionaldistanceFunction: DistanceFn = EUCLIDEANDistance function to use (default EUCLIDEAN distance)
Returns number
-
equals
- equals(position: Absolute2DPosition): boolean
-
Check if this position equals another position
Parameters
-
position: Absolute2DPosition
Other position
Returns boolean
-
from
- from
Vector(vector: Vector3 | Vector2, unit?: LengthUnit): Absolute2DPosition -
Parameters
-
vector: Vector3 | Vector2
-
Optionalunit: LengthUnit
Returns Absolute2DPosition
-
set
- set
Accuracy(accuracy: number | Accuracy<LengthUnit, any>, unit?: Unit): Absolute2DPosition -
Set the accuracy of the absolute position
Returns
instance
Parameters
-
accuracy: number | Accuracy<LengthUnit, any>
Accuracy object or number
-
Optionalunit: UnitOptional unit
Returns Absolute2DPosition
-
to
- to
Vector3(unit?: LengthUnit): Vector3 -
Parameters
-
Optionalunit: LengthUnit
Returns Vector3
-
Absolute cartesian 2D position. This class uses a Vector2. This location can be used both as an absolute location or relative location.