DzBox3 Class Reference
[Basic Objects]

A 3D box. More...

List of all members.

Properties

DzVec3 max
Number maxX
Number maxY
Number maxZ
DzVec3 min
Number minX
Number minY
Number minZ

Constructors



 DzBox3 (Number xMin, Number yMin, Number zMin, Number xMax, Number yMax, Number zMax)
 DzBox3 (DzVec3 min, DzVec3 max)
 DzBox3 (DzBox3 box)

Methods

DzVec3 getCenter ()
Number getSize ()
DzBox3 getTransformedBox (DzMatrix3 mat)
void include (DzBox3 box)
void include (DzVec3 point)
void translate (DzVec3 vec)


Detailed Description

A 3D box.

Represents a 3D box by storing two 3D vectors - an upper and lower corner for the box.


Constructor & Destructor Documentation

DzBox3::DzBox3 ( DzBox3  box  ) 

Copy Constructor.

Parameters:
box The box to copy.

DzBox3::DzBox3 ( DzVec3  min,
DzVec3  max 
)

Creates an initialized box with the given min and max values.

Parameters:
min The minimum corner of the box.
max The maximum corner of the box.

DzBox3::DzBox3 ( Number  xMin,
Number  yMin,
Number  zMin,
Number  xMax,
Number  yMax,
Number  zMax 
)

Creates an initialized box with the given min and max values.

Parameters:
xmin The minimum value for the box on the x axis
ymin The minimum value for the box on the y axis
zmin The minimum value for the box on the z axis
xmax The maximum value for the box on the x axis
ymax The maximum value for the box on the y axis
zmax The maximum value for the box on the z axis


Member Function Documentation

DzVec3 DzBox3::getCenter (  ) 

Returns:
The center point of the box.

Number DzBox3::getSize (  ) 

Returns:
The corner to corner distance of this box.

DzBox3 DzBox3::getTransformedBox ( DzMatrix3  mat  ) 

Creates a new box by transforming the corners of this box through the given matrix and then including them.

Returns:
A copy of this box that has been transformed by the matrix.

void DzBox3::include ( DzBox3  box  ) 

Grows the box, if necessary, to include the given box.

Parameters:
box The box to include in the box

void DzBox3::include ( DzVec3  point  ) 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
pnt The point to include in the box

void DzBox3::translate ( DzVec3  vec  ) 

Translates the corners of the box by adding the given vector.


Member Data Documentation

DzVec3 DzBox3::max

The maximum corner of the box

Number DzBox3::maxX

The maximum value of the box on the x axis

Number DzBox3::maxY

The maximum value of the box on the y axis

Number DzBox3::maxZ

The maximum value of the box on the z axis

DzVec3 DzBox3::min

The minimum corner of the box

Number DzBox3::minX

The minimum value of the box on the x axis

Number DzBox3::minY

The minimum value of the box on the y axis

Number DzBox3::minZ

The minimum value of the box on the z axis


Generated on Thu Sep 24 12:21:11 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.