Class StereoCameraObject

Camera source object

Hierarchy

Constructors

constructor

Properties

cameraL cameraMatrix cameraR colorOrder createdTimestamp displayName distortionCoefficients eyeSep fps height parentUID uid width

Accessors

aspect cols focalLength position principalPoint relativePositions rows

Methods

addRelativePosition bind clone getPosition getRelativePosition getRelativePositions hasRelativePosition removeRelativePositions setParent setPosition setUID

Constructors

constructor

Properties

cameraL

cameraL: PerspectiveCameraObject

Left perspective camera

cameraMatrix

cameraMatrix: Matrix3

cameraR

cameraR: PerspectiveCameraObject

Right perspective camera

colorOrder

colorOrder: ColorOrder = ColorOrder.RGB

Camera color order

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

distortionCoefficients

distortionCoefficients: number[]

Distortion coefficients

Returns

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

eyeSep

eyeSep: number = 0.064

Camera eye separation

Default

0.064

fps

fps: number

Frames per second

height

height: number

Height

parentUID

parentUID: string

uid

uid: string

Object identifier

Returns

Unique object identifier

width

width: number

Width

Accessors

aspect

  • get aspect(): number

  • Camera frustum aspect ratio.

    Returns number

    Aspect ratio

cols

focalLength

  • get focalLength(): [number, number]

  • Get the focal length in pixels

    Returns [number, number]

    Focal length for x and y axis

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

principalPoint

  • get principalPoint(): [number, number]

  • Get the principal point in pixels

    Returns [number, number]

    Principal point for x and y axis

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

rows

Methods

addRelativePosition

  • addRelativePosition(relativePosition): StereoCameraObject

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns StereoCameraObject

    Data object instance

bind

  • bind(service): DataObjectBinding<StereoCameraObject>

  • Bind the data object to a service

    Parameters

    Returns DataObjectBinding<StereoCameraObject>

    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): StereoCameraObject

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns StereoCameraObject

    instance

setPosition

  • setPosition(position, referenceSpace?): StereoCameraObject

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns StereoCameraObject

    Data object instance

setUID

  • setUID(uid): StereoCameraObject

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns StereoCameraObject

    Data object instance

Settings

Member Visibility

Theme

On This Page