vtkBox Class Reference
#include <vtkBox.h>
Detailed Description
implicit function for a bounding boxvtkBox computes the implicit function and/or gradient for a axis-aligned bounding box. (The superclasses transform can be used to modify this orientation.) Each side of the box is orthogonal to all other sides meeting along shared edges and all faces are orthogonal to the x-y-z coordinate axes. (If you wish to orient this box differently, recall that the superclass vtkImplicitFunction supports a transformation matrix.) vtkCube is a concrete implementation of vtkImplicitFunction.
- See also:
- vtkCubeSource vtkImplicitFunction
- Tests:
- vtkBox (Tests)
Definition at line 39 of file vtkBox.h.
Public Types | |
| typedef vtkImplicitFunction | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | EvaluateGradient (double x[3], double n[3]) |
| void | SetXMax (double p[3]) |
| void | SetXMax (double x, double y, double z) |
| void | GetXMax (double p[3]) |
| void | GetXMax (double &x, double &y, double &z) |
| void | SetBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax) |
| void | SetBounds (double bounds[6]) |
| void | GetBounds (double &xMin, double &xMax, double &yMin, double &yMax, double &zMin, double &zMax) |
| void | GetBounds (double bounds[6]) |
| double * | GetBounds () |
| void | AddBounds (double bounds[6]) |
| double | EvaluateFunction (double x[3]) |
| double | EvaluateFunction (double x, double y, double z) |
| void | SetXMin (double p[3]) |
| void | SetXMin (double x, double y, double z) |
| void | GetXMin (double p[3]) |
| void | GetXMin (double &x, double &y, double &z) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkBox * | SafeDownCast (vtkObject *o) |
| static vtkBox * | New () |
| static char | IntersectBox (double bounds[6], double origin[3], double dir[3], double coord[3], double &t) |
Protected Member Functions | |
| vtkBox () | |
| ~vtkBox () | |
Protected Attributes | |
| vtkBoundingBox * | BBox |
| double | Bounds [6] |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkBox::vtkBox | ( | ) | [protected] |
| vtkBox::~vtkBox | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkBox::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkImplicitFunction.
| static int vtkBox::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction.
| virtual int vtkBox::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction.
Reimplemented from vtkImplicitFunction.
| void vtkBox::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkImplicitFunction.
| static vtkBox* vtkBox::New | ( | ) | [static] |
Construct box with center at (0,0,0) and each side of length 1.0.
Reimplemented from vtkObject.
| double vtkBox::EvaluateFunction | ( | double | x[3] | ) | [virtual] |
Evaluate box defined by the two points (pMin,pMax).
Implements vtkImplicitFunction.
| double vtkBox::EvaluateFunction | ( | double | x, | |
| double | y, | |||
| double | z | |||
| ) | [inline] |
Evaluate box defined by the two points (pMin,pMax).
Reimplemented from vtkImplicitFunction.
| void vtkBox::EvaluateGradient | ( | double | x[3], | |
| double | n[3] | |||
| ) | [virtual] |
Evaluate the gradient of the box.
Implements vtkImplicitFunction.
| void vtkBox::SetXMin | ( | double | p[3] | ) | [inline] |
| void vtkBox::SetXMin | ( | double | x, | |
| double | y, | |||
| double | z | |||
| ) |
Set / get the bounding box using various methods.
| void vtkBox::GetXMin | ( | double | p[3] | ) |
Set / get the bounding box using various methods.
| void vtkBox::GetXMin | ( | double & | x, | |
| double & | y, | |||
| double & | z | |||
| ) |
Set / get the bounding box using various methods.
| void vtkBox::SetXMax | ( | double | x, | |
| double | y, | |||
| double | z | |||
| ) |
| void vtkBox::GetXMax | ( | double | p[3] | ) |
| void vtkBox::GetXMax | ( | double & | x, | |
| double & | y, | |||
| double & | z | |||
| ) |
| void vtkBox::SetBounds | ( | double | xMin, | |
| double | xMax, | |||
| double | yMin, | |||
| double | yMax, | |||
| double | zMin, | |||
| double | zMax | |||
| ) |
| void vtkBox::SetBounds | ( | double | bounds[6] | ) |
| void vtkBox::GetBounds | ( | double & | xMin, | |
| double & | xMax, | |||
| double & | yMin, | |||
| double & | yMax, | |||
| double & | zMin, | |||
| double & | zMax | |||
| ) |
| void vtkBox::GetBounds | ( | double | bounds[6] | ) |
| double* vtkBox::GetBounds | ( | ) |
| void vtkBox::AddBounds | ( | double | bounds[6] | ) |
A special method that allows union set operation on bounding boxes. Start with a SetBounds(). Subsequent AddBounds() methods are union set operations on the original bounds. Retrieve the final bounds with a GetBounds() method.
| static char vtkBox::IntersectBox | ( | double | bounds[6], | |
| double | origin[3], | |||
| double | dir[3], | |||
| double | coord[3], | |||
| double & | t | |||
| ) | [static] |
Bounding box intersection modified from Graphics Gems Vol I. The method returns a non-zero value if the bounding box is hit. Origin[3] starts the ray, dir[3] is the vector components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line. (Notes: the intersection ray dir[3] is NOT normalized. Valid intersections will only occur between 0<=t<=1.)
Member Data Documentation
vtkBoundingBox* vtkBox::BBox [protected] |
double vtkBox::Bounds[6] [protected] |
The documentation for this class was generated from the following file:
- dox/Common/vtkBox.h
