Class Debug

Constructors

constructor

Properties

state update

Methods

getCameraState

Constructors

constructor

  • new Debug(core: Core): Debug

    Parameters

    • core: Core

    Returns Debug

Properties

state

state: {
    showCameraTargets: boolean;
    showCollisionBoxes: boolean;
    showEnvMap: boolean;
    showGeometryInFocus: boolean;
    showImageLOD: boolean;
    showModelInstancingStats: boolean;
    showPolygonLabelTextAreaMesh: boolean;
    showScreenOffsets: boolean;
}

Type declaration

  • showCameraTargets: boolean

    Shows camera target debug visualization.

    • Green dot: animateTo target position
    • Orange box: focusOn bounding area
    • Cyan box: getFocusOnTransform bounding area
  • showCollisionBoxes: boolean

    Shows collision detection boxes for debugging spatial interactions

  • showEnvMap: boolean

    Enables the basic environment map for lighting and reflections

  • showGeometryInFocus: boolean

    Shows the debug for the geometry in focus system

  • showImageLOD: boolean

    Shows LOD level indicators on images via color tinting.

  • showModelInstancingStats: boolean

    Shows model instancing statistics (batch counts, instance counts, draw calls)

  • showPolygonLabelTextAreaMesh: boolean

    Shows the text area mesh used for polygon label rendering

  • showScreenOffsets: boolean

    Shows screen offset areas as transparent colored overlays.

    • Red: top offset
    • Green: bottom offset
    • Blue: left offset
    • Yellow: right offset

update

update: (
    updateState: Partial<
        {
            showCameraTargets: boolean;
            showCollisionBoxes: boolean;
            showEnvMap: boolean;
            showGeometryInFocus: boolean;
            showImageLOD: boolean;
            showModelInstancingStats: boolean;
            showPolygonLabelTextAreaMesh: boolean;
            showScreenOffsets: boolean;
        },
    >,
) => void

Type declaration

    • (
          updateState: Partial<
              {
                  showCameraTargets: boolean;
                  showCollisionBoxes: boolean;
                  showEnvMap: boolean;
                  showGeometryInFocus: boolean;
                  showImageLOD: boolean;
                  showModelInstancingStats: boolean;
                  showPolygonLabelTextAreaMesh: boolean;
                  showScreenOffsets: boolean;
              },
          >,
      ): void

    • Updates the debug state with new configuration options. Only changed values will trigger updates to the corresponding systems.

      Parameters

      • updateState: Partial<
            {
                showCameraTargets: boolean;
                showCollisionBoxes: boolean;
                showEnvMap: boolean;
                showGeometryInFocus: boolean;
                showImageLOD: boolean;
                showModelInstancingStats: boolean;
                showPolygonLabelTextAreaMesh: boolean;
                showScreenOffsets: boolean;
            },
        >

        Partial debug state with the options to update

      Returns void

      Example

      // Enable only collision boxes
      debug.update({ showCollisionBoxes: true });

      // Enable multiple features at once
      debug.update({
        showEnvMap: true,
        showPolygonLabelTextAreaMesh: true
      });

Methods

getCameraState

  • getCameraState(): TCameraTarget

    Returns the current camera state as a JSON object that can be passed directly to mapView.Camera.set().

    Returns TCameraTarget

    The current camera state including center, zoomLevel, bearing, and pitch.

    Example

    const state = mapView.Debug.getCameraState();
    console.log(state);
    // Later restore the camera position:
    mapView.Camera.set(state);

Settings

Member Visibility

On This Page

Constructors
Properties
Methods