Class RelativeAngle
Hierarchy-Diagram
Legend
class
Hierarchy
- RelativePosition<number, AngleUnit>
- RelativeAngle
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Relative Angle(referenceObject?: any, angle?: number, angleUnit?: AngleUnit, orientation?: Orientation): RelativeAngle -
Parameters
-
OptionalreferenceObject: any -
Optionalangle: number -
OptionalangleUnit: AngleUnit -
Optionalorientation: Orientation
Returns RelativeAngle
-
Properties
angle
Angle unit
orientation
Orientation at recorded position
reference
reference
reference
reference
Reference object UID that this location is relative to
reference
reference
timestamp
timestamp: number = ...
Position recording timestamp
Accessors
accuracy
angle
- get angle(): number
-
Angle to reference object
Returns
Angle
Returns number
- set angle(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(): RelativeAngle
-
Clone the position
Returns
Cloned relative position
Returns RelativeAngle
equals
- equals(position: RelativeAngle): boolean
-
Check if this position equals another position
Parameters
-
position: RelativeAngle
Other position
Returns boolean
-
set
- set
Accuracy(accuracy: number | Accuracy<AngleUnit, any>, unit?: AngleUnit): RelativeAngle -
Set the accuracy of the absolute position
Returns
instance
Parameters
Returns RelativeAngle
Relative location to another reference object measured in the angle.