Class FrustumProjection

FrustumProjection-based perspective projection configuration for a Camera .

Located at Camera.frustumProjection.
Allows to explicitly set the positions of the left, right, top, bottom, near and far planes, which is useful for asymmetrical view volumes, such as for stereo viewing.
FrustumProjection.near and FrustumProjection.far specify the distances to the clipping planes.
FrustumProjection.onProjMatrix will fire an event whenever FrustumProjection.projMatrix updates, which indicates that one or more other properties have updated.

Hierarchy (View Summary)

Component
- FrustumProjection

Implements

Projection

Index

Properties

`Readonly`camera

camera: Camera

The Camera this FrustumProjection 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 = FrustumProjectionType

The type of this projection.

Accessors

bottom

get bottom(): number
Gets the position of the FrustumProjection's bottom plane on the View-space Y-axis.

Returns number
Bottom frustum plane position.
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:139
set bottom(value: number): void
Sets the position of the FrustumProjection's bottom plane on the View-space Y-axis.
Parameters
- value: number
  New bottom frustum plane position.
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:148

far

get far(): number
Gets the position of the FrustumProjection's far plane on the positive View-space Z-axis.

Default value is 10000.0.

Returns number
Far frustum plane position.
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:183
set far(value: number): void
Sets the position of the FrustumProjection's far plane on the positive View-space Z-axis.

Default value is 10000.0.
Parameters
- value: number
  New far frustum plane position.
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:194

inverseProjMatrix

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

Returns FloatArrayParam
The inverse orthographic projection projMatrix.
Implementation of Projection.inverseProjMatrix
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:218

left

get left(): number
Gets the position of the FrustumProjection's left plane on the View-space X-axis.

Returns number
Left frustum plane position.
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:82
set left(value: number): void
Sets the position of the FrustumProjection's left plane on the View-space X-axis.
Parameters
- value: number
  New left frustum plane position.
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:91

near

get near(): number
Gets the position of the FrustumProjection's near plane on the positive View-space Z-axis.

Default value is 0.1.

Returns number
Near frustum plane position.
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:160
set near(value: number): void
Sets the position of the FrustumProjection's near plane on the positive View-space Z-axis.

Default value is 0.1.
Parameters
- value: number
  New FrustumProjection near plane position.
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:171

projMatrix

get projMatrix(): FloatArrayParam
Gets the FrustumProjection'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
The FrustumProjection's projection matrix
Implementation of Projection.projMatrix
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:206

right

get right(): number
Gets the position of the FrustumProjection's right plane on the View-space X-axis.

Returns number
Right frustum plane position.
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:101
set right(value: number): void
Sets the position of the FrustumProjection's right plane on the View-space X-axis.
Parameters
- value: number
  New right frustum plane position.
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:110

top

get top(): number
Gets the position of the FrustumProjection's top plane on the View-space Y-axis.

Returns number
Top frustum plane position.
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:120
set top(value: number): void
Sets the position of the FrustumProjection's top plane on the View-space Y-axis.
Parameters
- value: number
  New top frustum plane position.
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:129

transposedProjMatrix

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

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

Methods

`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(frustumProjectionParams: FrustumProjectionParams): void
Configures this FrustumProjection.
Parameters
- frustumProjectionParams: FrustumProjectionParams
Returns void
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:298

`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(): FrustumProjectionParams
Gets the current configuration of this FrustumProjection.

Returns FrustumProjectionParams
- Defined in packages/sdk/src/viewer/FrustumProjection.ts:322

unproject

unproject(
    canvasPos: FloatArrayParam,
    screenZ: number,
    screenPos: FloatArrayParam,
    viewPos: FloatArrayParam,
    worldPos: FloatArrayParam,
): FloatArrayParam
Un-projects the given View-space coordinates, using this FrustumProjection projection.
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/FrustumProjection.ts:265

`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<FrustumProjection, FloatArrayParam>

Emits an event each time FrustumProjection.projMatrix updates.

Class FrustumProjection

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Events

Properties

Readonlycamera

destroyed

Protecteddirty

id

Static Readonlytype

Accessors

bottom

Returns number

Parameters

Returns void

far

Returns number

Parameters

Returns void

inverseProjMatrix

Returns FloatArrayParam

left

Returns number

Parameters

Returns void

near

Returns number

Parameters

Returns void

projMatrix

Returns FloatArrayParam

right

Returns number

Parameters

Returns void

top

Returns number

Parameters

Returns void

transposedProjMatrix

Returns FloatArrayParam

Methods

ProtectedcleanIfDirty

Returns void

Protectederror

Parameters

Returns void

fromParams

Parameters

Returns void

Protectedlog

Parameters

Returns void

ProtectedsetDirty

Returns void

toParams

Returns FrustumProjectionParams

unproject

Parameters

Returns FloatArrayParam

Protectedwarn

Parameters

Returns void

Events

onDestroyed

ReadonlyonProjMatrix

Settings

On This Page

`Readonly`camera

`Protected`dirty

`Static` `Readonly`type

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn

`Readonly`onProjMatrix