Skip to main content

Object3D → Line → LineSegments →

BoxHelper

Helper object to graphically show the world-axis-aligned bounding box around an object. The actual bounding box is handled with Box3, this is just a visual helper for debugging. It can be automatically resized with the BoxHelper.update method when the object it's created from is transformed. Note that the object must have a BufferGeometry for this to work, so it won't work with Sprites.

Code Example​

const sphere = new THREE.SphereGeometry(); const object = new THREE.Mesh(
sphere, new THREE.MeshBasicMaterial( 0xff0000 ) ); const box = new
THREE.BoxHelper( object, 0xffff00 ); scene.add( box );

Examples​

[example:webgl_helpers WebGL / helpers]
[example:webgl_loader_nrrd WebGL / loader / nrrd]
[example:webgl_buffergeometry_drawrange WebGL / buffergeometry / drawrange]

Constructor​

BoxHelper​

function BoxHelper( object: Object3D, color: Color ): void;

object -- (optional) the object3D to show the world- axis-aligned boundingbox.
color -- (optional) hexadecimal value that defines the box's color. Default is 0xffff00.

Creates a new wireframe box that bounds the passed object. Internally this uses Box3.setFromObject to calculate the dimensions. Note that this includes any children.

Properties​

See the base LineSegments class for common properties.

Methods​

See the base LineSegments class for common methods.

update​

function update( ): undefined;

Updates the helper's geometry to match the dimensions of the object, including any children. See Box3.setFromObject.

setFromObject​

function setFromObject( object: Object3D ): this;

object - Object3D to create the helper of.

Updates the wireframe box for the passed object.

dispose​

function dispose( ): undefined;

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

Source​

src/helpers/BoxHelper.js