Class OrthoProjection

Readonlycamera

ReadonlyonProjMatrix

Static Readonlytype

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
• 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

inverseProjMatrix

• get inverseProjMatrix(): Mat4

  Gets the inverse of OrthoProjection.projMatrix.

  Returns Mat4

  The inverse of OrthoProjection.projMatrix.

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
• 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

projMatrix

• get projMatrix(): Mat4

  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 Mat4

  The OrthoProjection's projection matrix.

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
• 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

transposedProjMatrix

• get transposedProjMatrix(): Mat4

  Gets the transpose of OrthoProjection.projMatrix.

  Returns Mat4

  The transpose of OrthoProjection.projMatrix.

fromParams

• fromParams(orthoProjectionParams: OrthoProjectionParams): SDKResult<any>

  Configures this OrthoProjection.

  Parameters

  • orthoProjectionParams: OrthoProjectionParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<OrthoProjectionParams>

  Gets the current configuration of this OrthoProjection.

  Returns SDKResult<OrthoProjectionParams>

unproject

• unproject(
      canvasPos: Vec2,
      screenZ: number,
      screenPos: Vec3,
      viewPos: Vec3,
      worldPos: Vec3,
  ): Vec3

  Un-projects the given View-space coordinates, using this OrthoProjection projection.

  Parameters

  • canvasPos: Vec2

    Inputs 2D View-space coordinates.
  • screenZ: number

    Inputs Screen-space Z coordinate.
  • screenPos: Vec3

    Outputs 3D Screen/Clip-space coordinates.
  • viewPos: Vec3

    Outputs un-projected 3D View-space coordinates.
  • worldPos: Vec3

    Outputs un-projected 3D World-space coordinates.

  Returns Vec3