Class StereoCameraObject

Camera source object

Hierarchy

Constructors

Properties

Left perspective camera

cameraMatrix: Matrix3

Right perspective camera

colorOrder: ColorOrder = ColorOrder.RGB

Camera color order

createdTimestamp: number

Created timestamp

displayName: string

Object display name

distortionCoefficients: number[]

Distortion coefficients

Returns

[k1, k2, p1, p2, (k3, (k4, k5))]

eyeSep: number = 0.064

Camera eye separation

Default

0.064
fps: number

Frames per second

height: number

Height

parentUID: string
uid: string

Object identifier

Returns

Unique object identifier

width: number

Width

Accessors

  • get aspect(): number
  • Camera frustum aspect ratio.

    Returns number

    Aspect ratio

  • get focalLength(): [number, number]
  • Get the focal length in pixels

    Returns [number, number]

    Focal length for x and y axis

  • 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

  • get principalPoint(): [number, number]
  • Get the principal point in pixels

    Returns [number, number]

    Principal point for x and y axis

  • 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

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns StereoCameraObject

    Data object instance

  • Bind the data object to a service

    Parameters

    Returns DataObjectBinding<StereoCameraObject>

    Data object binding with a service

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

  • 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

  • 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

  • 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

  • Parameters

    • referenceObjectUID: string

    Returns boolean

  • Parameters

    • referenceObjectUID: string

    Returns void

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns StereoCameraObject

    instance

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns StereoCameraObject

    Data object instance

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns StereoCameraObject

    Data object instance