Interface: Scene3DConfig

Top-level 3D scene configuration: declarative GLB models and global scene lighting, plus deck.gl overlay tuning. Serializable only (no WebGL instances). Runtime applies this when the map is in 3D mode.

Example


const scene3D: Scene3DConfig = {
  enabled: true,
  models: {
    lights: [
      { type: "directional", color: "#ffffff", intensity: 2, position: { x: 50, y: 100, z: 80 } },
      { type: "ambient", color: 0xffffff, intensity: 1.5 },
    ],
    // From zoom 20 onward, every model fades to 95% transparency unless overridden.
    zoomTransparency: { zoom: 20, opacity: 0.05 },
    assets: [{ id: "kiosk", url: "https://cdn.example.com/kiosk.glb" }],
    placements: [
      {
        id: "kiosk-1",
        assetId: "kiosk",
        position: { lng: -70.6, lat: -33.4 },
        visibility: { mode: "allFloors" },
        rotation: { yaw: 90 },
      },
    ],
  },
  deck: { labels: { getSize: 14 }, poiIcons: false },
}

Properties

customLayers?


optional customLayers?: CustomLayerConfig;

enabled?


optional enabled?: boolean;

When false, the map does not activate 3D scene features (deck.gl overlay, escalator GLB layer, …) even if MapConfig.mode is "3D". When omitted or true, those features run when mode is "3D".

hideLayers?


optional hideLayers?: string[];

models?


optional models?: Models3DConfig;