Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Bounds

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Represents an axis aligned bounding box.

An axis-aligned bounding box, or AABB for short, is a box aligned with coordinate axes and fully enclosing some object. Because the box is never rotated with respect to the axes, it can be defined by just its center and extents, or alternatively by min and max points.

/Bounds/ is used by Collider.bounds, Mesh.bounds, Renderer.bounds.

Variables

center The center of the bounding box.
extents The extents of the box. This is always half of the size.
max The maximal point of the box. This is always equal to center+extents.
min The minimal point of the box. This is always equal to center-extents.
size The total size of the box. This is always twice as large as the extents.

Constructors

Bounds Creates new Bounds with a given center and total size. Bound extents will be half the given size.

Functions

Contains Is point contained in the bounding box?
Encapsulate Grows the Bounds to include the point.
Expand Expand the bounds by increasing its size by amount along each side.
IntersectRay Does ray intersect this bounding box?
Intersects Does another bounding box intersect with this bounding box?
SetMinMax Sets the bounds to the min and max value of the box.
SqrDistance The smallest squared distance between the point and this bounding box.
ToString Returns a nicely formatted string for the bounds.