mikera.vectorz.geom

Class BoundBox

java.lang.Object

mikera.vectorz.geom.BoundBox

All Implemented Interfaces:

Cloneable

public final class BoundBox
extends Object
implements Cloneable

3D Bounding box constructed from two Vector3 components

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
mikera.vectorz.Vector3	lower
mikera.vectorz.Vector3	upper

Constructor Summary

Constructors

Constructor and Description
BoundBox() Creates an empty BoundBox
BoundBox(mikera.vectorz.AVector a) Create a BoundBox including a Single point
BoundBox(mikera.vectorz.AVector a, mikera.vectorz.AVector b)
BoundBox(BoundBox bb) Construct a BoundBox as an exact deep copy of another BoundBox
BoundBox(BoundBox bb, double margin) Construct a BoundBox with a margin around an existing BoundBox
BoundBox(mikera.vectorz.Vector3 a, double margin) Creates a boundbox with a margin around a single point.

Method Summary

Methods

Modifier and Type	Method and Description
BoundBox	clone()
boolean	contains(BoundBox bb)
boolean	contains(double x, double y, double z)
boolean	equals(BoundBox b)
boolean	equals(Object o)
int	hashCode()
void	include(mikera.vectorz.AVector a)
void	include(BoundBox bb)
void	include(double x, double y, double z) Includes a single point specified by x,y,z.
void	include(mikera.vectorz.Vector3 a)
void	include(mikera.vectorz.Vector3 point, double margin)
void	include(mikera.vectorz.Vector3 lower, mikera.vectorz.Vector3 upper) Includes the bounds between two vectors.
void	includeEverything() Adds everything to the BoundBox
void	includeX(double x) Ensures a specific x value is included.
void	includeY(double y) Ensures a specific y value is included.
void	includeZ(double z) Ensures a specific z value is included.
void	setToPoint(mikera.vectorz.Vector3 a)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lower

public final mikera.vectorz.Vector3 lower

upper

public final mikera.vectorz.Vector3 upper

Constructor Detail

BoundBox

public BoundBox(BoundBox bb)

Construct a BoundBox as an exact deep copy of another BoundBox

BoundBox

public BoundBox()

Creates an empty BoundBox

BoundBox

public BoundBox(BoundBox bb,
        double margin)

Construct a BoundBox with a margin around an existing BoundBox

BoundBox

public BoundBox(mikera.vectorz.Vector3 a,
        double margin)

Creates a boundbox with a margin around a single point. Sufficient to bound a

BoundBox

public BoundBox(mikera.vectorz.AVector a)

Create a BoundBox including a Single point

BoundBox

public BoundBox(mikera.vectorz.AVector a,
        mikera.vectorz.AVector b)

Method Detail

include

public void include(double x,
           double y,
           double z)

Includes a single point specified by x,y,z. Extends the boundbox as required.

includeX

public void includeX(double x)

Ensures a specific x value is included. Does not affect other bounds.

includeY

public void includeY(double y)

Ensures a specific y value is included. Does not affect other bounds.

includeZ

public void includeZ(double z)

Ensures a specific z value is included. Does not affect other bounds.

include

public void include(mikera.vectorz.AVector a)

include

public void include(mikera.vectorz.Vector3 a)

include

public void include(mikera.vectorz.Vector3 lower,
           mikera.vectorz.Vector3 upper)

Includes the bounds between two vectors. Assumes upper and lower are already correctly ordered.

include

public void include(BoundBox bb)

setToPoint

public void setToPoint(mikera.vectorz.Vector3 a)

clone

public BoundBox clone()

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(BoundBox b)

contains

public boolean contains(double x,
               double y,
               double z)

contains

public boolean contains(BoundBox bb)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

includeEverything

public void includeEverything()

Adds everything to the BoundBox

include

public void include(mikera.vectorz.Vector3 point,
           double margin)

toString

public String toString()

Overrides:

toString in class Object