Class Camera

constructor

• new Camera(crs, width, height, options?): Camera

• Parameters

  • crs: string

    the CRS of this camera
  • width: number

    the width in pixels of the camera viewport
  • height: number

    the height in pixels of the camera viewport
  • options: CameraOptions = {}

    optional values

  Returns Camera

camera3D

height

width

crs

• get crs(): string

• Returns string

far

• get far(): number

• Returns number

• set far(distance): void

• Gets or sets the distance to the far plane. The distance will be clamped to be within the bounds defined by minNearPlane and maxFarPlane.

  Parameters

  • distance: number

  Returns void

maxFarPlane

• get maxFarPlane(): number

• Gets or sets the maximum distance allowed for the camera far plane.

  Returns number
• set maxFarPlane(distance): void

• Parameters

  • distance: number

  Returns void

minNearPlane

• get minNearPlane(): number

• Gets or sets the minimum distance allowed for the camera near plane.

  Returns number
• set minNearPlane(distance): void

• Parameters

  • distance: number

  Returns void

near

• get near(): number

• Returns number

• set near(distance): void

• Gets or sets the distance to the near plane. The distance will be clamped to be within the bounds defined by minNearPlane and maxFarPlane.

  Parameters

  • distance: number

  Returns void

preSSE

• get preSSE(): number

• Returns number

• set preSSE(value): void

• Parameters

  • value: number

  Returns void

viewMatrix

• get viewMatrix(): Matrix4

• Returns Matrix4

box3SizeOnScreen

• box3SizeOnScreen(box3, matrixWorld): Box3

• Parameters

  • box3: Box3
  • matrixWorld: Matrix4

  Returns Box3

isBox3Visible

• isBox3Visible(box3, matrixWorld): boolean

• Parameters

  • box3: Box3
  • matrixWorld: Matrix4

  Returns boolean

isSphereVisible

• isSphereVisible(sphere, matrixWorld): boolean

• Parameters

  • sphere: Sphere
  • matrixWorld: Matrix4

  Returns boolean

position

• position(crs?): Coordinates

• Return the position in the requested CRS, or in camera's CRS if undefined.

  Parameters

  • Optional crs: string

    if defined (e.g 'EPSG:4236') the camera position will be returned in this CRS

  Returns Coordinates

  Coordinates object holding camera's position

resetPlanes

• resetPlanes(): void

• Resets the near and far planes to their default value.

  Returns void

update

• update(width?, height?): void

• Parameters

  • Optional width: number
  • Optional height: number

  Returns void