Class DataObject

Hierarchy (view full)

DataObject

Index

Constructors

constructor

new DataObject(uid?, displayName?): DataObject
Create a new data object
Parameters
- uid: string = ...
  Optional unique identifier
- Optional displayName: string
  Optional display name
Returns DataObject
- Defined in src/data/object/DataObject.ts:80

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
- Defined in src/data/object/DataObject.ts:142
set angularVelocity(velocity): void
Parameters
- velocity: AngularVelocity
Returns void
- Defined in src/data/object/DataObject.ts:146

linearVelocity

get linearVelocity(): LinearVelocity
Returns LinearVelocity
- Defined in src/data/object/DataObject.ts:132
set linearVelocity(velocity): void
Parameters
- velocity: LinearVelocity
Returns void
- 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
- Defined in src/data/object/DataObject.ts:108
set orientation(orientation): void
Set the orientation of the object relative to the global reference space
Parameters
- orientation: Orientation
Returns void
- Defined in src/data/object/DataObject.ts:116

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
- Defined in src/data/object/DataObject.ts:92
set position(position): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
- 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
- Defined in src/data/object/DataObject.ts:197
set relativePositions(relativePostions): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
- Defined in src/data/object/DataObject.ts:209

velocity

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

Methods

addRelativePosition

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

bind

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

clone

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

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
- Defined in src/data/object/DataObject.ts:157

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
- Defined in src/data/object/DataObject.ts:271

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
- Defined in src/data/object/DataObject.ts:255

hasRelativePosition

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

removeRelativePositions

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

setParent

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

setPosition

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

setUID

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