Interface RFObject

interface RFObject {
    createdTimestamp: number;
    displayName: string;
    parentUID: string;
    uid: string;
    angularVelocity: AngularVelocity;
    linearVelocity: LinearVelocity;
    orientation: Orientation;
    position: AbsolutePosition;
    relativePositions: RelativePosition<any, Unit>[];
    velocity: Velocity;
    addRelativePosition(relativePosition): this;
    bind(service): DataObjectBinding<RFObject>;
    clone<T>(dataType?): T;
    getPosition(referenceSpace?): AbsolutePosition;
    getRelativePosition(referenceObjectUID, type?): RelativePosition<any, Unit>;
    getRelativePositions(referenceObjectUID?): RelativePosition<any, Unit>[];
    hasRelativePosition(referenceObjectUID): boolean;
    removeRelativePositions(referenceObjectUID): void;
    setParent(object): this;
    setPosition(position, referenceSpace?): this;
    setUID(uid): this;
}

Hierarchy

  • DataObject
    • RFObject

Implemented by

Properties

createdTimestamp displayName parentUID uid

Accessors

angularVelocity linearVelocity orientation position relativePositions velocity

Methods

addRelativePosition bind clone getPosition getRelativePosition getRelativePositions hasRelativePosition removeRelativePositions setParent setPosition setUID

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

  • set angularVelocity(velocity): void

  • Parameters

    • velocity: AngularVelocity

    Returns void

linearVelocity

  • get linearVelocity(): LinearVelocity

  • Returns LinearVelocity

  • set linearVelocity(velocity): void

  • Parameters

    • velocity: LinearVelocity

    Returns void

orientation

  • get orientation(): Orientation

  • Get the orientation of the object relative to the global reference space

    Returns Orientation

  • set orientation(orientation): void

  • Set the orientation of the object relative to the global reference space

    Parameters

    • orientation: Orientation

    Returns void

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

  • set position(position): void

  • Set the current absolute position of the object relative to the global reference space

    Parameters

    • position: AbsolutePosition

    Returns void

relativePositions

  • get relativePositions(): RelativePosition<any, Unit>[]

  • Get relative positions

    Returns RelativePosition<any, Unit>[]

    Array of relative positions

  • set relativePositions(relativePostions): void

  • Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

velocity

  • get velocity(): Velocity

  • Returns Velocity

  • set velocity(velocity): void

  • Parameters

    • velocity: Velocity

    Returns void

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

bind

  • bind(service): DataObjectBinding<RFObject>

  • Bind the data object to a service

    Parameters

    • service: DataService<string, RFObject>

      Service to bind it to

    Returns DataObjectBinding<RFObject>

    Data object binding with a service

clone

  • clone<T>(dataType?): T

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

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

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

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

hasRelativePosition

  • hasRelativePosition(referenceObjectUID): boolean

  • Parameters

    • referenceObjectUID: string

    Returns boolean

removeRelativePositions

  • removeRelativePositions(referenceObjectUID): void

  • Parameters

    • referenceObjectUID: string

    Returns void

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

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

setUID

  • setUID(uid): this

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns this

    Data object instance

Settings

Member Visibility

Theme

On This Page

createdTimestampdisplayNameparentUIDuidangularVelocitylinearVelocityorientationpositionrelativePositionsvelocityaddRelativePositionbindclonegetPositiongetRelativePositiongetRelativePositionshasRelativePositionremoveRelativePositionssetParentsetPositionsetUID