BoxMeshDesc

The BoxMeshDesc class is a mesh descriptor for drawing box geometry. You can create a box by specifying width, height, and depth.

In addition to the properties below, all common properties from the base class (position, rotation, scale, matrix, matrixWorld, geodetic, pickable, visible) are available. See MeshDesc for details.

Properties

width

Type: number

Description: Specifies the width of the box (size along the X-axis).

Default: 1

Example:

{
  box: {
    width: 100,
  }
}

height

Type: number

Description: Specifies the height of the box (size along the Y-axis).

Default: 1

Example:

{
  box: {
    height: 100,
  }
}

depth

Type: number

Description: Specifies the depth of the box (size along the Z-axis).

Default: 1

Example:

{
  box: {
    depth: 100,
  }
}

widthSegments

Type: number

Description: Specifies the number of segments along the width.

Default: 1

Example:

{
  box: {
    widthSegments: 2,
  }
}

heightSegments

Type: number

Description: Specifies the number of segments along the height.

Default: 1

Example:

{
  box: {
    heightSegments: 2,
  }
}

depthSegments

Type: number

Description: Specifies the number of segments along the depth.

Default: 1

Example:

{
  box: {
    depthSegments: 2,
  }
}

color

Type: Color

Description: Specifies the color of the box using a Color instance. The Color class supports hexadecimal color codes and CSS-style color specifications.

Default: new Color().setStyle("#ffffff")

Example:

import { Color } from "@navaramap/three";

{
  box: {
    color: new Color().setHex(0xff0000),
  }
}

// or
{
  box: {
    color: new Color().setStyle("#ff0000"), // CSS format
  }
}

emissiveColor

Type: Color

Description: Specifies the emissive (self-illuminating) color using a Color instance.

Default: new Color().setHex(0x000000)

Example:

import { Color } from "@navaramap/three";

{
  box: {
    emissiveColor: new Color().setHex(0x222222),
  }
}

emissiveIntensity

Type: number

Description: Specifies the emissive intensity.

Default: 0

Example:

{
  box: {
    emissiveIntensity: 0.5,
  }
}

opacity

Type: number

Description: Specifies the opacity. Ranges from 0.0 (fully transparent) to 1.0 (fully opaque).

Default: 1

Example:

{
  box: {
    opacity: 0.5,
  }
}

transparent

Type: boolean

Description: Specifies whether to enable transparency.

Default: false

Example:

{
  box: {
    transparent: true,
  }
}

draped

Type: boolean

Description: Paints the shape onto the terrain instead of rendering it as a volume. The mesh must fully cover the ground it should cover: the drape is the intersection of the volume with the terrain, computed with a stencil test.

A draped shape is shaded from the terrain’s normal, not its own, so it reads as a decal lying on the ground rather than a solid. For the same reason it does not receive shadows: the drape is drawn without a depth test, so a shadow lookup (which depends on world position) would differ between the overlapping faces of the volume and the far one would show through. receiveShadow is ignored while draped is true. The terrain underneath keeps its own shadows.

Default: false

Example:

{
  box: {
    width: 500,
    height: 2000, // tall enough to pierce the terrain
    depth: 500,
    draped: true,
  }
}

castShadow

Type: boolean

Description: Specifies whether the box casts shadows.

Default: false

Example:

{
  box: {
    castShadow: true,
  }
}

receiveShadow

Type: boolean

Description: Specifies whether the box receives shadows.

Default: false

Example:

{
  box: {
    receiveShadow: true,
  }
}

Config

effectIds

Type: string[] (optional)

Description: Specifies an array of selective effect descriptor IDs to apply to this mesh.

Example:

{
  box: {
    effectIds: ["bloom-effect", "outline-effect"],
  }
}

Usage Examples

Basic Usage

import ThreeView, { Color } from "@navaramap/three";
import { BoxMeshDesc } from "@navaramap/three-default-descs";

const view = new ThreeView();
view.registerMesh("box", BoxMeshDesc);
await view.init();

// Add a BoxMeshDesc
const boxDesc = view.addMesh<BoxMeshDesc>({
  box: {
    width: 100,
    height: 100,
    depth: 100,
    color: new Color().setHex(0xff0000),
  },
  position: { x: 0, y: 0, z: 1000 },
});

Box with Shadows

import ThreeView, { Color } from "@navaramap/three";
import { BoxMeshDesc } from "@navaramap/three-default-descs";

const boxDesc = view.addMesh<BoxMeshDesc>({
  box: {
    width: 200,
    height: 100,
    depth: 150,
    color: new Color().setHex(0x00aa00),
    castShadow: true,
    receiveShadow: true,
  },
  position: { x: 0, y: 0, z: 500 },
});

Semi-transparent Box

import ThreeView, { Color } from "@navaramap/three";
import { BoxMeshDesc } from "@navaramap/three-default-descs";

const boxDesc = view.addMesh<BoxMeshDesc>({
  box: {
    width: 150,
    height: 150,
    depth: 150,
    color: new Color().setHex(0x0088ff),
    opacity: 0.5,
    transparent: true,
  },
  position: { x: 1000, y: 0, z: 500 },
});