Box (Bonzai Engine bonzaiengine.com Copyright © 2007-2019 Jérôme Jouvie)

java.lang.Object
- com.bonzaiengine.visibility.Box

All Implemented Interfaces:

IInterpolable<Box>, IData<Box>, IValueCopy<Box>, IVolume<Box>, java.lang.Cloneable
```
public final class Box
extends java.lang.Object
implements IVolume<Box>
```

Constructor Summary

Constructors
Constructor and Description

Box(Vec3 min, Vec3 max)

Constructors
Constructor and Description
`Box(Vec3 min, Vec3 max)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Box`	`addScale(Box current, Box next, float t)`
`Box`	`clone()`
`boolean`	`collideWith(Sphere bs)` A Box-Sphere Intersection Test http://www.gamasutra.com/features/19991018/Gomez_4.htm
`Box`	`concatenate(Box other)` Concatenate this volume with other in a new `IVolume` object
`float`	`distanceToPlane(Plane plane, boolean min_)`
`static Box`	`empty()` Create an empty Box.
`Vec3`	`getCenter(Vec3 center)`
`Vec3`	`getMax()`
`Vec3`	`getMin()`
`Vec3`	`getSize(Vec3 size)`
`float`	`getVolume()`
`boolean`	`insideFrustum(Frustum frustum)` AABB
`Box`	`interpolate(Box current, Box next, float t)` Interpolate `this` bounding box with `bb` and return the new interpolated bounding box.
`IntersectTest`	`intersectTest(Box box)` Collision
`IntersectTest`	`intersectTest(Frustum frustum)` Test the intersection between this `IVolume` and the specified `Frustum`.
`IntersectTest`	`intersectTest(Plane plane)` Test the intersection between this `IVolume` and the specified `Frustum`.
`Vec3`	`limitInVolume(Vec3 dst, Vec3 src)` Limit a point in this volume.
`static Box`	`max()` Create a bounding box with `-Float.MAX_VALUE` as min and `Float.MAX_VALUE` as max.
`static Box`	`notInitialized()` Create a bounding box with `Float.MAX_VALUE` as min and `-Float.MAX_VALUE` as max.
`Box`	`set(Box bb)`
`Box`	`setCenterAndSize(Vec3 center, Vec3 size)`
`void`	`setMax(Vec3 max)`
`void`	`setMin(Vec3 min)`
`Box`	`subtract(Box bv1, Box bv2)`
`java.lang.String`	`toString()`
`Box`	`transform(Box bb, Mat4x4 matrix)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Box
```
public Box(Vec3 min,
           Vec3 max)
```
- Method Detail
  - notInitialized
```
public static Box notInitialized()
```
    Create a bounding box with Float.MAX_VALUE as min and -Float.MAX_VALUE as max.
    This is usefull to initialize with point cloud with min / max
  - max
```
public static Box max()
```
    Create a bounding box with -Float.MAX_VALUE as min and Float.MAX_VALUE as max.
  - empty
```
public static Box empty()
```
    Create an empty Box.
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clone
```
public final Box clone()
```
    Specified by:
    
    clone in interface IData<Box>
    
    Specified by:
    
    clone in interface IValueCopy<Box>
    
    Specified by:
    
    clone in interface IVolume<Box>
    
    Overrides:
    
    clone in class java.lang.Object
  - set
```
public final Box set(Box bb)
```
    Specified by:
    
    set in interface IValueCopy<Box>
  - setCenterAndSize
```
public final Box setCenterAndSize(Vec3 center,
                                  Vec3 size)
```
    Parameters:
    
    center - center of the bounding box
    
    size - size of the bounding box
  - getVolume
```
public final float getVolume()
```
    Specified by:
    
    getVolume in interface IVolume<Box>
    
    Returns:
    
    the volume of this IBoundable, in unit^3
  - transform
```
public final Box transform(Box bb,
                           Mat4x4 matrix)
```
    Specified by:
    
    transform in interface IVolume<Box>
    
    Parameters:
    
    bb - a IVolume
    
    matrix - a Mat4x4
    
    Returns:
    
    this = matrix * bv
  - concatenate
```
public final Box concatenate(Box other)
```
    Description copied from interface: IVolume
    
    Concatenate this volume with other in a new IVolume object
    
    Specified by:
    
    concatenate in interface IVolume<Box>
    
    Parameters:
    
    other - a IVolume
    
    Returns:
    
    new concatenated volume
    
    See Also:
    
    Volumes.concatenate(IVolume, IVolume)
  - interpolate
```
public final Box interpolate(Box current,
                             Box next,
                             float t)
