Class OrthoProjection

Orthographic projection configuration for a Camera .

Located at Camera.orthoProjection.
Works like Blender's orthographic projection, where the positions of the left, right, top and bottom planes are implicitly indicated with a single OrthoProjection.scale property, which causes the frustum to be symmetrical on X and Y axis, large enough to contain the number of units given by OrthoProjection.scale.
OrthoProjection.near and OrthoProjection.far indicated the distances to the clipping planes.
OrthoProjection.onProjMatrix will fire an event whenever OrthoProjection.projMatrix updates, which indicates that one or more other properties have updated.

Hierarchy (View Summary)

Component
- OrthoProjection

Implements

Projection

Index

Properties

`Readonly`camera

camera: Camera

The Camera this OrthoProjection 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 = OrthoProjectionType

The type of this projection.

Accessors

far

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

Default value is 10000.0.

returns New far ortho plane position.

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

Default value is 2000.0.
Parameters
- value: number
  New far ortho plane position.
Returns void
- Defined in packages/sdk/src/viewer/OrthoProjection.ts:154

inverseProjMatrix

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

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

near

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

Default value is 0.1.

returns New OrthoProjection near plane position.

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

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

projMatrix

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

scale

get scale(): number
Gets scale factor for this OrthoProjection's extents on X and Y axis.

Clamps to minimum value of ````0.01```.

Default value is 1.0

returns New OrthoProjection scale value.

Returns number
- Defined in packages/sdk/src/viewer/OrthoProjection.ts:90
set scale(value: number): void
Sets scale factor for this OrthoProjection's extents on X and Y axis.

Clamps to minimum value of ````0.01```.

Default value is 1.0
Parameters
- value: number
  New scale value.
Returns void
- Defined in packages/sdk/src/viewer/OrthoProjection.ts:102

transposedProjMatrix

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

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

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(orthoProjectionParams: OrthoProjectionParams): void
Configures this OrthoProjection.
Parameters
- orthoProjectionParams: OrthoProjectionParams
Returns void
- Defined in packages/sdk/src/viewer/OrthoProjection.ts:295

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

Returns OrthoProjectionParams
- Defined in packages/sdk/src/viewer/OrthoProjection.ts:310

unproject

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

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

Emits an event each time OrthoProjection.projMatrix updates.

Class OrthoProjection

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Events

Properties

Readonlycamera

destroyed

Protecteddirty

id

Static Readonlytype

Accessors

far

Returns number

Parameters

Returns void

inverseProjMatrix

Returns FloatArrayParam

near

Returns number

Parameters

Returns void

projMatrix

Returns FloatArrayParam

scale

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 OrthoProjectionParams

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