com.openinventor.inventor

Class SbXfBox3f

java.lang.Object

com.openinventor.inventor.SbBasic

com.openinventor.inventor.SbBox3f

com.openinventor.inventor.SbXfBox3f

public class SbXfBox3f
extends SbBox3f

3D box with an associated transformation matrix. A 3D box with an arbitrary transformation applied. This class is useful when a box will be transformed frequently; if an SbBox3f is used for this purpose it will expand each time it is transformed in order to keep itself axis-aligned. Transformations can be accumulated on an SbXfBox3f without expanding the box, and after all transformations have been done, the box can be expanded to an axis-aligned box if necessary.

See also:

SbBox3f, SbBox2f, SbBox2s, SbVec3f, SbVec2f, SbVec2s, SbMatrix, SoGetBoundingBoxAction

Field Summary

Fields inherited from class com.openinventor.inventor.SbBox3f

array

Constructor Summary

Constructors

Constructor and Description
SbXfBox3f() Constructor.
SbXfBox3f(float[] components)
SbXfBox3f(SbBox3f box) Constructor.
SbXfBox3f(SbVec3f _min, SbVec3f _max) Constructor.
SbXfBox3f(SbXfBox3f copyFrom)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	extendBy(SbBox3f bb) Extends the box (if necessary) to contain the given box.
void	extendBy(SbVec3f pt) Extends the box (if necessary) to contain the given 3D point.
void	extendBy(SbXfBox3f bb) Extends the box (if necessary) to contain the given box.
float[]	getBounds() Gets the bounds of the box.
SbVec3f	getCenter() Returns the center of the box.
SbMatrix	getInverse() Gets the inverse of the transformation on the box.
SbVec3f[]	getMinMax() Gets the bounds of the box.
float[]	getOrigin() Returns origin (minimum point) of the box.
float[]	getSpan(SbVec3f direction) Finds the extent of the box along a particular direction.
SbMatrix	getTransform() Gets the transformation on the box.
float[]	getValue()
float	getVolume() Gives the volume of the box (0 for an empty box).
boolean	hasVolume() Checks if the box has volume; i.e., all three dimensions have positive size.
boolean	intersect(SbBox3f bb) Returns true if intersection of given box and this box is not empty.
boolean	intersect(SbVec3f pt) Returns true if intersection of given point and this box is not empty.
boolean	isEmpty() Returns true if the box is empty, and false otherwise.
void	makeEmpty() Sets the box to contain nothing.
SbBox3f	project() Projects an SbXfBox3f to an SbBox3f.
void	setBounds(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) Sets the bounds of the box.
void	setBounds(SbVec3f _min, SbVec3f _max) Sets the bounds of the box.
void	setTransform(SbMatrix m) Sets the transformation on the box.
SbXfBox3f	setValue(float[] components)
SbXfBox3f	setValue(float[] components, int startIndex)
SbXfBox3f	setValue(SbXfBox3d xfbox3d) Sets value of the box from a double precision box.
void	setValue(SbXfBox3f copyFrom)
static SbXfBox3f[]	toArray(long nativeArray, long length)
void	transform(SbMatrix m) Transforms the box by the given matrix.

Methods inherited from class com.openinventor.inventor.SbBox3f

computeMaxDistance2, contains, getClosestPoint, getMax, getMin, getSize, intersection, outside, setValue, triangleBoxOverlap

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SbXfBox3f

public SbXfBox3f(float[] components)

SbXfBox3f

public SbXfBox3f(SbXfBox3f copyFrom)

SbXfBox3f

public SbXfBox3f()

Constructor. The box is initially empty.

SbXfBox3f

public SbXfBox3f(SbBox3f box)

Constructor.

SbXfBox3f

public SbXfBox3f(SbVec3f _min,
                 SbVec3f _max)

Constructor.

Method Detail

setValue

public SbXfBox3f setValue(float[] components,
                          int startIndex)

Overrides:

setValue in class SbBox3f

setValue

public SbXfBox3f setValue(float[] components)

Overrides:

