Class Debug

Constructors

constructor

Properties

state update

Constructors

constructor

  • new Debug(core: Core): Debug

    Parameters

    • core: Core

    Returns Debug

Properties

state

state: {
    showCollisionBoxes: boolean;
    showEnvMap: boolean;
    showPolygonLabelTextAreaMesh: boolean;
}

Type declaration

  • showCollisionBoxes: boolean

    Shows collision detection boxes for debugging spatial interactions

  • showEnvMap: boolean

    Enables the basic environment map for lighting and reflections

  • showPolygonLabelTextAreaMesh: boolean

    Shows the text area mesh used for polygon label rendering

update

update: (
    updateState: Partial<
        {
            showCollisionBoxes: boolean;
            showEnvMap: boolean;
            showPolygonLabelTextAreaMesh: boolean;
        },
    >,
) => void

Type declaration

    • (
          updateState: Partial<
              {
                  showCollisionBoxes: boolean;
                  showEnvMap: boolean;
                  showPolygonLabelTextAreaMesh: boolean;
              },
          >,
      ): void

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

      Parameters

      • updateState: Partial<
            {
                showCollisionBoxes: boolean;
                showEnvMap: boolean;
                showPolygonLabelTextAreaMesh: 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
      });

Settings

Member Visibility

On This Page

Constructors
Properties