Class ReferenceSpace

A reference space transforms absolute positions to another (global) reference space. The following data can be transformed:

Position coordinates
Linear velocity
Angular velocity
Orientation
Position accuracy

Hierarchy-Diagram

Legend

class

interface

Hierarchy

DataObject
- ReferenceSpace

Implements

TransformationSpace

Constructors

constructor

new ReferenceSpace(parent?): ReferenceSpace
Parameters
- Optional parent: TransformationSpace
Returns ReferenceSpace
Overrides DataObject.constructor
- Defined in src/data/object/space/ReferenceSpace.ts:45

Properties

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

parentUID

parentUID: string

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

parent

get parent(): TransformationSpace
Get the parent space if loaded

Returns TransformationSpace
Transformation space or undefined
Implementation of TransformationSpace.parent
- Defined in src/data/object/space/ReferenceSpace.ts:72
set parent(space): void
Set the parent space
Parameters
- space: TransformationSpace
  
  Parent space
Returns void
Implementation of TransformationSpace.parent
- Defined in src/data/object/space/ReferenceSpace.ts:59

position

get position(): AbsolutePosition
Get the current absolute position of the object relative to the global reference space

Returns AbsolutePosition
Absolute position of data object
Inherited from DataObject.position
- Defined in src/data/object/DataObject.ts:82
set position(position): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
Inherited from DataObject.position
- Defined in src/data/object/DataObject.ts:90

relativePositions

get relativePositions(): RelativePosition<any, Unit>[]
Get relative positions

Returns RelativePosition<any, Unit>[]
Array of relative positions
Inherited from DataObject.relativePositions
- Defined in src/data/object/DataObject.ts:139
set relativePositions(relativePostions): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from DataObject.relativePositions
- Defined in src/data/object/DataObject.ts:151

rotationQuaternion

get rotationQuaternion(): Quaternion
Returns Quaternion
- Defined in src/data/object/space/ReferenceSpace.ts:248
set rotationQuaternion(quaternion): void
Parameters
- quaternion: Quaternion
Returns void
- Defined in src/data/object/space/ReferenceSpace.ts:252

scaleMatrix

get scaleMatrix(): Matrix4
Get the transformation matrix for scaling

Returns Matrix4
Transformation matrix
- Defined in src/data/object/space/ReferenceSpace.ts:240
set scaleMatrix(matrix): void
Parameters
- matrix: Matrix4
Returns void
- Defined in src/data/object/space/ReferenceSpace.ts:244

transformationMatrix

get transformationMatrix(): Matrix4
Returns Matrix4
- Defined in src/data/object/space/ReferenceSpace.ts:228
set transformationMatrix(matrix): void
Parameters
- matrix: Matrix4
Returns void
- Defined in src/data/object/space/ReferenceSpace.ts:232

translationMatrix

get translationMatrix(): Matrix4
Returns Matrix4
- Defined in src/data/object/space/ReferenceSpace.ts:256
set translationMatrix(matrix): void
Parameters
- matrix: Matrix4
Returns void
- Defined in src/data/object/space/ReferenceSpace.ts:260

Methods

addRelativePosition

addRelativePosition(relativePosition): ReferenceSpace
Add a relative position to this data object
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns ReferenceSpace
Data object instance
Inherited from DataObject.addRelativePosition
- Defined in src/data/object/DataObject.ts:177

bind

bind(service): DataObjectBinding<ReferenceSpace>
Bind the data object to a service
Parameters
- service: DataService<string, ReferenceSpace>
  
  Service to bind it to
Returns DataObjectBinding<ReferenceSpace>
Data object binding with a service
Inherited from DataObject.bind
- Defined in src/data/object/DataObject.ts:235

clone

clone<T>(dataType?): T
Clone the data object
Type Parameters
- T extends ReferenceSpace
Parameters
- Optional dataType: Constructor<T>
  
  Data type to clone to
Returns T
Cloned data object
Inherited from DataObject.clone
- Defined in src/data/object/DataObject.ts:244

getPosition

getPosition(referenceSpace?): AbsolutePosition
Get the current absolute position of the object
Parameters
- Optional referenceSpace: TransformationSpace
  
  Reference space to transform it to
Returns AbsolutePosition
Position of the data object
Inherited from DataObject.getPosition
- Defined in src/data/object/DataObject.ts:99

getRelativePosition

getRelativePosition(referenceObjectUID, type?): RelativePosition<any, Unit>
Get relative position of a specified object
Parameters
- referenceObjectUID: string
  
  Reference object identifier
- Optional type: string
  
  Constructor type of the relative position
Returns RelativePosition<any, Unit>
Relative position to reference object
Inherited from DataObject.getRelativePosition
- Defined in src/data/object/DataObject.ts:213

getRelativePositions

getRelativePositions(referenceObjectUID?): RelativePosition<any, Unit>[]
Get relative positions for a different target
Parameters
- Optional referenceObjectUID: string
  
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Array of relative positions for the reference object
Inherited from DataObject.getRelativePositions
- Defined in src/data/object/DataObject.ts:197

hasRelativePosition

hasRelativePosition(referenceObjectUID): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from DataObject.hasRelativePosition
- Defined in src/data/object/DataObject.ts:226

