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?: TransformationSpace): 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
Transformation space or undefined

Returns TransformationSpace
Implementation of TransformationSpace.parent
- Defined in src/data/object/space/ReferenceSpace.ts:74
set parent(space: TransformationSpace): void
Set the parent space
Parameters
- space: TransformationSpace
  
  Parent space
Returns void
Implementation of TransformationSpace.parent
- Defined in src/data/object/space/ReferenceSpace.ts:60

position

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

Returns
Absolute position of data object

Returns AbsolutePosition
Inherited from DataObject.position
- Defined in src/data/object/DataObject.ts:85
set position(position: AbsolutePosition): 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:94

relativePositions

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

Returns
Array of relative positions

Returns RelativePosition<any, Unit>[]
Inherited from DataObject.relativePositions
- Defined in src/data/object/DataObject.ts:146
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from DataObject.relativePositions
- Defined in src/data/object/DataObject.ts:159

rotationQuaternion

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

scaleMatrix

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

Returns
Transformation matrix

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

transformationMatrix

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

translationMatrix

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

Methods

addRelativePosition

addRelativePosition(relativePosition: RelativePosition<any, Unit>): ReferenceSpace
Add a relative position to this data object

Returns
Data object instance
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns ReferenceSpace
Inherited from DataObject.addRelativePosition
- Defined in src/data/object/DataObject.ts:187

bind

bind(service: DataService<string, ReferenceSpace>): DataObjectBinding<ReferenceSpace>
Bind the data object to a service

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

clone

clone<T>(dataType?: Constructor<T>): T
Clone the data object

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

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object

Returns
Position of the data object
Parameters
- Optional referenceSpace: TransformationSpace
  
  Reference space to transform it to
Returns AbsolutePosition
Inherited from DataObject.getPosition
- Defined in src/data/object/DataObject.ts:104

getRelativePosition

getRelativePosition(referenceObjectUID: string, type?: string): RelativePosition<any, Unit>
Get relative position of a specified object

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

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target

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

hasRelativePosition

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

orthographic

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

perspective

perspective(left: number, right: number, bottom: number, top: number, near: number, far: number): ReferenceSpace
Transform perspective

Returns
Reference space instance
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
- Defined in src/data/object/space/ReferenceSpace.ts:128

referenceUnit

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

removeRelativePositions

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

reset

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

rotation

rotation(r: Quaternion): ReferenceSpace
Parameters
- r: Quaternion
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:164
rotation(r: Euler): ReferenceSpace
Parameters
- r: Euler
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:165
rotation(r: AxisAngle): ReferenceSpace
Parameters
- r: AxisAngle
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:166
rotation(r: {
    pitch: number;
    roll: number;
    unit?: AngleUnit;
    yaw: number;
}): 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:167
rotation(r: {
    order?: EulerOrder;
    unit?: AngleUnit;
    x: number;
    y: number;
    z: number;
}): 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:168
rotation(r: number[]): ReferenceSpace
Parameters
- r: number[]
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:169

scale

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

setParent

setParent(object: string | DataObject): ReferenceSpace
Set a parent object to the data object

Returns
instance
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns ReferenceSpace
Inherited from DataObject.setParent
- Defined in src/data/object/DataObject.ts:172

setPosition

setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): ReferenceSpace
Set the current absolute position of the object

Returns
Data object instance
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns ReferenceSpace
Inherited from DataObject.setPosition
- Defined in src/data/object/DataObject.ts:121

setUID

setUID(uid: string): ReferenceSpace
Set the unique identifier of this object

Returns
Data object instance
Parameters
- uid: string
  
  Unique Identifier
Returns ReferenceSpace
Inherited from DataObject.setUID
- Defined in src/data/object/DataObject.ts:136

transform

transform<In, Out>(position: In, options?: SpaceTransformationOptions): Out
Transform a position

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

translation

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

update

update(service: DataService<string, ReferenceSpace>): Promise<void>
Update parent reference spaces

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

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

Returns TransformationSpace

Parameters

space: TransformationSpace

Returns void

position

Returns

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

rotationQuaternion

Returns Quaternion

Parameters

quaternion: Quaternion

Returns void

scaleMatrix

Returns

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

Returns

Parameters

relativePosition: RelativePosition<any, Unit>

Returns ReferenceSpace

bind

Returns

Parameters

service: DataService<string, ReferenceSpace>

Returns DataObjectBinding<ReferenceSpace>

clone

Returns

Type Parameters

T extends ReferenceSpace<T>

Parameters

Optional dataType: Constructor<T>

Returns T

getPosition

`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