Class Box3

Represents an axis-aligned bounding box (AABB) in 3D space.

Hierarchy

  • Base
    • Box3

Constructors

constructor

Properties

max min

Accessors

isBox2 isBox3 isColor isCylindrical isEuler isLine3 isMatrix3 isMatrix4 isPlane isQuaternion isRay isSphere isSpherical isTriangle isVector2 isVector3 isVector4

Methods

applyMatrix4 clampPoint clone containsBox containsPoint copy distanceToPoint equals expandByPoint expandByScalar expandByVector getBoundingSphere getCenter getParameter getSize intersect intersectsBox intersectsPlane intersectsSphere intersectsTriangle isEmpty makeEmpty set setFromArray setFromCenterAndSize setFromPoints translate union

Constructors

constructor

  • Creates a Box3 bounded by min and max.

    Parameters

    • min: Vector3 = ...

      (optional) Vector3 representing the lower (x, y, z) boundary of the box. Default is ( + Infinity, + Infinity, + Infinity ).

    • max: Vector3 = ...

      (optional) Vector3 representing the upper (x, y, z) boundary of the box. Default is ( - Infinity, - Infinity, - Infinity ).

    Returns Box3

Properties

max

max: Vector3

Vector3 representing the upper (x, y, z) boundary of the box. Default is ( - Infinity, - Infinity, - Infinity ).

min

min: Vector3

Vector3 representing the lower (x, y, z) boundary of the box. Default is ( + Infinity, + Infinity, + Infinity ).

Accessors

isBox2

  • get isBox2(): boolean

  • Returns boolean

isBox3

  • get isBox3(): boolean

  • Read-only flag to check if a given object is of type Box3.

    Returns boolean

isColor

  • get isColor(): boolean

  • Returns boolean

isCylindrical

  • get isCylindrical(): boolean

  • Returns boolean

isEuler

  • get isEuler(): boolean

  • Returns boolean

isLine3

  • get isLine3(): boolean

  • Returns boolean

isMatrix3

  • get isMatrix3(): boolean

  • Returns boolean

isMatrix4

  • get isMatrix4(): boolean

  • Returns boolean

isPlane

  • get isPlane(): boolean

  • Returns boolean

isQuaternion

  • get isQuaternion(): boolean

  • Returns boolean

isRay

  • get isRay(): boolean

  • Returns boolean

isSphere

  • get isSphere(): boolean

  • Returns boolean

isSpherical

  • get isSpherical(): boolean

  • Returns boolean

isTriangle

  • get isTriangle(): boolean

  • Returns boolean

isVector2

  • get isVector2(): boolean

  • Returns boolean

isVector3

  • get isVector3(): boolean

  • Returns boolean

isVector4

  • get isVector4(): boolean

  • Returns boolean

Methods

applyMatrix4

  • Transforms this Box3 with the supplied matrix.

    Returns

    This instance.

    Parameters

    • matrix: Matrix4

      The Matrix4 to apply

    Returns Box3

clampPoint

  • Clamps the point within the bounds of this box.

    Returns

    A new clamped Vector3.

    Parameters

    • point: Vector3

      Vector3 to clamp.

    • target: Vector3 = ...

      — the result will be copied into this Vector3.

    Returns Vector3

clone

  • Returns a new Box3 with the same min and max as this one.

    Returns

    A new instance.

    Returns Box3

containsBox

  • containsBox(box: Box3): boolean

  • Test if this box includes the entirety of box.

    Returns

    True if this box includes the entirety of box. If this and box are identical, this function also returns true.

    Parameters

    • box: Box3

      Box3 to test for inclusion.

    Returns boolean

containsPoint

  • containsPoint(point: Vector3): boolean

  • Test if the specified point lies within or on the boundaries of this box.

    Returns

    True if the specified point lies within or on the boundaries of this box.

    Parameters

    • point: Vector3

      Vector3 to check for inclusion.

    Returns boolean

copy

  • Copies the min and max from box to this box.

    Returns

    This instance.

    Parameters

    • box: Box3

      Box3 to copy.

    Returns Box3

distanceToPoint

  • distanceToPoint(point: Vector3): number

  • Find 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.

    Returns

    Returns the distance.

    Parameters

    • point: Vector3

      Vector3 to measure distance to.

    Returns number

equals

  • equals(box: Box3): boolean

  • Test if this box and box share the same lower and upper bounds.

    Returns

    True if this box and box share the same lower and upper bounds.

    Parameters

    • box: Box3

      Box to compare with this one.

    Returns boolean

expandByPoint

  • Expands the boundaries of this box to include point.

    Returns

    This instance.

    Parameters

    • point: Vector3

      Vector3 that should be included in the box.

    Returns Box3

