AnyCAD Rapid SDK  2020
The Rapid CAD SDK
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
AxisAlignedBox Class Reference

Classes

class  CornerEnum
 
class  Extent
 

Public Member Functions

synchronized void delete ()
 
 AxisAlignedBox (AxisAlignedBox.Extent e)
 
 AxisAlignedBox (AxisAlignedBox rkBox)
 
 AxisAlignedBox (Vector3 min, Vector3 max)
 
 AxisAlignedBox (float mx, float my, float mz, float Mx, float My, float Mz)
 
Vector3 getMinimum ()
 
Vector3 getMaximum ()
 
void setMinimum (Vector3 vec)
 
void setMinimum (float x, float y, float z)
 
void setMinimumX (float x)
 
void setMinimumY (float y)
 
void setMinimumZ (float z)
 
void setMaximum (Vector3 vec)
 
void setMaximum (float x, float y, float z)
 
void setMaximumX (float x)
 
void setMaximumY (float y)
 
void setMaximumZ (float z)
 
void setExtents (Vector3 min, Vector3 max)
 
void setExtents (float mx, float my, float mz, float Mx, float My, float Mz)
 
Vec3List getAllCorners ()
 
Vector3 getCorner (AxisAlignedBox.CornerEnum cornerToGet)
 
void merge (AxisAlignedBox rhs)
 
void merge (Vector3 point)
 
Vector3 matPlusVec3 (Matrix4 m, Vector3 v)
 
void transform (Matrix4 matrix)
 
void setNull ()
 
boolean isNull ()
 
boolean isFinite ()
 
void setInfinite ()
 
boolean isInfinite ()
 
boolean intersects (AxisAlignedBox b2)
 
AxisAlignedBox intersection (AxisAlignedBox b2)
 
float volume ()
 
void scale (Vector3 s)
 
boolean intersects (Sphere s)
 
boolean intersects (Plane p)
 
boolean intersects (Vector3 v)
 
Vector3 getCenter ()
 
Vector3 getSize ()
 
Vector3 getHalfSize ()
 
boolean contains (Vector3 v)
 
float squaredDistance (Vector3 v)
 
float distance (Vector3 v)
 
boolean contains (AxisAlignedBox other)
 

Static Public Member Functions

static AxisAlignedBox getBOX_NULL ()
 
static AxisAlignedBox getBOX_INFINITE ()
 

Protected Member Functions

 AxisAlignedBox (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long getCPtr (AxisAlignedBox obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

A 3D box aligned with the x/y/z axes.
Remarks:
This class represents a simple box which is aligned with the
axes. Internally it only stores 2 points as the extremeties of
the box, one which is the minima of all 3 axes, and the other
which is the maxima of all 3 axes. This class is typically used
for an axis-aligned bounding box (AABB) for collision and
visibility determination.

Member Function Documentation

boolean AxisAlignedBox.contains ( Vector3  v)

Tests whether the given point contained by this box.

boolean AxisAlignedBox.contains ( AxisAlignedBox  other)

Tests whether another box contained by this box.

float AxisAlignedBox.distance ( Vector3  v)

Returns the minimum distance between a given point and any part of the box.

Vec3List AxisAlignedBox.getAllCorners ( )

Returns a pointer to an array of 8 corner points, useful for
collision vs. non-aligned objects.
Remarks:
If the order of these corners is important, they are as
follows: The 4 points of the minimum Z face (note that
because Ogre uses right-handed coordinates, the minimum Z is
at the 'back' of the box) starting with the minimum point of
all, then anticlockwise around this face (if you are looking
onto the face from outside the box). Then the 4 points of the
maximum Z face, starting with maximum point of all, then
anticlockwise around this face (looking onto the face from
outside the box). Like this:


1----—2
| /|
| / |
5----—4 |
| 0-—|–3
| / | /
|/ |/
6----—7
Vector3 AxisAlignedBox.getCenter ( )

Gets the centre of the box

Vector3 AxisAlignedBox.getCorner ( AxisAlignedBox.CornerEnum  cornerToGet)

Gets the position of one of the corners

Vector3 AxisAlignedBox.getHalfSize ( )

Gets the half-size of the box

Vector3 AxisAlignedBox.getMaximum ( )

Gets the maximum corner of the box.

Vector3 AxisAlignedBox.getMinimum ( )

Gets the minimum corner of the box.

Vector3 AxisAlignedBox.getSize ( )

Gets the size of the box

AxisAlignedBox AxisAlignedBox.intersection ( AxisAlignedBox  b2)

Calculate the area of intersection of this box and another

boolean AxisAlignedBox.intersects ( AxisAlignedBox  b2)

Returns whether or not this box intersects another.

boolean AxisAlignedBox.intersects ( Sphere  s)

Tests whether this box intersects a sphere.

boolean AxisAlignedBox.intersects ( Plane  p)

Tests whether this box intersects a plane.

boolean AxisAlignedBox.intersects ( Vector3  v)

Tests whether the vector point is within this box.

boolean AxisAlignedBox.isFinite ( )

Returns true if the box is finite.

boolean AxisAlignedBox.isInfinite ( )

Returns true if the box is infinite.

boolean AxisAlignedBox.isNull ( )

Returns true if the box is null i.e. empty.

Vector3 AxisAlignedBox.matPlusVec3 ( Matrix4  m,
Vector3  v 
)

Transforms the box according to the matrix supplied.
Remarks:
By calling this method you get the axis-aligned box which
surrounds the transformed version of this box. Therefore each
corner of the box is transformed by the matrix, then the
extents are mapped back onto the axes to produce another
AABB. Useful when you have a local AABB for an object which
is then transformed.

void AxisAlignedBox.merge ( AxisAlignedBox  rhs)

Merges the passed in box into the current box. The result is the
box which encompasses both.

void AxisAlignedBox.merge ( Vector3  point)

Extends the box to encompass the specified point (if needed).

void AxisAlignedBox.scale ( Vector3  s)

Scales the AABB by the vector given.

void AxisAlignedBox.setExtents ( Vector3  min,
Vector3  max 
)

Sets both minimum and maximum extents at once.

void AxisAlignedBox.setInfinite ( )

Sets the box to 'infinite'

void AxisAlignedBox.setMaximum ( Vector3  vec)

Sets the maximum corner of the box.

void AxisAlignedBox.setMaximumX ( float  x)

Changes one of the components of the maximum corner of the box
used to resize only one dimension of the box

void AxisAlignedBox.setMinimum ( Vector3  vec)

Sets the minimum corner of the box.

void AxisAlignedBox.setMinimumX ( float  x)

Changes one of the components of the minimum corner of the box
used to resize only one dimension of the box

void AxisAlignedBox.setNull ( )

Transforms the box according to the affine matrix supplied.
Remarks:
By calling this method you get the axis-aligned box which
surrounds the transformed version of this box. Therefore each
corner of the box is transformed by the matrix, then the
extents are mapped back onto the axes to produce another
AABB. Useful when you have a local AABB for an object which
is then transformed.
Sets the box to a 'null' value i.e. not a box.

float AxisAlignedBox.squaredDistance ( Vector3  v)

Returns the squared minimum distance between a given point and any part of the box.
This is faster than distance since avoiding a squareroot, so use if you can.

float AxisAlignedBox.volume ( )

Calculate the volume of this box