Class AbsolutePositionAbstract
Hierarchy-Diagram
Legend
class
abstract class
interface
Hierarchy
- AbsolutePosition
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Absolute Position(): AbsolutePosition -
Returns AbsolutePosition
Properties
orientation
Orientation at recorded position
reference
Position reference space UID
timestamp
Position recording timestamp
unit
Position unit
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
-
Methods
Abstract angle
- angle
To(destination: AbsolutePosition): number -
Get the angle in radians from this position to a destination
Returns
Bearing in radians from this position to destination
Parameters
-
destination: AbsolutePosition
Destination position
Returns number
-
clone
- clone(): AbsolutePosition
-
Clone the position
Returns
Cloned position
Returns AbsolutePosition
distance
- distance
To(destination: AbsolutePosition, distanceFunction??: DistanceFn): number -
Get the distance from this location to a destination
Returns
Distance between this point and destination
Parameters
-
destination: AbsolutePosition
Destination location
-
OptionaldistanceFunction: DistanceFn = EUCLIDEANDistance function to use (default EUCLIDEAN distance)
Returns number
-
equals
- equals(position: AbsolutePosition): boolean
-
Check if this position equals another position
Parameters
-
position: AbsolutePosition
Other position
Returns boolean
-
Abstract from
- from
Vector(vector: Vector3, unit?: LengthUnit): AbsolutePosition -
Parameters
-
vector: Vector3
-
Optionalunit: LengthUnit
Returns AbsolutePosition
-
set
- set
Accuracy(accuracy: number | Accuracy<LengthUnit, any>, unit?: Unit): AbsolutePosition -
Set the accuracy of the absolute position
Returns
instance
Parameters
-
accuracy: number | Accuracy<LengthUnit, any>
Accuracy object or number
-
Optionalunit: UnitOptional unit
Returns AbsolutePosition
-
Abstract to
- to
Vector3(unit?: LengthUnit): Vector3 -
Parameters
-
Optionalunit: LengthUnit
Returns Vector3
-
An absolute position of a DataObject.