Skip to main content

Interface: SceneBoundingBoxSettings

Defines the visual representation of a scene's bounding box.

The SceneBoundingBoxSettings interface controls the appearance of the box that represents the boundaries of the 3D scene or specific objects within it. The bounding box provides visual feedback about object dimensions and scene extents, primarily for development, debugging, and technical visualization purposes.

While typically not shown in production user interfaces, bounding boxes are valuable for understanding spatial relationships and validating scene setup.

Example​

// Creating a subtle blue bounding box with edges
const boundingBox = {
  diffuseColor: [0.3, 0.5, 0.8],   // Blue fill color
  alpha: 0.1,                      // Very transparent fill
  edgesWidth: 1,                   // Thin edges
  edgesColor: [0.3, 0.5, 0.8],     // Same blue for edges
  showBackLines: true              // Show all edges, even on far side
};

Properties​

alpha?​

optional alpha: number

Transparency of the bounding box faces (0-1).

Lower values make the box more transparent, allowing the contained objects to be seen more clearly.

backFaceCulling?​

optional backFaceCulling: boolean

When true, the bounding box is only visible from the front.

This can improve performance by not rendering parts of the box that are facing away from the camera.

diffuseColor?​

optional diffuseColor: number[]

Base fill color of the bounding box [r, g, b].

Controls the color of the bounding box faces when rendered as a translucent volume.

disableLighting?​

optional disableLighting: boolean

When true, the bounding box is not affected by scene lighting.

This keeps the bounding box visually consistent regardless of lighting conditions in the scene.

edgesColor?​

optional edgesColor: number[]

Color of the bounding box edge lines [r, g, b].

Controls the color of the lines that define the edges and corners of the bounding box.

edgesWidth?​

optional edgesWidth: number

Width of bounding box edge lines in pixels.

Controls the thickness of the lines that outline the edges of the bounding box.

emissiveColor?​

optional emissiveColor: number[]

Self-illumination color of the box [r, g, b].

Creates areas of the bounding box that appear to emit light, useful for emphasis in dark environments.

showBackLines?​

optional showBackLines: boolean

When true, edges on the far side of the box are visible.

This ensures that all edges of the bounding box are visible even when they're on the far side from the camera.

size?​

optional size: number

Size scaling factor for the bounding box.

Values greater than 1 make the box larger than the actual bounds, creating margin space around the contained objects.

specularColor?​

optional specularColor: number[]

Color of specular highlights on the box [r, g, b].

Controls the color of shiny reflections that appear on the bounding box surfaces when light strikes them.