Box3Helper - Verge3D User Manual - Soft8Soft
Description: Learn how to use Box3Helper in your interactive 3D apps made with Verge3D

Object3D → Line → LineSegments →

# Box3Helper

Helper object to visualize a Box3.

## Code Example

`const box = new v3d.Box3(); box.setFromCenterAndSize(new v3d.Vector3(1, 1, 1), new v3d.Vector3(2, 1, 3)); const helper = new v3d.Box3Helper(box, 0xffff00); app.scene.add(helper);`

## Constructor

### Box3Helper(box : Box3, color : Color | Integer | String)

- box — the Box3 to show.
- color — (optional) the box's color. Default is `0xffff00`.

Creates a new wireframe box that represents the passed Box3.

## Properties

See the base LineSegments class for common properties.

### # .box : Box3

The Box3 being visualized.

## Methods

See the base LineSegments class for common methods.

### # .updateMatrixWorld(force : Boolean)

This overrides the method in the base Object3D class so that it also updates the wireframe box to the extent of the .box property.

### # .dispose()

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

## Source

For more info on how to obtain the source code of this module see this page.