Interface RFObject

Hierarchy

  • DataObject
    • RFObject

Implemented by

Properties

createdTimestamp displayName parentUID uid

Accessors

position relativePositions

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

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

Methods

addRelativePosition

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns RFObject

    Data object instance

bind

  • 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 the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

getPosition

  • 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

  • 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

  • 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

  • Parameters

    • referenceObjectUID: string

    Returns boolean

removeRelativePositions

  • Parameters

    • referenceObjectUID: string

    Returns void

setParent

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns RFObject

    instance

setPosition

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns RFObject

    Data object instance

setUID

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns RFObject

    Data object instance

Settings

Member Visibility

Theme

On This Page