com.jme.bounding
Class OBB2

java.lang.Object
  com.jme.bounding.OBB2

All Implemented Interfaces:

BoundingVolume, java.io.Serializable

public class OBB2

extends java.lang.Object

implements BoundingVolume

Started Date: Sep 5, 2004

This class is like an OrientedBoundingBox, but lacks the overhead of extending TriMesh.

Author:

Jack Lindamood

See Also:

Serialized Form

Field Summary

Vector3f	center Center of the Oriented Box.
Vector3f	extent Extents of the box along the x,y,z axis.
Vector3f	xAxis X axis of the Oriented Box.
Vector3f	yAxis Y axis of the Oriented Box.
Vector3f	zAxis Z axis of the Oriented Box.

Constructor Summary

OBB2()

Method Summary

java.lang.Object	clone(BoundingVolume store) clone creates a new BoundingVolume object containing the same data as this one.
void	computeCorners() Sets the vectorStore information to the 8 corners of the box.
void	computeFromPoints(Vector3f[] points) computeFromPoints generates a bounding volume that encompasses a collection of points.
void	computeFromTris(com.jme.bounding.OBBTree.TreeTriangle[] tris, int start, int end)
float	distanceTo(Vector3f point) Find the distance from the center of this Bounding Volume to the given point.
Vector3f	getCenter(Vector3f store) This function stores the approximate center of the bounding volume into the store vector.
int	getCheckPlane(int index) get the value for a given index in the checkplanes
void	initCheckPlanes() initCheckPlanes resets the checkplanes to their standard order.
boolean	intersection(OBB2 box1)
boolean	intersects(BoundingVolume bv) determines if this bounding volume and a second given volume are intersecting.
boolean	intersects(Ray ray) determines if a ray intersects this bounding volume.
boolean	intersectsBoundingBox(BoundingBox bb) determines if this bounding volume and a given bounding box are intersecting.
boolean	intersectsOBB2(OBB2 obb) determines if this bounding volume and a given oriented bounding box are intersecting.
boolean	intersectsOrientedBoundingBox(OrientedBoundingBox obb) determines if this bounding volume and a given oriented bounding box are intersecting.
boolean	intersectsSphere(BoundingSphere bs) determines if this bounding volume and a given bounding sphere are intersecting.
BoundingVolume	merge(BoundingVolume volume) merge combines two bounding volumes into a single bounding volume that contains both this bounding volume and the parameter volume.
BoundingVolume	mergeLocal(BoundingVolume volume) mergeLocal combines two bounding volumes into a single bounding volume that contains both this bounding volume and the parameter volume.
void	recomputeMesh() Reconstruct a visible mesh for the bound.
void	setCheckPlane(int index, int value) set the value for a given index in the checkplanes
BoundingVolume	transform(Matrix3f rotate, Vector3f translate, Vector3f scale, BoundingVolume store)
BoundingVolume	transform(Quaternion rotate, Vector3f translate, Vector3f scale) transform alters the location of the bounding volume by a rotation, translation and a scalar.
BoundingVolume	transform(Quaternion rotate, Vector3f translate, Vector3f scale, BoundingVolume store) transform alters the location of the bounding volume by a rotation, translation and a scalar.
int	whichSide(Plane plane) whichSide returns the side on which the bounding volume lies on a plane.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

center

public final Vector3f center

Center of the Oriented Box.

xAxis

public final Vector3f xAxis

X axis of the Oriented Box.

yAxis

public final Vector3f yAxis

Y axis of the Oriented Box.

zAxis

public final Vector3f zAxis

Z axis of the Oriented Box.

extent

public final Vector3f extent

Extents of the box along the x,y,z axis.

Constructor Detail

OBB2

public OBB2()

Method Detail

transform

public BoundingVolume transform(Quaternion rotate,
                                Vector3f translate,
                                Vector3f scale)

Description copied from interface: BoundingVolume

transform alters the location of the bounding volume by a rotation, translation and a scalar.

Specified by:

transform in interface BoundingVolume

Parameters:

rotate - the rotation to affect the bound.

translate - the translation to affect the bound.

scale - the scale to resize the bound.

Returns:

the new bounding volume.

transform

public BoundingVolume transform(Quaternion rotate,
                                Vector3f translate,
                                Vector3f scale,
                                BoundingVolume store)

Description copied from interface: BoundingVolume

transform alters the location of the bounding volume by a rotation, translation and a scalar.

Specified by:

transform in interface BoundingVolume

Parameters:

rotate - the rotation to affect the bound.

translate - the translation to affect the bound.

scale - the scale to resize the bound.

store - sphere to store result in

Returns:

the new bounding volume.

transform

public BoundingVolume transform(Matrix3f rotate,
                                Vector3f translate,
                                Vector3f scale,
                                BoundingVolume store)

whichSide

public int whichSide(Plane plane)

Description copied from interface: BoundingVolume

whichSide returns the side on which the bounding volume lies on a plane. Possible values are POSITIVE_SIDE, NEGATIVE_SIDE, and NO_SIDE.

Specified by:

whichSide in interface BoundingVolume

Parameters:

plane - the plane to check against this bounding volume.

Returns:

the side on which this bounding volume lies.

