Class CustomProjection

Configures a custom projection for a Camera .

Located at Camera.customProjection.
CustomProjection.onProjMatrix will fire an event whenever CustomProjection.projMatrix updates, which indicates that one or more other properties have updated.

Hierarchy (View Summary)

Component
- CustomProjection

Implements

Projection

Index

Properties

camera destroyed dirty id type

Accessors

inverseProjMatrix projMatrix transposedProjMatrix

Methods

clean cleanIfDirty error fromParams log setDirty toParams unproject warn

Events

onDestroyed onProjMatrix

Properties

`Readonly`camera

camera: Camera

The Camera this CustomProjection belongs to.

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

Unique ID of this Component.

`Static` `Readonly`type

type: number = CustomProjectionType

The type of this projection.

Accessors

inverseProjMatrix

get inverseProjMatrix(): FloatArrayParam
Gets the inverse of CustomProjection.projMatrix.

Returns FloatArrayParam
The inverse of CustomProjection.projMatrix.
Implementation of Projection.inverseProjMatrix
- Defined in packages/sdk/src/viewer/CustomProjection.ts:98

projMatrix

get projMatrix(): FloatArrayParam
Gets the CustomProjection's projection transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

Returns FloatArrayParam
New value for the CustomProjection's matrix.
Implementation of Projection.projMatrix
- Defined in packages/sdk/src/viewer/CustomProjection.ts:72
set projMatrix(projMatrix: FloatArrayParam): void
Sets the CustomProjection's projection transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].
Parameters
- projMatrix: FloatArrayParam
  New value for the CustomProjection's matrix.
Returns void
Implementation of Projection.projMatrix
- Defined in packages/sdk/src/viewer/CustomProjection.ts:83

transposedProjMatrix

get transposedProjMatrix(): FloatArrayParam
Gets the transpose of CustomProjection.projMatrix.

Returns FloatArrayParam
The transpose of CustomProjection.projMatrix.
Implementation of Projection.transposedProjMatrix
- Defined in packages/sdk/src/viewer/CustomProjection.ts:114

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

fromParams

fromParams(customProjectionParams: CustomProjectionParams): void
Configures this CustomProjection.
Parameters
- customProjectionParams: CustomProjectionParams
Returns void
- Defined in packages/sdk/src/viewer/CustomProjection.ts:159

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

toParams

toParams(): CustomProjectionParams
Gets the current configuration of this CustomProjection.

Returns CustomProjectionParams
- Defined in packages/sdk/src/viewer/CustomProjection.ts:168

unproject

unproject(
    canvasPos: FloatArrayParam,
    screenZ: number,
    screenPos: FloatArrayParam,
    viewPos: FloatArrayParam,
    worldPos: FloatArrayParam,
): FloatArrayParam
Un-projects the given View-space coordinates, using this CustomProjection.
Parameters
- canvasPos: FloatArrayParam
  Inputs 2D View-space coordinates.
- screenZ: number
  Inputs Screen-space Z coordinate.
- screenPos: FloatArrayParam
  Outputs 3D Screen/Clip-space coordinates.
- viewPos: FloatArrayParam
  Outputs un-projected 3D View-space coordinates.
- worldPos: FloatArrayParam
  Outputs un-projected 3D World-space coordinates.
Returns FloatArrayParam
Implementation of Projection.unproject
- Defined in packages/sdk/src/viewer/CustomProjection.ts:134

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.

`Readonly`onProjMatrix

onProjMatrix: EventEmitter<CustomProjection, FloatArrayParam>

Emits an event each time CustomProjection.projMatrix updates.