Class FrustumProjection

Readonlycamera

Static Readonlytype

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

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

inverseProjMatrix

• get inverseProjMatrix(): Mat4

  Gets the inverse of FrustumProjection.projMatrix.

  Returns Mat4

  The inverse orthographic projection projMatrix.

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

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

projMatrix

• get projMatrix(): Mat4

  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 Mat4

  The FrustumProjection's projection matrix

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

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

transposedProjMatrix

• get transposedProjMatrix(): Mat4

  Gets the transpose of FrustumProjection.projMatrix.

  Returns Mat4

  The transpose of FrustumProjection.projMatrix.

fromParams

• fromParams(frustumProjectionParams: FrustumProjectionParams): SDKResult<any>

  Configures this FrustumProjection.

  Parameters

  • frustumProjectionParams: FrustumProjectionParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<FrustumProjectionParams>

  Gets the current configuration of this FrustumProjection.

  Returns SDKResult<FrustumProjectionParams>

unproject

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

  Un-projects the given View-space coordinates, using this FrustumProjection 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