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 (View Summary)

DataObject
- ReferenceSpace

Implements

TransformationSpace

Constructors

constructor

new ReferenceSpace(parent?: TransformationSpace): ReferenceSpace
Parameters
- Optionalparent: 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

angularVelocity

get angularVelocity(): AngularVelocity
Returns AngularVelocity
Inherited from DataObject.angularVelocity
- Defined in src/data/object/DataObject.ts:142
set angularVelocity(velocity: AngularVelocity): void
Parameters
- velocity: AngularVelocity
Returns void
Inherited from DataObject.angularVelocity
- Defined in src/data/object/DataObject.ts:146

linearVelocity

get linearVelocity(): LinearVelocity
Returns LinearVelocity
Inherited from DataObject.linearVelocity
- Defined in src/data/object/DataObject.ts:132
set linearVelocity(velocity: LinearVelocity): void
Parameters
- velocity: LinearVelocity
Returns void
Inherited from DataObject.linearVelocity
- Defined in src/data/object/DataObject.ts:136

orientation

get orientation(): Orientation
Get the orientation of the object relative to the global reference space

Returns Orientation
Inherited from DataObject.orientation
- Defined in src/data/object/DataObject.ts:108
set orientation(orientation: Orientation): void
Set the orientation of the object relative to the global reference space
Parameters
- orientation: Orientation
Returns void
Inherited from DataObject.orientation
- Defined in src/data/object/DataObject.ts:116

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:89
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:76

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:92
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:100

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:197
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:209

rotationQuaternion

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

scaleMatrix

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

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

transformationMatrix

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

translationMatrix

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

velocity

get velocity(): Velocity
Returns Velocity
Inherited from DataObject.velocity
- Defined in src/data/object/DataObject.ts:122
set velocity(velocity: Velocity): void
Parameters
- velocity: Velocity
Returns void
Inherited from DataObject.velocity
- Defined in src/data/object/DataObject.ts:126

Methods

addRelativePosition

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

bind

bind(
service: DataService<string, ReferenceSpace>,
): 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:293

clone

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

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object
Parameters
- OptionalreferenceSpace: 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:157

getRelativePosition

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

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target
Parameters
- OptionalreferenceObjectUID: 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:255

hasRelativePosition

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

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:119

perspective

perspective(
    left: number,
    right: number,
    bottom: number,
    top: number,
    near: number,
    far: number,
): 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:141

referenceUnit

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

removeRelativePositions

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

reset

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

rotation

rotation(r: Quaternion): ReferenceSpace
Parameters
- r: Quaternion
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:177
rotation(r: Euler): ReferenceSpace
Parameters
- r: Euler
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:178
rotation(r: AxisAngle): ReferenceSpace
Parameters
- r: AxisAngle
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:179
rotation(
r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number },
): ReferenceSpace
Parameters
- r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number }
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:180
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 }
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:181
rotation(r: number[]): ReferenceSpace
Parameters
- r: number[]
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:182

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:171

setParent

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

setPosition

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

setUID

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

transform

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

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:165

update

update(service: DataService<string, ReferenceSpace>): 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:98

`Static`fromDataObject

fromDataObject(object: DataObject): ReferenceSpace
Create a reference space from another object
Parameters
- object: DataObject
  Reference space
Returns ReferenceSpace
- Defined in src/data/object/space/ReferenceSpace.ts:59

Class ReferenceSpace

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ReferenceSpace

Properties

createdTimestamp

displayName

parentUID

uid

Returns

Accessors

angularVelocity

Returns AngularVelocity

Parameters

Returns void

linearVelocity

Returns LinearVelocity

Parameters

Returns void

orientation

Returns Orientation

Parameters

Returns void

parent

Returns TransformationSpace

Parameters

Returns void

position

Returns AbsolutePosition

Parameters

Returns void

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

Returns void

rotationQuaternion

Returns Quaternion

Parameters

Returns void

scaleMatrix

Returns Matrix4

Parameters

Returns void

transformationMatrix

Returns Matrix4

Parameters

Returns void

translationMatrix

Returns Matrix4

Parameters

Returns void

velocity

Returns Velocity

Parameters

Returns void

Methods

addRelativePosition

Parameters

Returns this

bind

Parameters

Returns DataObjectBinding<ReferenceSpace>

clone

Type Parameters

Parameters

Returns T

getPosition

Parameters

Returns AbsolutePosition

getRelativePosition

Parameters

Returns RelativePosition<any>

`Static`fromDataObject