Class CameraObject

Camera source object

Hierarchy

DataObject
- CameraObject
  - StereoCameraObject
  - PerspectiveCameraObject

Constructors

constructor

new CameraObject(uid?, displayName?, width?, height?): CameraObject
Parameters
- Optional uid: string
- Optional displayName: string
- Optional width: number
- Optional height: number
Returns CameraObject
Overrides DataObject.constructor
- Defined in src/object/CameraObject.ts:96

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

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
- Defined in src/object/CameraObject.ts:68

cols

get cols(): number
Width of image

Returns number
Width
- Defined in src/object/CameraObject.ts:88
set cols(value): void
Parameters
- value: number
Returns void
- Defined in src/object/CameraObject.ts:92

focalLength

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

Returns [number, number]
Focal length for x and y axis
- Defined in src/object/CameraObject.ts:46

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
Inherited from DataObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:56
set position(position): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
Inherited from DataObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:61

principalPoint

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

Returns [number, number]
Principal point for x and y axis
- Defined in src/object/CameraObject.ts:57

relativePositions

get relativePositions(): RelativePosition<any, Unit>[]
Get relative positions

Returns RelativePosition<any, Unit>[]
Array of relative positions
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:85
set relativePositions(relativePostions): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:86

rows

get rows(): number
Height of image

Returns number
Height
- Defined in src/object/CameraObject.ts:76
set rows(value): void
Parameters
- value: number
Returns void
- Defined in src/object/CameraObject.ts:80

Methods

addRelativePosition

addRelativePosition(relativePosition): CameraObject
Add a relative position to this data object
Parameters
- relativePosition: RelativePosition<any, Unit>
  Relative position to add
Returns CameraObject
Data object instance
Inherited from DataObject.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:99

bind

bind(service): DataObjectBinding<CameraObject>
Bind the data object to a service
Parameters
- service: DataService<string, CameraObject>
  Service to bind it to
Returns DataObjectBinding<CameraObject>
Data object binding with a service
Inherited from DataObject.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:119

clone

clone<T>(dataType?): T
Clone the data object
Type Parameters
- T extends CameraObject
Parameters
- Optional dataType: Constructor<T>
  Data type to clone to
Returns T
Cloned data object
Inherited from DataObject.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:125

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
Inherited from DataObject.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:67

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
Inherited from DataObject.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:112

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
Inherited from DataObject.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:105

hasRelativePosition

hasRelativePosition(referenceObjectUID): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from DataObject.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:113

removeRelativePositions

removeRelativePositions(referenceObjectUID): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from DataObject.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93

setParent

setParent(object): CameraObject
Set a parent object to the data object
Parameters
- object: string | DataObject
  Data object or UID to add as parent
Returns CameraObject
instance
Inherited from DataObject.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:92

setPosition

setPosition(position, referenceSpace?): CameraObject
Set the current absolute position of the object
Parameters
- position: AbsolutePosition
  Position to set
- Optional referenceSpace: TransformationSpace
  Reference space
Returns CameraObject
Data object instance
Inherited from DataObject.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:74

setUID

setUID(uid): CameraObject
Set the unique identifier of this object
Parameters
- uid: string
  Unique Identifier
Returns CameraObject
Data object instance
Inherited from DataObject.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:80

Class CameraObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional uid: string

Optional displayName: string

Optional width: number

Optional height: number

Returns CameraObject

Properties

cameraMatrix

colorOrder

createdTimestamp

displayName

distortionCoefficients

Returns

fps

height

parentUID

uid

Returns

width

Accessors

aspect

Returns number

cols

Returns number

Parameters

value: number

Returns void

focalLength

Returns [number, number]

position

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

principalPoint

Returns [number, number]

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

rows

Returns number

Parameters

value: number

Returns void

Methods

addRelativePosition

Parameters

relativePosition: RelativePosition<any, Unit>

Returns CameraObject

bind

Parameters

service: DataService<string, CameraObject>

Returns DataObjectBinding<CameraObject>

clone

Type Parameters

T extends CameraObject

Parameters

Optional dataType: Constructor<T>

Returns T

getPosition

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

getRelativePosition

Parameters

referenceObjectUID: string

Optional type: string

Returns RelativePosition<any, Unit>

getRelativePositions

`Optional` uid: string

`Optional` displayName: string

`Optional` width: number

`Optional` height: number

`Optional` dataType: Constructor<T>

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

`Optional` referenceSpace: TransformationSpace