Class Layer3D

constructor

• new Layer3D(id: string, options?: Layer3DOptions): Layer3D

  Parameters

  • id: string
  • options: Layer3DOptions = {}

  Returns Layer3D

Readonlyclock

Readonlyid

maxZoom

minZoom

ReadonlyrenderingMode

Readonlytype

[handleMeshClickMethodSymbol]

• "[handleMeshClickMethodSymbol]"(event: Layer3DInternalApiEvent): void
  Internal

  Handle the click event for a mesh This is used to trigger the click event for the item by WebGLRenderManager.

  Parameters

  • event: Layer3DInternalApiEvent

    The event data

  Returns void

  See

addMesh

• addMesh(
      id: string,
      mesh:
          | Object3D<Object3DEventMap>
          | Mesh<
              BufferGeometry<NormalBufferAttributes>,
              Material | Material[],
              Object3DEventMap,
          >
          | Group<Object3DEventMap>,
      options?: MeshOptions,
  ): Item3D

  Add an existing mesh to the map

  Parameters

  • id: string

    The ID of the mesh

  • mesh:
        | Object3D<Object3DEventMap>
        | Mesh<
            BufferGeometry<NormalBufferAttributes>,
            Material | Material[],
            Object3DEventMap,
        >
        | Group<Object3DEventMap>
  • options: MeshOptions = {}

    The options to add the mesh with

  Returns Item3D

  The item

addMeshFromURL

• addMeshFromURL(
      id: string,
      url: string,
      options?: AddMeshFromURLOptions,
  ): Promise<Item3D>

  Load a GLTF file from its URL and add it to the map

  Parameters

  • id: string

    The ID of the mesh

  • url: string
  • options: AddMeshFromURLOptions = {}

    The options to add the mesh with

  Returns Promise<Item3D>

addPointLight

• addPointLight(id: string, options?: PointLightOptions): Layer3D

  Adding a point light. The default options are mimicking the sun: lngLat: [0, 0] (null island) altitude: 2_000_000 meters altitudeReference: AltitudeReference.MEAN_SEA_LEVEL color: 0xffffff (white) intensity: 75 decay: 0.2

  Parameters

  • id: string

    The ID of the point light

  • options: PointLightOptions = {}

    The options to add the point light with

  Returns Layer3D

  The layer

clear

• clear(): Layer3D

  Remove all the meshes and point lights of the scene.

  Returns Layer3D

  The layer

cloneMesh

• cloneMesh(sourceId: string, id: string, options?: AddMeshFromURLOptions): void

  Clone an existing mesh. Extra options can be provided to overwrite the clone configuration

  Parameters

  • sourceId: string

    The ID of the mesh to clone

  • id: string

    The ID of the cloned mesh

  • options: AddMeshFromURLOptions = {}

    The options to clone the mesh with

  Returns void

getItem3D

• getItem3D(id: string): null | Item3D

  Parameters

  • id: string

  Returns null | Item3D

getMapInstance

• getMapInstance(): Map

  Get the map instance of the layer.

  Returns Map

  The map instance

getRendererInstance

• getRendererInstance(): WebGLRenderManager

  Get the renderer instance of the layer. This is internally for animations and batch rendering layers.

  Returns WebGLRenderManager

  The renderer instance

modifyPointLight

• modifyPointLight(id: string, options: PointLightOptions): undefined | Layer3D

  Modify a point light

  Parameters

  • id: string

    The ID of the point light

  • options: PointLightOptions

    The options to modify the point light with

  Returns undefined | Layer3D

OptionalonAdd

• onAdd?(map: Map, gl: WebGL2RenderingContext): void

  Automatically called when the layer is added. (should not be called manually)

  Parameters

  • map: Map
  • gl: WebGL2RenderingContext

  Returns void

OptionalonRemove

• onRemove?(_map: Map, _gl: WebGL2RenderingContext | WebGLRenderingContext): void

  Automatically called when the layer is removed. (should not be called manually)

  Parameters

  • _map: Map
  • _gl: WebGL2RenderingContext | WebGLRenderingContext

  Returns void

removeMesh

• removeMesh(id: string): Layer3D

  Remove a mesh from the scene using its ID.

  Parameters

  • id: string

    The ID of the mesh to remove

  Returns Layer3D

  The layer

render

• render(): null

  Render the layer. Normally this method is called by the Map instance on every frame to calculate matrices and update the camera projection matrix. However, this would require a multiple instances of Three.js renderers, which is not optimal. So instead we use the WebGLManagerLayer to render the layer and return null.

  Returns null

  See

  • where all the calculations for the layer are done.

setAmbientLight

• setAmbientLight(
      options?: { color?: ColorRepresentation; intensity?: number },
  ): Layer3D

  Adjust the settings of the ambient light

  Parameters

  • options: { color?: ColorRepresentation; intensity?: number } = {}

    The options to set the ambient light with

  Returns Layer3D

  The layer