orthographic

orthographic(left, right, bottom, top, near, far): ReferenceSpace
Parameters
- left: number
- right: number
- bottom: number
- top: number
- near: number
- far: number
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:102

perspective

perspective(left, right, bottom, top, near, far): ReferenceSpace
Transform perspective
Parameters
- left: number
  
  Farthest left on the x-axis
- right: number
  
  Farthest right on the x-axis
- bottom: number
  
  Farthest down on the y-axis
- top: number
  
  Farthest up on the y-axis
- near: number
  
  Distance to the near clipping plane along the -Z axis
- far: number
  
  Distance to the far clipping plane along the -Z axis
Returns ReferenceSpace
Reference space instance
- Defined in src/data/object/space/ReferenceSpace.ts:124

referenceUnit

referenceUnit(unit): ReferenceSpace
Parameters
- unit: LengthUnit
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:143

removeRelativePositions

removeRelativePositions(referenceObjectUID): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from DataObject.removeRelativePositions
- Defined in src/data/object/DataObject.ts:168

reset

reset(): ReferenceSpace
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:136

rotation

rotation(r): ReferenceSpace
Parameters
- r: Quaternion
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:160
rotation(r): ReferenceSpace
Parameters
- r: Euler
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:161
rotation(r): ReferenceSpace
Parameters
- r: AxisAngle
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:162
rotation(r): ReferenceSpace
Parameters
- r: {
      pitch: number;
      roll: number;
      unit?: AngleUnit;
      yaw: number;
  }
  - pitch: number
  - roll: number
  - Optional unit?: AngleUnit
  - yaw: number
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:163
rotation(r): ReferenceSpace
Parameters
- r: {
      order?: EulerOrder;
      unit?: AngleUnit;
      x: number;
      y: number;
      z: number;
  }
  - Optional order?: EulerOrder
  - Optional unit?: AngleUnit
  - x: number
  - y: number
  - z: number
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:164
rotation(r): ReferenceSpace
Parameters
- r: number[]
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:165

scale

scale(kX, kY, kZ?): ReferenceSpace
Parameters
- kX: number
- kY: number
- kZ: number = 1.0
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:154

setParent

setParent(object): ReferenceSpace
Set a parent object to the data object
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns ReferenceSpace
instance
Inherited from DataObject.setParent
- Defined in src/data/object/DataObject.ts:163

setPosition

setPosition(position, referenceSpace?): ReferenceSpace
Set the current absolute position of the object
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns ReferenceSpace
Data object instance
Inherited from DataObject.setPosition
- Defined in src/data/object/DataObject.ts:115

setUID

setUID(uid): ReferenceSpace
Set the unique identifier of this object
Parameters
- uid: string
  
  Unique Identifier
Returns ReferenceSpace
Data object instance
Inherited from DataObject.setUID
- Defined in src/data/object/DataObject.ts:129

transform

transform<In, Out>(position, options?): Out
Transform a position
Type Parameters
- In extends AbsolutePosition
- Out extends AbsolutePosition = In
Parameters
- position: In
  
  Position to transform
- Optional options: SpaceTransformationOptions
  
  Transformation options
Returns Out
Transformed position
Implementation of TransformationSpace.transform
- Defined in src/data/object/space/ReferenceSpace.ts:189

translation

translation(dX, dY, dZ?): ReferenceSpace
Parameters
- dX: number
- dY: number
- dZ: number = 0
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:148

update

update(service): Promise<void>
Update parent reference spaces
Parameters
- service: DataService<string, ReferenceSpace>
  
  Service to use for updating
Returns Promise<void>
Update promise
Implementation of TransformationSpace.update
- Defined in src/data/object/space/ReferenceSpace.ts:81

Class ReferenceSpace

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional parent: TransformationSpace

Returns ReferenceSpace

Properties

createdTimestamp

displayName

parentUID

uid

Returns

Accessors

parent

Returns TransformationSpace

Parameters

space: TransformationSpace

Returns void

position

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

rotationQuaternion

Returns Quaternion

Parameters

quaternion: Quaternion

Returns void

scaleMatrix

Returns Matrix4

Parameters

matrix: Matrix4

Returns void

transformationMatrix

Returns Matrix4

Parameters

matrix: Matrix4

Returns void

translationMatrix

Returns Matrix4

Parameters

matrix: Matrix4

Returns void

Methods

addRelativePosition

Parameters

relativePosition: RelativePosition<any, Unit>

Returns ReferenceSpace

bind

Parameters

service: DataService<string, ReferenceSpace>

Returns DataObjectBinding<ReferenceSpace>

clone

Type Parameters

T extends ReferenceSpace

Parameters

Optional dataType: Constructor<T>

Returns T

getPosition

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

getRelativePosition

Parameters

referenceObjectUID: string

Optional type: string

`Optional` parent: TransformationSpace

`Optional` dataType: Constructor<T>

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

r: {
pitch: number;
roll: number;
unit?: AngleUnit;
yaw: number;
}

`Optional` unit?: AngleUnit

r: {
order?: EulerOrder;
unit?: AngleUnit;
x: number;
y: number;
z: number;
}

`Optional` order?: EulerOrder

`Optional` unit?: AngleUnit