Class Camera

constructor

• new Camera(type?: CameraType, aspectRatio?: number): Camera

• Create a new default camera

  Parameters

  • type: CameraType = CameraType.PERSPECTIVE
  • aspectRatio: number = 1

  Returns Camera

active

aspectRatio

far

fov

fpMoveSpeed

lookAt

near

orthoZoom

position

type

up

usedForEnvMap

usedForShadowMap

fpModeEnabled

• get fpModeEnabled(): boolean

• Get FP mode state

  Returns boolean

matrix

• get matrix(): mat4

• Get the current view matrix for the camera

  Returns mat4

projectionMatrix

• get projectionMatrix(): mat4

• Get the projection matrix for this camera

  Returns mat4

disableFPControls

• disableFPControls(): void

• Disable FP mode

  Returns void

enableFPControls

• enableFPControls(
      angleY?: number,
      angleX?: number,
      turnSpeed?: number,
      moveSpeed?: number,
      fly?: boolean,
  ): void

• Switches the camera to first person mode, where the camera is controlled by the mouse and keyboard. The mouse controls look direction and the keyboard controls movement.

  Parameters

  • angleY: number = 0

    Starting look up/down angle in radians, default 0
  • angleX: number = 0

    Starting look left/right angle in radians, default 0
  • turnSpeed: number = 0.001

    Speed of looking in radians, default 0.001
  • moveSpeed: number = 1.0

    Speed of moving in units, default 1.0
  • fly: boolean = false

  Returns void

frustumCornersWorld

• frustumCornersWorld(
      scaleFar?: number,
  ): {
      center: vec3;
      farBottomLeftWorld: vec3;
      farBottomRightWorld: vec3;
      farTopLeftWorld: vec3;
      farTopRightWorld: vec3;
      nearBottomLeftWorld: vec3;
      nearBottomRightWorld: vec3;
      nearTopLeftWorld: vec3;
      nearTopRightWorld: vec3;
  }

• Get the corners of the view frustum for this camera in world space

  Parameters

  • scaleFar: number = 1

    Scale the far plane to bring the frustum closer, default: 1

  Returns {
      center: vec3;
      farBottomLeftWorld: vec3;
      farBottomRightWorld: vec3;
      farTopLeftWorld: vec3;
      farTopRightWorld: vec3;
      nearBottomLeftWorld: vec3;
      nearBottomRightWorld: vec3;
      nearTopLeftWorld: vec3;
      nearTopRightWorld: vec3;
  }

getFrustumCenter

• getFrustumCenter(scaleFar?: number): XYZ

• Get the center of the camera view frustum

  Parameters

  • scaleFar: number = 1

  Returns XYZ

  Point in world space

toString

• toString(): string

• Get the camera position as a string for debugging

  Returns string

update

• update(): void

• Called every frame to update the camera, currently only used for movement in FP mode

  Returns void