Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VSLAMKeyFrame

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Create a new data frame

    Parameters

    • Optional frame: DataFrame

      Data frame to copy

    Returns VSLAMKeyFrame

  • Create a new data frame

    Parameters

    • Optional source: DataObject

      Source data object

    Returns VSLAMKeyFrame

Properties

createdTimestamp

createdTimestamp: number

Data frame created timestamp (ISO 8601)

fourcc

fourcc: number

fps

fps: number

height

height: number

Height (rows)

image

image: any

uid

uid: string

Data frame unique identifier

width

width: number

Width (cols)

Accessors

cameraPose

  • get cameraPose(): Matrix4

  • Get the camera pose at the time of the frame

    Returns Matrix4

    Camera pose as a matrix with translation and rotation

cols

  • get cols(): number
  • set cols(value: number): void

  • Width of image

    Returns number

    Width

  • Width of image

    Parameters

    • value: number

    Returns void

    Width

landmarks

  • Get frame landmarks

    Returns VSLAMLandmark[]

    Array of landmarks found in this frame

  • Set frame landmarks

    Parameters

    Returns void

    Array of landmarks found in this frame

rows

  • get rows(): number
  • set rows(value: number): void

  • Height of image

    Returns number

    Height

  • Height of image

    Parameters

    • value: number

    Returns void

    Height

source

  • get source(): C
  • set source(object: C): void

  • Source object clone that captured the data frame

    Returns C

    Source data object

  • Set the source object clone that captured the data frame

    Parameters

    • object: C

      Source data object

    Returns void

    Source data object

Methods

addLandmark

  • Add a landmark to the frame

    Parameters

    Returns void

addObject

  • addObject(object: DataObject): void

  • Add a new object relevant to this data frame

    Parameters

    • object: DataObject

      Relevant object

    Returns void

addReferenceSpace

  • addReferenceSpace(referenceSpace: ReferenceSpace): void

  • Add a new reference space relevant to this data frame.

    alias

    addObject Alias for addObject

    Parameters

    • referenceSpace: ReferenceSpace

      Relevant reference space

    Returns void

clone

  • Clone the data frame

    Returns VSLAMKeyFrame

    Cloned data frame

getObjectByUID

  • getObjectByUID<T>(uid: string): T

  • Get a specific object by its identifier

    Type parameters

    • T: DataObject<T>

    Parameters

    • uid: string

      Object UID

    Returns T

    Data object if found

getObjects

  • getObjects<T>(dataType?: new () => T): T[]

  • Get known objects used in this data frame

    Type parameters

    • T: DataObject<T>

    Parameters

    • Optional dataType: new () => T

      Data object type

        • new (): T

        • Returns T

    Returns T[]

    Array of found data objects

hasObject

  • hasObject(object: DataObject): boolean

  • Check if the data frame has an object

    Parameters

    • object: DataObject

      Data object to find

    Returns boolean

    Object exist

removeObject

  • removeObject(object: DataObject): void

  • Remove an object from the data frame

    Parameters

    • object: DataObject

      Object to remove

    Returns void

Static fromNativeJSON

  • Parameters

    • json: any

    Returns VSLAMKeyFrame