Skip to content
On this page

BoxHelper

Helper object to graphically show the world-axis-aligned bounding box around an object.

Ulike the three.js helper, this component crates a box mesh around the target mesh.

If you are interested in showing line segments around, you can use transparent BoxHelper in combination with LineSegments and EdgesGeometry.

Props

Prop nameDescriptionTypeDefault
castShadow Whether the object gets rendered into shadow map.booleanfalse
material Optional name of the material.
This allows reusing of the material.
unionnull
mesh Name of the target mesh.string""
name Name of the box Mesh.string""
position A Vector3Like representing the object's local position.Vector3Like[0, 0, 0]
receiveShadowWhether the material receives shadows.booleanfalse
rotation A Vector3Like representing local rotation (see Euler angles), in radians.Vector3Like[0, 0, 0]
scale A Vector3Like representing the object's local scale.Vector3Like[1, 1, 1]

Slots

NameDescriptionBindings
default

Expose

three


Released under the MIT License.