setValue in class SbBox3f

getValue

public float[] getValue()

Overrides:

getValue in class SbBox3f

setValue

public void setValue(SbXfBox3f copyFrom)

getSpan

public float[] getSpan(SbVec3f direction)

Finds the extent of the box along a particular direction.

Overrides:

getSpan in class SbBox3f

toArray

public static SbXfBox3f[] toArray(long nativeArray,
                                  long length)

transform

public void transform(SbMatrix m)

Transforms the box by the given matrix.

Overrides:

transform in class SbBox3f

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SbBox3f

project

public SbBox3f project()

Projects an SbXfBox3f to an SbBox3f.

extendBy

public void extendBy(SbVec3f pt)

Extends the box (if necessary) to contain the given 3D point. If the box has had a non-identity transformation applied using the setTransform() method, the point is assumed to be in the transformed space. For example, the following code sequence:

 SbXfBox3f bbox = new SbXfBox3f();
 bbox.extendBy(new SbVec3f(0, 0, 0));
 SbMatrix trans = new SbMatrix();
 trans.setTranslate(new SbVec3f(1, 1, 1));
 bbox.setTransform(trans);
 bbox.extendBy(new SbVec3f(0, 0, 0));

will result in a bounding box extending from (-1,-1,-1) to (0,0,0) in the bbox's local (untransformed) space.

Overrides:

extendBy in class SbBox3f

setValue

public SbXfBox3f setValue(SbXfBox3d xfbox3d)

Sets value of the box from a double precision box.

getInverse

public SbMatrix getInverse()

Gets the inverse of the transformation on the box.

setBounds

public void setBounds(float xmin,
                      float ymin,
                      float zmin,
                      float xmax,
                      float ymax,
                      float zmax)

Sets the bounds of the box.

Overrides:

setBounds in class SbBox3f

setBounds

public void setBounds(SbVec3f _min,
                      SbVec3f _max)

Sets the bounds of the box.

Overrides:

setBounds in class SbBox3f

getTransform

public SbMatrix getTransform()

Gets the transformation on the box.

extendBy

public void extendBy(SbXfBox3f bb)

Extends the box (if necessary) to contain the given box.

extendBy

public void extendBy(SbBox3f bb)

Extends the box (if necessary) to contain the given box. If the box has had a non-identity transformation applied using the setTransform() method, the given SbBox3f is assumed to be in the transformed space.

Overrides:

extendBy in class SbBox3f

getCenter

public SbVec3f getCenter()

Returns the center of the box.

Overrides:

getCenter in class SbBox3f

intersect

public boolean intersect(SbBox3f bb)

Returns true if intersection of given box and this box is not empty.

Overrides:

intersect in class SbBox3f

intersect

public boolean intersect(SbVec3f pt)

Returns true if intersection of given point and this box is not empty.

Overrides:

intersect in class SbBox3f

makeEmpty

public void makeEmpty()

Sets the box to contain nothing.

Overrides:

makeEmpty in class SbBox3f

isEmpty

public boolean isEmpty()

Returns true if the box is empty, and false otherwise. Note: Setting the box to all zeros does not make it "empty". Use the makeEmpty() method. (This method only returns true if the maximum X value is less than the minimum X value.)

Overrides:

isEmpty in class SbBox3f

hasVolume

public boolean hasVolume()

Checks if the box has volume; i.e., all three dimensions have positive size.

Overrides:

hasVolume in class SbBox3f

setTransform

public void setTransform(SbMatrix m)

Sets the transformation on the box.

getBounds

public float[] getBounds()

Gets the bounds of the box.

Overrides:

getBounds in class SbBox3f

getMinMax

public SbVec3f[] getMinMax()

Gets the bounds of the box.

Overrides:

getMinMax in class SbBox3f

getVolume

public float getVolume()

Gives the volume of the box (0 for an empty box).

Overrides:

getVolume in class SbBox3f

getOrigin

public float[] getOrigin()

Returns origin (minimum point) of the box.

Overrides:

getOrigin in class SbBox3f