Class SpheroDataObject<T>

Type Parameters

T extends Core

Hierarchy

DataObject
- SpheroDataObject

Index

Constructors

constructor

new SpheroDataObject<T>(toy: T, uid?: string, displayName?: string): SpheroDataObject<T>
Type Parameters
- T extends Core<T>
Parameters
- toy: T
- Optional uid: string
- Optional displayName: string
Returns SpheroDataObject<T>
Overrides DataObject.constructor
- Defined in src/data/object/SpheroDataObject.ts:8

Properties

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

parentUID

parentUID: string

toy

toy: T

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

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 node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:59
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 node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:64

relativePositions

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

Returns
Array of relative positions

Returns RelativePosition<any, Unit>[]
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:92
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93

Methods

addRelativePosition

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

Returns
Data object instance
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns SpheroDataObject<T>
Inherited from DataObject.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:108

bind

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

Returns
Data object binding with a service
Parameters
- service: DataService<string, SpheroDataObject<T>>
  
  Service to bind it to
Returns DataObjectBinding<SpheroDataObject<T>>
Inherited from DataObject.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:131

clone

clone(): SpheroDataObject<T>
Clone the data object

Returns
Cloned data object

Returns SpheroDataObject<T>
Inherited from DataObject.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:137

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 node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:71

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 node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:123

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 node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:115

hasRelativePosition

hasRelativePosition(referenceObjectUID: string): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from DataObject.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:124

removeRelativePositions

removeRelativePositions(referenceObjectUID: string): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from DataObject.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:101

setParent

setParent(object: string | DataObject): SpheroDataObject<T>
Set a parent object to the data object

Returns
instance
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns SpheroDataObject<T>
Inherited from DataObject.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:100

setPosition

setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): SpheroDataObject<T>
Set the current absolute position of the object

Returns
Data object instance
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns SpheroDataObject<T>
Inherited from DataObject.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:79

setUID

setUID(uid: string): SpheroDataObject<T>
Set the unique identifier of this object

Returns
Data object instance
Parameters
- uid: string
  
  Unique Identifier
Returns SpheroDataObject<T>
Inherited from DataObject.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:86

`Static` findSpheroMini

findSpheroMini(): Promise<SpheroDataObject<SpheroMini>>
Returns Promise<SpheroDataObject<SpheroMini>>
- Defined in src/data/object/SpheroDataObject.ts:13

Class SpheroDataObject<T>

Type Parameters

T extends Core

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Core<T>

Parameters

toy: T

Optional uid: string

Optional displayName: string

Returns SpheroDataObject<T>

Properties

createdTimestamp

displayName

parentUID

toy

uid

Returns

Accessors

position

Returns

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

Methods

addRelativePosition

Returns

Parameters

relativePosition: RelativePosition<any, Unit>

Returns SpheroDataObject<T>

bind

Returns

Parameters

service: DataService<string, SpheroDataObject<T>>

Returns DataObjectBinding<SpheroDataObject<T>>

clone

Returns

Returns SpheroDataObject<T>

getPosition

Returns

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

getRelativePosition

Returns

Parameters

referenceObjectUID: string

Optional type: string

Returns RelativePosition<any, Unit>

getRelativePositions

Returns

Parameters

Optional referenceObjectUID: string

Returns RelativePosition<any, Unit>[]

hasRelativePosition

Parameters

referenceObjectUID: string

Returns boolean

removeRelativePositions

Parameters

referenceObjectUID: string

Returns void

setParent

Returns

Parameters

object: string | DataObject

`Optional` uid: string

`Optional` displayName: string

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

`Optional` referenceSpace: TransformationSpace

`Static` findSpheroMini