Class PerspectiveProjection

PerspectiveProjection projection configuration for a Camera .

Located at Camera.perspectiveProjection.
Implicitly sets the left, right, top, bottom frustum planes using PerspectiveProjection.fov.
PerspectiveProjection.near and PerspectiveProjection.far specify the distances to the clipping planes.
PerspectiveProjection.onProjMatrix will fire an event whenever PerspectiveProjection.projMatrix updates, which indicates that one or more other properties have updated.

Hierarchy (View Summary)

Component
- PerspectiveProjection

Implements

Projection

Index

Properties

`Readonly`camera

camera: Camera

The Camera this PerspectiveProjection 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 = PerspectiveProjectionType

The type of this projection.

Accessors

far

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

Returns number
The PerspectiveProjection's far plane position.
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:181
set far(value: number): void
Sets the position of this PerspectiveProjection's far plane on the positive View-space Z-axis.
Parameters
- value: number
  New PerspectiveProjection far plane position.
Returns void
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:190

fov

get fov(): number
Gets the PerspectiveProjection's field-of-view angle (FOV).

Default value is 60.0.

Returns number
Current field-of-view.
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:96
set fov(value: number): void
Sets the PerspectiveProjection's field-of-view angle (FOV).

Default value is 60.0.
Parameters
- value: number
  New field-of-view.
Returns void
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:107

fovAxis

get fovAxis(): string
Gets the PerspectiveProjection's FOV axis.

Options are "x", "y" or "min", to use the minimum axis.

Default value is "min".

Returns string
The current FOV axis value.
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:124
set fovAxis(value: string): void
Sets the PerspectiveProjection's FOV axis.

Options are "x", "y" or "min", to use the minimum axis.

Default value "min".
Parameters
- value: string
  New FOV axis value.
Returns void
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:137

inverseProjMatrix

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

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

near

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

Default value is 0.1.

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

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

projMatrix

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

transposedProjMatrix

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

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

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(perspectiveProjectionParams: PerspectiveProjectionParams): void
Sets the state of this PerspectiveParams from the given parameters.
Parameters
- perspectiveProjectionParams: PerspectiveProjectionParams
Returns void
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:300

`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(): PerspectiveProjectionParams
Gets this PerspectiveProjection as JSON.

Returns PerspectiveProjectionParams
- Defined in packages/sdk/src/viewer/PerspectiveProjection.ts:318

unproject

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

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

Emits an event each time PerspectiveProjection.projMatrix updates.

Class PerspectiveProjection

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Events

Properties

Readonlycamera

destroyed

Protecteddirty

id

Static Readonlytype

Accessors

far

Returns number

Parameters

Returns void

fov

Returns number

Parameters

Returns void

fovAxis

Returns string

Parameters

Returns void

inverseProjMatrix

Returns FloatArrayParam

near

Returns number

Parameters

Returns void

projMatrix

Returns FloatArrayParam

transposedProjMatrix

Returns FloatArrayParam

Methods

ProtectedcleanIfDirty

Returns void

Protectederror

Parameters

Returns void

fromParams

Parameters

Returns void

Protectedlog

Parameters

Returns void

ProtectedsetDirty

Returns void

toParams

Returns PerspectiveProjectionParams

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