Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


BoundsInt

Represents an axis aligned bounding box with all values as integers.
Read time 1 minuteLast updated 4 days ago

Definition

public struct BoundsInt : IEquatable<BoundsInt>, IFormattable

Remarks

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

Properties

Property

Description

allPositionsWithinA PositionCollection that contains all positions within the BoundsInt.
centerThe center of the bounding box.
maxThe maximal point of the box.
minThe minimal point of the box.
positionThe position of the bounding box.
sizeThe total size of the box.
xX value of the minimal point of the box.
xMaxThe maximal x point of the box.
xMinThe minimal x point of the box.
yY value of the minimal point of the box.
yMaxThe maximal y point of the box.
yMinThe minimal y point of the box.
zZ value of the minimal point of the box.
zMaxThe maximal z point of the box.
zMinThe minimal z point of the box.

Methods

Method

Description

ClampToBoundsClamps the position and size of this bounding box to the given bounds.
ContainsIs
point
contained in the bounding box?
SetMinMaxSets the bounds to the
min
and
max
value of the box.
ToStringReturns a formatted string for the bounds.

Structs

Struct

Description

BoundsInt.PositionEnumeratorAn iterator that allows you to iterate over all positions within the BoundsInt.