Class RelativeDistance
Hierarchy-Diagram
Legend
class
Hierarchy
- RelativePosition<number, LengthUnit>
- RelativeDistance
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Relative Distance(referenceObject?: any, distance?: number, distanceUnit?: LengthUnit): RelativeDistance -
Parameters
-
OptionalreferenceObject: any -
Optionaldistance: number -
OptionaldistanceUnit: LengthUnit
Returns RelativeDistance
-
Properties
distance
Distance unit
reference
reference
reference
reference
Reference object UID that this location is relative to
reference
reference
timestamp
timestamp: number = ...
Position recording timestamp
Accessors
accuracy
distance
- get distance(): number
-
Distance to reference object
Returns
Distance
Returns number
- set distance(value: number): void
-
Parameters
-
value: number
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
clone
- clone(): RelativeDistance
-
Clone the position
Returns
Cloned relative position
Returns RelativeDistance
equals
- equals(position: RelativeDistance): boolean
-
Check if this position equals another position
Parameters
-
position: RelativeDistance
Other position
Returns boolean
-
set
- set
Accuracy(accuracy: number | Accuracy<LengthUnit, any>, unit?: LengthUnit): RelativeDistance -
Set the accuracy of the absolute position
Returns
instance
Parameters
-
accuracy: number | Accuracy<LengthUnit, any>
Accuracy object or number
-
Optionalunit: LengthUnitOptional unit
Returns RelativeDistance
-
Relative location to another reference object in distance.