See Also:

Point

computeFromPoints

public void computeFromPoints(Vector3f[] points)

Description copied from interface: BoundingVolume

computeFromPoints generates a bounding volume that encompasses a collection of points.

Specified by:

computeFromPoints in interface BoundingVolume

Parameters:

points - the points to contain.

merge

public BoundingVolume merge(BoundingVolume volume)

Description copied from interface: BoundingVolume

merge combines two bounding volumes into a single bounding volume that contains both this bounding volume and the parameter volume.

Specified by:

merge in interface BoundingVolume

Parameters:

volume - the volume to combine.

Returns:

the new merged bounding volume.

mergeLocal

public BoundingVolume mergeLocal(BoundingVolume volume)

Description copied from interface: BoundingVolume

mergeLocal combines two bounding volumes into a single bounding volume that contains both this bounding volume and the parameter volume. The result is stored locally.

Specified by:

mergeLocal in interface BoundingVolume

Parameters:

volume - the volume to combine.

Returns:

this

clone

public java.lang.Object clone(BoundingVolume store)

Description copied from interface: BoundingVolume

clone creates a new BoundingVolume object containing the same data as this one.

Specified by:

clone in interface BoundingVolume

Parameters:

store - where to store the cloned information. if null or wrong class, a new store is created.

Returns:

the new BoundingVolume

initCheckPlanes

public void initCheckPlanes()

Description copied from interface: BoundingVolume

initCheckPlanes resets the checkplanes to their standard order.

Specified by:

initCheckPlanes in interface BoundingVolume

getCheckPlane

public int getCheckPlane(int index)

Description copied from interface: BoundingVolume

get the value for a given index in the checkplanes

Specified by:

getCheckPlane in interface BoundingVolume

Parameters:

index -

Returns:

setCheckPlane

public void setCheckPlane(int index,
                          int value)

Description copied from interface: BoundingVolume

set the value for a given index in the checkplanes

Specified by:

setCheckPlane in interface BoundingVolume

Parameters:

index -

value -

recomputeMesh

public void recomputeMesh()

Description copied from interface: BoundingVolume

Reconstruct a visible mesh for the bound.

Specified by:

recomputeMesh in interface BoundingVolume

distanceTo

public float distanceTo(Vector3f point)

Description copied from interface: BoundingVolume

Find the distance from the center of this Bounding Volume to the given point.

Specified by:

distanceTo in interface BoundingVolume

Parameters:

point - The point to get the distance to

Returns:

distance

getCenter

public Vector3f getCenter(Vector3f store)

Description copied from interface: BoundingVolume

This function stores the approximate center of the bounding volume into the store vector. For easy function usage, the store vector should be returned when the function is complete.

Specified by:

getCenter in interface BoundingVolume

Parameters:

store - The vector to store the center in.

computeCorners

public void computeCorners()

Sets the vectorStore information to the 8 corners of the box.

computeFromTris

public void computeFromTris(com.jme.bounding.OBBTree.TreeTriangle[] tris,
                            int start,
                            int end)

intersection

public boolean intersection(OBB2 box1)

intersects

public boolean intersects(BoundingVolume bv)

Description copied from interface: BoundingVolume

determines if this bounding volume and a second given volume are intersecting. Intersecting being: one volume contains another, one volume overlaps another or one volume touches another.

Specified by:

intersects in interface BoundingVolume

Parameters:

bv - the second volume to test against.

Returns:

true if this volume intersects the given volume.

intersectsSphere

public boolean intersectsSphere(BoundingSphere bs)

Description copied from interface: BoundingVolume

determines if this bounding volume and a given bounding sphere are intersecting.

Specified by:

intersectsSphere in interface BoundingVolume

Parameters:

bs - the bounding sphere to test against.

Returns:

true if this volume intersects the given bounding sphere.

intersectsBoundingBox

public boolean intersectsBoundingBox(BoundingBox bb)

Description copied from interface: BoundingVolume

determines if this bounding volume and a given bounding box are intersecting.

Specified by:

intersectsBoundingBox in interface BoundingVolume

Parameters:

bb - the bounding box to test against.

Returns:

true if this volume intersects the given bounding box.

intersectsOrientedBoundingBox

public boolean intersectsOrientedBoundingBox(OrientedBoundingBox obb)

Description copied from interface: BoundingVolume

determines if this bounding volume and a given oriented bounding box are intersecting.

Specified by:

intersectsOrientedBoundingBox in interface BoundingVolume

Parameters:

obb - the bounding box to test against.

Returns:

true if this volume intersects the given oriented bounding box.

intersectsOBB2

public boolean intersectsOBB2(OBB2 obb)

Description copied from interface: BoundingVolume

determines if this bounding volume and a given oriented bounding box are intersecting.

Specified by:

intersectsOBB2 in interface BoundingVolume

Parameters:

obb - the bounding box to test against.

Returns:

true if this volume intersects the given oriented bounding box.

intersects

public boolean intersects(Ray ray)

Description copied from interface: BoundingVolume

determines if a ray intersects this bounding volume.

Specified by:

intersects in interface BoundingVolume

Parameters:

ray - the ray to test.

Returns:

true if this volume is intersected by a given ray.