expandByScalar

  • expandByScalar(scalar: number): Box3

  • Expands each dimension of the box by scalar. If negative, the dimensions of the box will be contracted.

    Returns

    This instance.

    Parameters

    • scalar: number

      Distance to expand the box by.

    Returns Box3

expandByVector

  • Expands this box equilaterally by vector. The width of this box will be expanded by the x component of vector in both directions. The height of this box will be expanded by the y component of vector in both directions. The depth of this box will be expanded by the z component of vector in both directions.

    Returns

    This instance.

    Parameters

    • vector: Vector3

      Vector3 to expand the box by.

    Returns Box3

getBoundingSphere

  • Gets a Sphere that bounds the box.

    Returns

    The bounding sphere.

    Parameters

    • target: Sphere

      The result will be copied into this Sphere.

    Returns Sphere

getCenter

  • Find the center point of the box as a Vector3.

    Returns

    The center point.

    Parameters

    • target: Vector3 = ...

      The result will be copied into this Vector3.

    Returns Vector3

getParameter

  • Given a point inside a box, find it's relative proportion to the box's width, height and depth.

    Returns

    The 3D propportions.

    Parameters

    • point: Vector3

      A point inside the box

    • target: Vector3 = ...

      The result will be copied into this Vector3.

    Returns Vector3

getSize

  • Get the width, height and depth of this box.

    Returns

    The box dimensions.

    Parameters

    • target: Vector3 = ...

      The result will be copied into this Vector3.

    Returns Vector3

intersect

  • Computes the intersection of this and box, setting the upper bound of this box to the lesser of the two boxes' upper bounds and the lower bound of this box to the greater of the two boxes' lower bounds. If there's no overlap, makes this box empty.

    Returns

    This instance.

    Parameters

    • box: Box3

      Box to intersect with.

    Returns Box3

intersectsBox

  • intersectsBox(box: Box3): boolean

  • Determines whether or not this box intersects box.

    Returns

    True if box intersects this box.

    Parameters

    • box: Box3

      Box to check for intersection against.

    Returns boolean

intersectsPlane

  • intersectsPlane(plane: Plane): boolean

  • Determines whether or not this box intersects plane.

    Returns

    True if this box intersects the plane.

    Parameters

    • plane: Plane

      Plane to check for intersection against.

    Returns boolean

intersectsSphere

  • intersectsSphere(sphere: Sphere): boolean

  • Determines whether or not this box intersects sphere.

    Returns

    True if this box overlaps any part of a sphere.

    Parameters

    • sphere: Sphere

      Sphere to check for intersection against.

    Returns boolean

intersectsTriangle

  • intersectsTriangle(triangle: Triangle): boolean

  • Determines whether or not this box intersects triangle.

    Returns

    True if this box overlaps triangle anywhere.

    Parameters

    • triangle: Triangle

      Triangle to check for intersection against.

    Returns boolean

isEmpty

  • isEmpty(): boolean

  • Returns true if this box includes zero points within its bounds. Note that a box with equal lower and upper bounds still includes one point, the one both bounds share.

    Returns

    True if box includes zero points.

    Returns boolean

makeEmpty

  • Makes this box empty.

    Returns

    This instance.

    Returns Box3

set

  • Sets the lower and upper (x, y, z) boundaries of this box. Note that this method only copies the values from the given objects.

    Returns

    This instance.

    Parameters

    • min: Vector3

      Vector3 representing the lower (x, y, z) boundary of the box.

    • max: Vector3

      Vector3 representing the upper (x, y, z) boundary of the box.

    Returns Box3

setFromArray

  • setFromArray(array: number[]): Box3

  • Sets the upper and lower bounds of this box to include all of the data in array.

    Returns

    This instance.

    Parameters

    • array: number[]

      An array of position data that the resulting box will envelop.

    Returns Box3

setFromCenterAndSize

  • Centers this box on center and sets this box's width, height and depth to the values specified in size.

    Returns

    This instance.

    Parameters

    • center: Vector3

      Desired center position of the box.

    • size: Vector3

      Desired x, y and z dimensions of the box.

    Returns Box3

setFromPoints

  • Sets the upper and lower bounds of this box to include all of the points in points.

    Returns

    This instance.

    Parameters

    • points: Vector3[]

      Array of Vector3s that the resulting box will contain.

    Returns Box3

translate

  • Adds offset to both the upper and lower bounds of this box, effectively moving this box offset units in 3D space.

    Returns

    This instance.

    Parameters

    • offset: Vector3

      Direction and distance of offset.

    Returns Box3

union

  • 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.

    Returns

    This instance.

    Parameters

    • box: Box3

      Box that will be unioned with this box.

    Returns Box3

Settings

Member Visibility

Theme