[page:LineSegments] →

[name]

Helper object to show the world-axis-aligned bounding box around an object. Note that the object must have a [page:Geometry] or [page:BufferGeometry] for this to work, so it won't work with [page:Sprite Sprites].

Example

[example:webgl_helpers WebGL / helpers]
[example:webgl_loader_nrrd WebGL / loader / nrrd]
[example:webgl_buffergeometry_drawcalls advanced / buffergeometry / drawcalls]
var sphere = new v3d.SphereGeometry(); var object = new v3d.Mesh(sphere, new v3d.MeshBasicMaterial(0xff0000)); var box = new v3d.BoxHelper(object, 0xffff00); scene.add(box);

Constructor

[name]([param:Object3D object], [param:Color color])

[page:Object3D object] -- (optional) the object3D to show the world-axis-aligned boundingbox.
[page:Color 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 [page:Box3.setFromObject] to calculate the dimensions. Note that this includes any children.

Properties

See the base [page:LineSegments] class for common properties.

Methods

See the base [page:LineSegments] class for common methods.

[method:null update]()

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

[method:BoxHelper setFromObject]([param:Object3D object])

[page:Object3D object] - [page:Object3D] to create the helper of.

Updates the wireframe box for the passed object.

[sourceHint]