Class RelativeOrientation

Relative orientation relative to another object. This indicates the rotation relative to another reference object.

Hierarchy (View Summary)

RelativePosition<Orientation, AngleUnit>
- RelativeOrientation

Index

Constructors

Properties

referenceObjectType referenceObjectUID referenceValue timestamp unit

Accessors

accuracy probability

Methods

clone equals setAccuracy fromQuaternion

Constructors

constructor

new RelativeOrientation(
referenceObject?: any,
orientation?: Orientation,
): RelativeOrientation
Parameters
- OptionalreferenceObject: any
- Optionalorientation: Orientation
Returns RelativeOrientation
Overrides RelativePosition.constructor
- Defined in src/data/position/RelativeOrientation.ts:14

Properties

referenceObjectType

referenceObjectType: string

referenceObjectUID

referenceObjectUID: string

Reference object UID that this location is relative to

referenceValue

referenceValue: Orientation

timestamp

timestamp: number = ...

Position recording timestamp

unit

unit: AngleUnit

Accessors

accuracy

get accuracy(): Accuracy<AngleUnit, any>
Orientation accuracy

Returns Accuracy<AngleUnit, any>
Position accuracy
Overrides RelativePosition.accuracy
- Defined in src/data/position/RelativeOrientation.ts:22
set accuracy(value: Accuracy<AngleUnit, any>): void
Position accuracy
Parameters
- value: Accuracy<AngleUnit, any>
Returns void
Position accuracy
Overrides RelativePosition.accuracy
- Defined in src/data/position/RelativeOrientation.ts:26

probability

get probability(): number
Get the position probability

Returns number
Probability between 0 and 1
Inherited from RelativePosition.probability
- Defined in src/data/position/RelativePosition.ts:49
set probability(value: number): void
Position probability
Parameters
- value: number
Returns void
Inherited from RelativePosition.probability
- Defined in src/data/position/RelativePosition.ts:56

Methods

clone

clone(): this
Clone the position

Returns this
Cloned relative position
Overrides RelativePosition.clone
- Defined in src/data/position/RelativeOrientation.ts:37

equals

equals(position: this): boolean
Check if this position equals another position
Parameters
- position: this
  Other position
Returns boolean
Inherited from RelativePosition.equals
- Defined in src/data/position/RelativePosition.ts:110

setAccuracy

setAccuracy(accuracy: number | Accuracy<AngleUnit, any>, unit?: AngleUnit): this
Set the accuracy of the absolute position
Parameters
- accuracy: number | Accuracy<AngleUnit, any>
  Accuracy object or number
- Optionalunit: AngleUnit
  Optional unit
Returns this
instance
Inherited from RelativePosition.setAccuracy
- Defined in src/data/position/RelativePosition.ts:101

`Static`fromQuaternion

fromQuaternion(quat: Quaternion | Quaternion): Orientation
Parameters
- quat: Quaternion | Quaternion
Returns Orientation
- Defined in src/data/position/RelativeOrientation.ts:33