Class PerspectiveProjection

Readonlycamera

ReadonlyonProjMatrix

Static Readonlytype

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

fov

• get fov(): number

  Gets the PerspectiveProjection's field-of-view angle (FOV).

  Default value is 60.0.

  Returns number

  Current field-of-view.
• 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

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

inverseProjMatrix

• get inverseProjMatrix(): Mat4

  Gets the inverse of PerspectiveProjection.projMatrix.

  Returns Mat4

  The inverse of PerspectiveProjection.projMatrix.

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

projMatrix

• get projMatrix(): Mat4

  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 Mat4

  The PerspectiveProjection's projection matrix.

transposedProjMatrix

• get transposedProjMatrix(): Mat4

  Gets the transpose of PerspectiveProjection.projMatrix.

  Returns Mat4

  The transpose of PerspectiveProjection.projMatrix.

fromParams

• fromParams(
      perspectiveProjectionParams: PerspectiveProjectionParams,
  ): SDKResult<any>

  Sets the state of this PerspectiveParams from the given parameters.

  Parameters

  • perspectiveProjectionParams: PerspectiveProjectionParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<PerspectiveProjectionParams>

  Gets this PerspectiveProjection as JSON.

  Returns SDKResult<PerspectiveProjectionParams>

unproject

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

  Un-projects the given View-space coordinates and Screen-space depth, using this PerspectiveProjection 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