```
    Interpolate this bounding box with bb and return the new interpolated bounding box.
    
    Specified by:
    
    interpolate in interface IInterpolable<Box>
    
    Specified by:
    
    interpolate in interface IData<Box>
    
    Specified by:
    
    interpolate in interface IVolume<Box>
    
    Parameters:
    
    current -
    
    next -
    
    t - value in the range [0.; 1.]
    
    Returns:
    
    this containing the interpolated bounding box
  - addScale
```
public final Box addScale(Box current,
                          Box next,
                          float t)
```
    Specified by:
    
    addScale in interface IVolume<Box>
    
    Parameters:
    
    current - a IVolume
    
    next - a IVolume
    
    Returns:
    
    this = bv1 + bv2 * t
  - subtract
```
public Box subtract(Box bv1,
                    Box bv2)
```
    Specified by:
    
    subtract in interface IVolume<Box>
    
    Parameters:
    
    bv1 - a IVolume
    
    bv2 - a IVolume
    
    Returns:
    
    this = bv1 - bv2
  - intersectTest
```
public IntersectTest intersectTest(Box box)
```
    Collision
    
    Specified by:
    
    intersectTest in interface IVolume<Box>
    
    Parameters:
    
    box - another volume
    
    Returns:
    
    true if this and the specified volume collides
  - collideWith
```
public final boolean collideWith(Sphere bs)
```
    A Box-Sphere Intersection Test http://www.gamasutra.com/features/19991018/Gomez_4.htm
  - limitInVolume
```
public final Vec3 limitInVolume(Vec3 dst,
                                Vec3 src)
```
    Description copied from interface: IVolume
    
    Limit a point in this volume. The point is displaced to the closest position (volume boundary) if it exceed this volume.
    
    Specified by:
    
    limitInVolume in interface IVolume<Box>
    
    Parameters:
    
    dst - destination vector to store the result
    
    src - source point
    
    Returns:
    
    dst
  - insideFrustum
```
public final boolean insideFrustum(Frustum frustum)
```
    AABB
    
    Specified by:
    
    insideFrustum in interface IVolume<Box>
    
    Returns:
    
    true if the volume is inside the frustum.
  - intersectTest
```
public final IntersectTest intersectTest(Frustum frustum)
```
    Description copied from interface: IVolume
    
    Test the intersection between this IVolume and the specified Frustum.
    
    Specified by:
    
    intersectTest in interface IVolume<Box>
    
    Returns:
    
    VolumeIntersection.Intersect if inside and intersect.
    VolumeIntersection.Inside if inside but not intersect.
    VolumeIntersection.Outisde if outside.
    
    See Also:
    
    IntersectTest, IVolume.insideFrustum(Frustum)
  - intersectTest
```
public final IntersectTest intersectTest(Plane plane)
```
    Description copied from interface: IVolume
    
    Test the intersection between this IVolume and the specified Frustum.
    
    Specified by:
    
    intersectTest in interface IVolume<Box>
    
    Returns:
    
    VolumeIntersection.Intersect if inside and intersect.
    VolumeIntersection.Inside if inside but not intersect.
    VolumeIntersection.Outisde if outside.
    
    See Also:
    
    IntersectTest, IVolume.insideFrustum(Frustum)
  - distanceToPlane
```
public final float distanceToPlane(Plane plane,
                                   boolean min_)
```
    Specified by:
    
    distanceToPlane in interface IVolume<Box>
    
    Parameters:
    
    plane - a Plane
    
    min_ - true: minimum distance
    false: maximum distance
    
    Returns:
    
    negative value: volume intersect of is outside.
    positive value: distance of the closest point
  - getMin
```
public final Vec3 getMin()
```
  - setMin
```
public final void setMin(Vec3 min)
```
  - getMax
```
public final Vec3 getMax()
```
  - setMax
```
public final void setMax(Vec3 max)
```
  - getCenter
```
public final Vec3 getCenter(Vec3 center)
```
  - getSize
```
public final Vec3 getSize(Vec3 size)
```

Class Box

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Box

Method Detail

notInitialized

max

empty

toString

clone

set

setCenterAndSize

getVolume

transform

concatenate

interpolate

addScale

subtract

intersectTest

collideWith

limitInVolume

insideFrustum

intersectTest

intersectTest

distanceToPlane

getMin

setMin

getMax

setMax

getCenter

getSize