Package com.ardor3d.scenegraph.shape

Class Box

java.lang.Object

com.ardor3d.scenegraph.Spatial

com.ardor3d.scenegraph.Mesh

com.ardor3d.scenegraph.shape.Box

All Implemented Interfaces:

Pickable, Hintable, Renderable, Savable, Cloneable

Direct Known Subclasses:

MultiFaceBox

public class Box
extends Mesh
implements Cloneable

Box is an axis-aligned rectangular prism defined by a center point and x, y, and z extents from that center (essentially radii.)

Field Summary

Fields inherited from class com.ardor3d.scenegraph.Mesh

_defaultColor, _isVisible, _lightState, _meshData, _modelBound, _states, RENDER_VERTEX_ONLY

Fields inherited from class com.ardor3d.scenegraph.Spatial

_controllers, _delegateMap, _dirtyMark, _frustumIntersects, _listener, _localTransform, _name, _parent, _queueDistance, _renderStateList, _sceneHints, _userData, _worldBound, _worldTransform, ON_DIRTY_ATTACHED, ON_DIRTY_BOUNDING, ON_DIRTY_RENDERSTATE, ON_DIRTY_TRANSFORM, ON_DIRTY_TRANSFORM_ONLY

Constructor Summary

Constructors

Constructor	Description
Box()	Constructs a new 1x1x1 Box.
Box(String name)	Constructs a new 1x1x1 Box with the given name.
Box(String name, ReadOnlyVector3 center, double xExtent, double yExtent, double zExtent)	Constructs a new Box object using the given center and extents.
Box(String name, ReadOnlyVector3 pntA, ReadOnlyVector3 pntB)	Constructs a new Box object using the given two points as opposite corners of the box.

Method Summary

Modifier and Type	Method	Description
Box	clone()	clone creates a new Box object containing the same data as this one.
Vector3[]	computeVertices()
ReadOnlyVector3	getCenter()
double	getXExtent()
double	getYExtent()
double	getZExtent()
void	read(InputCapsule capsule)
void	setData(ReadOnlyVector3 center, double xExtent, double yExtent, double zExtent)	Updates the center point and extents of this box using the defined values.
void	setData(ReadOnlyVector3 pntA, ReadOnlyVector3 pntB)	Updates the center point and extents of this box to match an axis-aligned box defined by the two given opposite corners.
protected void	setVertexData()	setVertexData sets the vertex positions that define the box using the center point and defined extents.
void	write(OutputCapsule capsule)

Methods inherited from class com.ardor3d.scenegraph.Mesh

applyWorldRenderStates, draw, getClassTag, getDefaultColor, getLightState, getMeshData, getModelBound, getModelBound, getWorldNormals, getWorldRenderState, getWorldVectors, intersectsPrimitivesWhere, intersectsWorldBound, intersectsWorldBoundsWhere, isVisible, makeCopy, makeInstanced, render, render, renderArrays, renderVBO, reorderIndices, reorderVertexData, reorderVertexData, setDefaultColor, setDefaultColor, setLightState, setMeshData, setModelBound, setModelBound, setRandomColors, setSolidColor, setVisible, sortLights, supportsBoundsIntersectionRecord, supportsPrimitivesIntersectionRecord, updateModelBound, updateWorldBound

Methods inherited from class com.ardor3d.scenegraph.Spatial

acceptVisitor, addController, addTranslation, addTranslation, clearControllers, clearDirty, clearDirty, clearRenderState, getController, getControllerCount, getControllers, getCurrentRenderDelegate, getLastFrustumIntersection, getListener, getLocalLastFrustumIntersection, getLocalRenderState, getLocalRenderStates, getName, getParent, getParentHintable, getRenderDelegate, getRotation, getScale, getSceneHints, getTransform, getTranslation, getUserData, getWorldBound, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, isDirty, localToWorld, markDirty, markDirty, onDraw, propagateBoundToRoot, propagateDirtyDown, propagateDirtyUp, propagateStatesFromRoot, propageEventUp, removeController, removeController, removeFromParent, setLastFrustumIntersection, setListener, setName, setParent, setRenderDelegate, setRenderState, setRotation, setRotation, setScale, setScale, setScale, setTransform, setTranslation, setTranslation, setUserData, setWorldRotation, setWorldRotation, setWorldScale, setWorldScale, setWorldScale, setWorldTransform, setWorldTranslation, setWorldTranslation, toString, updateChildren, updateControllers, updateGeometricState, updateGeometricState, updateWorldRenderStates, updateWorldRenderStates, updateWorldTransform, worldToLocal

Methods inherited from class java.lang.Object

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

Constructor Details

Box

public Box()

Constructs a new 1x1x1 Box.

Box

public Box(String name)

Constructs a new 1x1x1 Box with the given name.

Parameters:

name - the name to give this new box. This is required for identification and comparison purposes.

Box

public Box(String name,
 ReadOnlyVector3 pntA,
 ReadOnlyVector3 pntB)

Constructs a new Box object using the given two points as opposite corners of the box. These two points may be in any order.

Parameters:

name - the name to give this new box. This is required for identification and comparison purposes.

pntA - the first point

pntB - the second point.

Box

public Box(String name,
 ReadOnlyVector3 center,
 double xExtent,
 double yExtent,
 double zExtent)

Constructs a new Box object using the given center and extents. Since the extents represent the distance from the center of the box to the edge, the full length of a side is actually 2 * extent.

Parameters:

name - the name to give this new box. This is required for identification and comparison purposes.

center - Center of the box.

xExtent - x extent of the box

yExtent - y extent of the box

zExtent - z extent of the box

Method Details

getCenter

public ReadOnlyVector3 getCenter()

Returns:

the current center of this box.

getXExtent

public double getXExtent()

Returns:

the current X extent of this box.

getYExtent

public double getYExtent()

Returns:

the current Y extent of this box.

getZExtent

public double getZExtent()

Returns:

the current Z extent of this box.

setData

public void setData(ReadOnlyVector3 pntA,
 ReadOnlyVector3 pntB)

Updates the center point and extents of this box to match an axis-aligned box defined by the two given opposite corners.

Parameters:

pntA - the first point

pntB - the second point.

setData

public void setData(ReadOnlyVector3 center,
 double xExtent,
 double yExtent,
 double zExtent)

Updates the center point and extents of this box using the defined values.

Parameters:

center - The center of the box.

xExtent - x extent of the box

yExtent - y extent of the box

zExtent - z extent of the box

setVertexData

protected void setVertexData()

setVertexData sets the vertex positions that define the box using the center point and defined extents.

clone

public Box clone()

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

Overrides:

clone in class Object

Returns:

the new Box

computeVertices

public Vector3[] computeVertices()

Returns:

a size 8 array of Vectors representing the 8 points of the box.

write

public void write(OutputCapsule capsule)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class Mesh

Parameters:

capsule - the capsule

Throws:

IOException - Signals that an I/O exception has occurred.

See Also:

• Savable.write(OutputCapsule)

read

public void read(InputCapsule capsule)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class Mesh

Parameters:

capsule - the input capsule

Throws:

IOException - Signals that an I/O exception has occurred.

See Also:

• Savable.read(InputCapsule)