Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PerspectiveCameraObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new PerspectiveCameraObject(uid?: string, displayName?: string, width?: number, height?: number, fov?: number, near?: number, far?: number): PerspectiveCameraObject

Properties

cameraMatrix

cameraMatrix: Matrix3

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))]

far

far: number

Camera frustum far plane.

fov

fov: number

Camera frustum vertical field of view.

fps

fps: number

Frames per second

height

height: number

Height

near

near: number

Camera frustum near plane.

parentUID

parentUID: string

uid

uid: string

Object identifier

returns

Unique object identifier

width

width: number

Width

Accessors

aspect

  • get aspect(): number

cols

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

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

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>[]
  • 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

rows

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

Methods

addRelativePosition

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns PerspectiveCameraObject

    Data object instance

bind

  • Bind the data object to a service

    Parameters

    Returns DataObjectBinding<PerspectiveCameraObject>

    Data object binding with a service

clone

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 PerspectiveCameraObject

    instance

setPosition

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

    Returns PerspectiveCameraObject

    Data object instance

setUID

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns PerspectiveCameraObject

    Data object instance