# Box3I

## Description

`struct` `Tinman.Terrain.Util.Box3I`

A three-dimensional bounding box with 32-bit integer precision.

The coordinates refer to cubes (pixel-is-area semantic).

## Public / Constants

### Empty

`public` `static` `readonly` `attribute` `Empty` → `(Box3I)`

An empty bounding box at the coordinate origin.

### Inverse

`public` `static` `readonly` `attribute` `Inverse` → `(Box3I)`

An inverse bounding box that can be used as the initial value for computing bounds via subsequent calls to `Grow`.

### Max

`public` `static` `readonly` `attribute` `Max` → `(Box3I)`

The largest possible box.

Note that the dimension of this box is 2^32 (4294967296), which cannot be expressed using 32-bits. So instead `0` is returned.

## Public / Methods

### CheckIntersection

`[Pure]`
`public` `method` `CheckIntersection` → `(1)`

box in : Box3I

The other bounding box.

returns → int32

`-1` if the bounding boxes do not overlap, `1` if box in fully contains this bounding box and `0` if both bounding boxes overlap.

Checks the intersection between this bounding box and the given one.

### Clamp

`[Pure]`
`public` `method` `Clamp1` → `(3)`

in : int32

X-coordinate of point.

in : int32

Y-coordinate of point.

in : int32

Z-coordinate of point.

returns → Vec3I

The clamped point.

Clamps the given point to this box.

`[Pure]`
`public` `method` `Clamp2` → `(1)`

in : Vec3I

The point coordinates.

returns → Vec3I

The clamped point.

Clamps the given point to this box.

### ComputeOverlap

`[Pure]`
`public` `method` `ComputeOverlap` → `(1)`

box in : Box3I

Second bounding box.

returns → int32

The amount of overlap (i.e. the volume of the intersection).

Computes the overlap of this bounding box and the given one.

### Contains

`[Pure]`
`public` `method` `Contains1` → `(1)`

xyz in : Vec3I

The point coordinates.

returns → bool

`true` if this box contains the point, `false` if not.

Checks if this box contains the given point.

`[Pure]`
`public` `method` `Contains2` → `(3)`

in : int32

The point X-coordinate.

in : int32

The point Y-coordinate.

in : int32

The point Z-coordinate.

returns → bool

`true` if this box contains the point, `false` if not.

Checks if this box contains the given point.

`[Pure]`
`public` `method` `Contains3` → `(1)`

box in : Box3I

The other box.

returns → bool

`true` if this box fully contains the given box, `false` if not.

Checks if this box contains the given box.

### Disjoint

`[Pure]`
`public` `method` `Disjoint` → `(1)`

box in : Box3I

The other box.

returns → bool

`true` if this box and the given box are disjoint, `false` if not.

Checks if this box and the given box are disjoint (i.e. do not intersect).

### FromPoints

`[Pure]`
`public` `static` `method` `FromPoints1` → `(6)`

x1 in : int32

X-coordinate of first corner point.

y1 in : int32

Y-coordinate of first corner point.

z1 in : int32

Z-coordinate of first corner point.

x2 in : int32

X-coordinate of second corner point.

y2 in : int32

Y-coordinate of second corner point.

z2 in : int32

Z-coordinate of second corner point.

returns → Box3I

The bounding box.

Creates a new instance of Box3I from the given corner points.

`[Pure]`
`public` `static` `method` `FromPoints2` → `(2)`

in : Vec3I

First corner point.

in : Vec3I

Second corner point.

returns → Box3I

The bounding box.

Creates a new instance of Box3I from the given corner points.

### FromRect

`[Pure]`
`public` `static` `method` `FromRect` → `(6)`

in : int32

X-coordinate of top-left-front corner of cuboid.

in : int32

Y-coordinate of top-left-front corner of cuboid.

in : int32

Z-coordinate of top-left-front corner of cuboid.

width in : int32

`[>=0]`
Width of cuboid.

height in : int32

`[>=0]`
Height of cuboid.

depth in : int32

`[>=0]`
Depth of cuboid.

returns → Box3I

The bounding box.

Creates a new instance of Box3I from the given rectangular cuboid.

### Grow

`public` `method` `Grow1` → `(1)`

box in : Box3I

To other box.

returns → Box3I

The resulting box.

Enlarges the extends of this box so that it covers the given box.

`public` `method` `Grow2` → `(1)`

in : Vec3I

Coordinates of point to cover.

returns → Box3I

The resulting box.

Enlarges the extends of this box so that it covers the given point.

`public` `method` `Grow3` → `(3)`

in : int32

X-coordinate of point to cover.

in : int32

Y-coordinate of point to cover.

in : int32

Z-coordinate of point to cover.

returns → Box3I

The resulting box.

Enlarges the extends of this box so that it covers the given point.

### Intersect

`[Pure]`
`public` `method` `Intersect` → `(1)`

box in : Box3I

The bounding box.

returns → Box3I

The resulting bounding box.

Computes the intersection of the given bounding box and this one.

### Translate

`[Pure]`
`public` `method` `Translate1` → `(1)`

in : Vec3I

The translation vector.

returns → Box3I

The translated bounding box.

Translates this bounding box.

`[Pure]`
`public` `method` `Translate2` → `(3)`

in : int32

Translation amount along X-axis.

in : int32

Translation amount along Y-axis.

in : int32

Translation amount along Z-axis.

returns → Box3I

The resulting bounding box.

Translates this bounding box.

## Public / Attributes

### Center

`public` `attribute` `Center` → `(get)`

value : Vec3I

The coordinates of the box center.

Return the center of this box.

### Depth

`public` `attribute` `Depth` → `(get)`

value : int32

The box depth.

Returns the extends of this box along the Z-axis.

### Height

`public` `attribute` `Height` → `(get)`

value : int32

The box height.

Returns the extends of this box along the Y-axis.

### IsEmpty

`public` `attribute` `IsEmpty` → `(get)`

value : bool

`true` if this bounding box is empty, `false` if not.

Is this bounding box empty?

### Size

`public` `attribute` `Size` → `(get)`

value : Vec3I

The box size: The Width is stored in Vec3I.X, the Height in Vec3I.Y, the Depth in Vec3I.Z.

Returns the size of this box.

### Volume

`public` `attribute` `Volume` → `(get)`

value : int64

The bounding box volume.

Returns the volume of this bounding box.

The volume will always be `0` when IsEmpty returns `true`.

### Width

`public` `attribute` `Width` → `(get)`

value : int32

The box width.

Returns the extends of this box along the X-axis.

### X1

`public` `readonly` `attribute` `X1` → `(int32)`

X-coordinate of minimum corner of bounding box.

### X2

`public` `readonly` `attribute` `X2` → `(int32)`

X-coordinate of maximum corner of bounding box.

### Y1

`public` `readonly` `attribute` `Y1` → `(int32)`

Y-coordinate of minimum corner of bounding box.

### Y2

`public` `readonly` `attribute` `Y2` → `(int32)`

Y-coordinate of maximum corner of bounding box.

### Z1

`public` `readonly` `attribute` `Z1` → `(int32)`

Z-coordinate of minimum corner of bounding box.

### Z2

`public` `readonly` `attribute` `Z2` → `(int32)`

Z-coordinate of maximum corner of bounding box.

## Serialization

### Serializer

`public` `static` `readonly` `attribute` `Serializer` → `(ITypeSerializer<Box3I>)`

The serialization helper object for values of Box3I.