Class BoundingBoxUtils`Beta`

Bounding Box Utils is a utility class that provides a number of useful functions for the creation and utility of BoundingBox objects

Hierarchy

BoundingBoxUtils

Index

Constructors

Methods

createValid dilate equals expand getCenter getIntersection getSpan intersects isInside isValid translate

Constructors

`Private` constructor

new BoundingBoxUtils(): BoundingBoxUtils
Returns BoundingBoxUtils

Methods

`Static` createValid

createValid(min, max): BoundingBox
Parameters
- min: Vector3
  
  A corner world location
- max: Vector3
  
  A corner world location diametrically opposite
Returns BoundingBox

Remarks
Create a validated instance of a BoundingBox where the min and max components are guaranteed to be (min <= max)

This function can't be called in read-only mode.

`Static` dilate

dilate(box, size): BoundingBox
Parameters
- box: BoundingBox
- size: Vector3
Returns BoundingBox
Return a new BoundingBox object representing the changes

Remarks
Expand a BoundingBox by a given amount along each axis. Sizes can be negative to perform contraction. Note: corners can be inverted if the contraction size is greater than the span, but the min/max relationship will remain correct

This function can't be called in read-only mode.

`Static` equals

equals(box, other): boolean
Parameters
- box: BoundingBox
- other: BoundingBox
Returns boolean

Remarks
Check if two BoundingBox objects are identical

This function can't be called in read-only mode.

`Static` expand

expand(box, other): BoundingBox
Parameters
- box: BoundingBox
- other: BoundingBox
Returns BoundingBox
A new BoundingBox instance representing the smallest possible bounding box which can encompass both

Remarks
Expand the initial box object bounds to include the 2nd box argument. The resultant BoundingBox object will be a BoundingBox which exactly encompasses the two boxes.

This function can't be called in read-only mode.

`Static` getCenter

getCenter(box): Vector3
Parameters
- box: BoundingBox
Returns Vector3
Note that BoundingBox objects represent whole blocks, so the center of boxes which have odd numbered bounds are not mathematically centered... i.e. a BoundingBox( 0,0,0 -> 3,3,3 ) would have a center of (1,1,1) (not (1.5, 1.5, 1.5) as expected)

Remarks
Calculate the center block of a given BoundingBox object.

This function can't be called in read-only mode.

`Static` getIntersection

getIntersection(box, other): BoundingBox
Parameters
- box: BoundingBox
- other: BoundingBox
Returns BoundingBox

Remarks
Calculate the BoundingBox which represents the union area of two intersecting BoundingBoxes

This function can't be called in read-only mode.

`Static` getSpan

getSpan(box): Vector3
Parameters
- box: BoundingBox
Returns Vector3

Remarks
Get the Span of each of the BoundingBox Axis components

This function can't be called in read-only mode.

`Static` intersects

intersects(box, other): boolean
Parameters
- box: BoundingBox
- other: BoundingBox
Returns boolean

Remarks
Check to see if two BoundingBox objects intersect

This function can't be called in read-only mode.

`Static` isInside

isInside(box, pos): boolean
Parameters
- box: BoundingBox
- pos: Vector3
Returns boolean

Remarks
Check to see if a given coordinate is inside a BoundingBox

This function can't be called in read-only mode.

`Static` isValid

isValid(box): boolean
Parameters
- box: BoundingBox
Returns boolean

Remarks
Check to see if a BoundingBox is valid (i.e. (min <= max))

This function can't be called in read-only mode.

`Static` translate

translate(box, delta): BoundingBox
Parameters
- box: BoundingBox
- delta: Vector3
Returns BoundingBox
Return a new BoundingBox object which represents the change

Remarks
Move a BoundingBox by a given amount

This function can't be called in read-only mode.