Class RelativePosition<T, U>
Type Parameters
Hierarchy-Diagram
Legend
class
interface
Hierarchy
- RelativePosition
Implements
- Position<U>
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Relative Position<T, U>(referenceObject?, value?, unit?): RelativePosition<T, U> -
Type Parameters
Parameters
-
OptionalreferenceObject: any -
Optionalvalue: T -
Optionalunit: U
Returns RelativePosition<T, U>
-
Properties
reference
reference
reference
reference
Reference object UID that this location is relative to
reference
reference
timestamp
timestamp: number = ...
Position recording timestamp
unit
unit: U
Accessors
accuracy
probability
- get probability(): number
-
Get the position probability
Returns number
Probability between 0 and 1
- set probability(value): void
-
Position probability
Parameters
-
value: number
Returns void
-
Methods
clone
- clone(): RelativePosition<T, U>
-
Clone the position
Returns RelativePosition<T, U>
Cloned relative position
equals
- equals(position): boolean
-
Check if this position equals another position
Parameters
-
position: RelativePosition<T, U>
Other position
Returns boolean
-
set
- set
Accuracy(accuracy, unit?): RelativePosition<T, U> -
Set the accuracy of the absolute position
Parameters
-
accuracy: number | Accuracy<U, any>
Accuracy object or number
-
Optionalunit: UOptional unit
Returns RelativePosition<T, U>
instance
-
Relative position to another reference object or space.