api/org.kryptonmc.api.util/BoundingBox

BoundingBox

data class BoundingBox(val minX: Double, val minY: Double, val minZ: Double, val maxX: Double, val maxY: Double, val maxZ: Double) : Record

An area in 3D space defined by two sets of points, a minimum and a maximum.

This area forms a box, which can be used for collision detection. If a bounding box intersects with something, we know that the two objects are colliding.

This is immutable, and as such, any method that would alter the state of the bounding box returns a new instance with the requested changes.

Constructors

BoundingBox

constructor(min: Vec3d, max: Vec3d)

Creates a new bounding box with the given min and max values.

constructor(min: Vec3i, max: Vec3i)

Creates a new bounding box with the given min and max values.

constructor(minX: Double, minY: Double, minZ: Double, maxX: Double, maxY: Double, maxZ: Double)

Types

Companion

object Companion

Functions

center

fun center(): Vec3d

Gets a vector representing the center of this bounding box on the X, Y, and Z axes.

contains

fun contains(x: Double, y: Double, z: Double): Boolean

Checks if the given x, y, and z values are inside the bounds of this box.

contract

fun contract(amount: Double): BoundingBox

fun contract(amount: Vec3d): BoundingBox

Contracts this bounding box by the given amount and returns the result.

fun contract(x: Double, y: Double, z: Double): BoundingBox

Contracts this bounding box by the given x, y, and z amounts and returns the result.

deflate

fun deflate(factor: Double): BoundingBox

Deflates this bounding box by the given factor and returns the result.

fun deflate(x: Double, y: Double, z: Double): BoundingBox

Deflates this bounding box by the given x, y, and z amounts and returns the result.

expand

fun expand(amount: Double): BoundingBox

fun expand(amount: Vec3d): BoundingBox

Expands this bounding box by the given amount and returns the result.

fun expand(x: Double, y: Double, z: Double): BoundingBox

Expands this bounding box by the given x, y, and z amounts and returns the result.

inflate

fun inflate(factor: Double): BoundingBox

Deflates this bounding box by the given factor and returns the result.

fun inflate(x: Double, y: Double, z: Double): BoundingBox

Inflates this bounding box by the given x, y, and z amounts and returns the result.

intersect

fun intersect(other: BoundingBox): BoundingBox

Intersects this bounding box with the given other box and returns the result.

intersects

fun intersects(other: BoundingBox): Boolean

Checks if this bounding box intersects with the given other box.

max

fun max(): Vec3d

Gets the maximum vector of this bounding box.

fun max(axis: Direction.Axis): Double

Gets the maximum value on the given axis.

min

fun min(): Vec3d

Gets the minimum vector of this bounding box.

fun min(axis: Direction.Axis): Double

Gets the minimum value on the given axis.

move

fun move(amount: Double): BoundingBox

fun move(amount: Vec3d): BoundingBox

Moves this bounding box by the given amount and returns the result.

fun move(x: Double, y: Double, z: Double): BoundingBox

Moves this bounding box by the given x, y, and z amounts and returns the result.

size

fun size(): Vec3d

Gets a vector representing the size of this bounding box on the X, Y, and Z axes.

totalSize

fun totalSize(): Double

Calculates the total size of this bounding box.

volume

fun volume(): Double

Calculates the volume of this bounding box.

Properties

maxX

val maxX: Double

The maximum X value.

maxY

val maxY: Double

The maximum Y value.

maxZ

val maxZ: Double

The maximum Z value.

minX

val minX: Double

The minimum X value.

minY

val minY: Double

The minimum Y value.

minZ

val minZ: Double

The minimum Z value.