Constructor
new Box3(min, max)
Methods
applyMatrix4(matrix) → {Box3}
Transforms this Box3 with the supplied matrix.
| Name | Type | Description |
|---|---|---|
matrix | Matrix4 | The Matrix4 to apply |
- Type:
- Box3
clampPoint(point, target) → {Vector3}
Clamps the point within the bounds of this box.
| Name | Type | Description |
|---|---|---|
point | Vector3 | Vector3 to clamp. |
target | Vector3 | Vector3 to store the result in. |
- Type:
- Vector3
clone() → {Box3}
Returns a new Box3 with the same min and max as this one.
- Type:
- Box3
containsPoint(point) → {boolean}
Returns true if the specified point lies within or on the boundaries of this box.
| Name | Type | Description |
|---|---|---|
point | Vector3 | Vector3 to check for inclusion. |
- Type:
- boolean
copy(box) → {Box3}
Copies the min and max from box to this box.
| Name | Type | Description |
|---|---|---|
box | Box3 | Box3 to copy. |
- Type:
- Box3
distanceToPoint(point) → {number}
Returns the distance from any edge of this box to the specified point. If the point lies inside of this box, the distance will be 0.
| Name | Type | Description |
|---|---|---|
point | Vector3 | Vector3 to measure the distance to. |
- Type:
- number
equals(box) → {boolean}
Returns true if this box and box share the same lower and upper bounds.
| Name | Type | Description |
|---|---|---|
box | Box3 | Box to compare with this one. |
- Type:
- boolean
expandByBox3(box3) → {Box3}
Expands the boundaries of this box to include box3.
| Name | Type | Description |
|---|---|---|
box3 | Box3 | Box that will be unioned with this box. |
- Type:
- Box3
expandByPoint(point) → {Box3}
Expands the boundaries of this box to include point.
| Name | Type | Description |
|---|---|---|
point | Vector3 | Vector3 that should be included in the box. |
- Type:
- Box3
expandByScalar(scalar) → {Box3}
Expands each dimension of the box by scalar. If negative, the dimensions of the box will be contracted.
| Name | Type | Description |
|---|---|---|
scalar | number | Distance to expand the box by. |
- Type:
- Box3
getBoundingSphere(target) → {Sphere}
Returns aMinimum Bounding Sphere for the box.
| Name | Type | Description |
|---|---|---|
target | Sphere | — the result will be copied into this Sphere. |
- Type:
- Sphere
getCenter(target) → {Vector3}
Returns the center point of the box as a Vector3.
| Name | Type | Description |
|---|---|---|
target | Vector3 | the result will be copied into this Vector3. |
- Type:
- Vector3
getPoints(points) → {Array.<Vector3>}
Get the 8 corner points of the bounding box, the order is as follows: 7-------3 /| /| 4-------0 | | | | | | 6-----|-2 |/ |/ 5-------1
| Name | Type | Description |
|---|---|---|
points | Array.<Vector3> | The array to store the points. |
The array of points.
- Type:
- Array.<Vector3>
getSize(target) → {Vector3}
Returns the width, height and depth of this box.
| Name | Type | Description |
|---|---|---|
target | Vector3 | the result will be copied into this Vector3. |
- Type:
- Vector3
intersectsTriangle(triangle) → {boolean}
Determines whether or not this box intersects triangle.
| Name | Type | Description |
|---|---|---|
triangle | Triangle | Triangle to check for intersection against. |
- Type:
- boolean
isEmpty() → {boolean}
Returns true if this box includes zero points within its bounds.
- Type:
- boolean
makeEmpty() → {Box3}
Makes this box empty.
- Type:
- Box3
set(min, max)
Sets the lower and upper (x, y, z) boundaries of this box.
| Name | Type | Description |
|---|---|---|
min | Vector3 | Vector3 representing the lower (x, y, z) boundary of the box. |
max | Vector3 | Vector3 representing the lower upper (x, y, z) boundary of the box. |
setFromArray(array, gapopt, offsetopt) → {Box3}
Sets the upper and lower bounds of this box to include all of the data in array.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
array | Array.<number> | An array of position data that the resulting box will envelop. | ||
gap | number | <optional> | 3 | |
offset | number | <optional> | 0 |
- Type:
- Box3
setFromPoints(points) → {Box3}
Sets the upper and lower bounds of this box to include all of the points in points.
| Name | Type | Description |
|---|---|---|
points | Array.<Vector3> | Array of Vector3s that the resulting box will contain. |
- Type:
- Box3
union(box) → {Box3}
Computes the union of this box and box, setting the upper bound of this box to the greater of the two boxes' upper bounds and the lower bound of this box to the lesser of the two boxes' lower bounds.
| Name | Type | Description |
|---|---|---|
box | Box3 | Box that will be unioned with this box. |
- Type:
- Box3