Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VSLAMLandmark

Hierarchy

  • DataObject
    • VSLAMLandmark

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new VSLAMLandmark(uid?: string, displayName?: string): VSLAMLandmark

  • Create a new data object

    Parameters

    • Optional uid: string

      Optional unique identifier

    • Optional displayName: string

      Optional display name

    Returns VSLAMLandmark

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
  • set position(position: AbsolutePosition): void

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

    Returns AbsolutePosition

    Absolute position of data object

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

    Parameters

    • position: AbsolutePosition

    Returns void

    Absolute position of data object

relativePositions

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

  • Get relative positions

    Returns RelativePosition<any, Unit>[]

    Array of relative positions

  • Get relative positions

    Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

    Array of relative positions

Methods

addRelativePosition

  • addRelativePosition(relativePosition: RelativePosition<any, Unit>): VSLAMLandmark

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns VSLAMLandmark

    Data object instance

bind

  • Bind the data object to a service

    Parameters

    • service: DataService<string, VSLAMLandmark>

      Service to bind it to

    Returns DataObjectBinding<VSLAMLandmark>

    Data object binding with a service

clone

  • Clone the data object

    Returns VSLAMLandmark

    Cloned data object

getPosition

  • getPosition(referenceSpace?: TransformationSpace): AbsolutePosition

  • Get the current absolute position of the object

    Parameters

    • Optional referenceSpace: TransformationSpace

    Returns AbsolutePosition

    Position of the data object

getRelativePosition

  • getRelativePosition(referenceObjectUID: string, type?: string): 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?: string): RelativePosition<any, Unit>[]

  • Get relative positions for a different target

    Parameters

    • Optional referenceObjectUID: string

    Returns RelativePosition<any, Unit>[]

    Array of relative positions for the reference object

hasRelativePosition

  • hasRelativePosition(referenceObjectUID: string): boolean

  • Parameters

    • referenceObjectUID: string

    Returns boolean

removeRelativePositions

  • removeRelativePositions(referenceObjectUID: string): void

  • 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 VSLAMLandmark

    instance

setPosition

  • setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): VSLAMLandmark

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

    Returns VSLAMLandmark

    Data object instance

setUID

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns VSLAMLandmark

    Data object instance

Static fromNativeJSON

  • Parameters

    • json: any

    Returns VSLAMLandmark