vtkBox Class Reference

#include <vtkBox.h>

Inheritance diagram for vtkBox:

[legend]Collaboration diagram for vtkBox:

[legend]List of all members.

Detailed Description

implicit function for a bounding box

vtkBox 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

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (87%)
Martin, Ken (10%)

CVS logs (CVSweb):

.cxx (/Common/vtkBox.cxx)
.h (/Common/vtkBox.h)

Tests:: vtkBox (Tests)

Definition at line 49 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])

double EvaluateFunction (double x[3])

double EvaluateFunction (double x, double y, double z)

virtual void SetXMin (double, double, double)

virtual void SetXMin (double[3])

virtual double * GetXMin ()

virtual void GetXMin (double &, double &, double &)

virtual void GetXMin (double[3])

virtual void SetXMax (double, double, double)

virtual void SetXMax (double[3])

virtual double * GetXMax ()

virtual void GetXMax (double &, double &, double &)

virtual void GetXMax (double[3])

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])

Static Public Member Functions

int IsTypeOf (const char *type)

vtkBox * SafeDownCast (vtkObject *o)

vtkBox * New ()

char IntersectBox (double bounds[6], double origin[3], double dir[3], double coord[3], double &t)

Protected Member Functions

vtkBox ()

~vtkBox ()

Protected Attributes

double XMin [3]

double XMax [3]

Member Typedef Documentation

typedef vtkImplicitFunction vtkBox::Superclass

Reimplemented from vtkImplicitFunction.
Definition at line 52 of file vtkBox.h.

Constructor & Destructor Documentation

vtkBox::vtkBox ( ) [protected]

vtkBox::~vtkBox ( ) [inline, protected]

Definition at line 98 of file vtkBox.h.

Member Function Documentation

virtual const char* vtkBox::GetClassName ( ) [virtual]

Reimplemented from vtkImplicitFunction.

int vtkBox::IsTypeOf ( const char * type ) [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 * type ) [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.

vtkBox* vtkBox::SafeDownCast ( vtkObject * o ) [static]

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.

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.
Definition at line 61 of file vtkBox.h.
References vtkImplicitFunction::EvaluateFunction().

void vtkBox::EvaluateGradient ( double x[3],

double n[3]

) [virtual]

Evaluate the gradient of the box.
Implements vtkImplicitFunction.

virtual void vtkBox::SetXMin ( double ,

double ,

double

) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::SetXMin ( double [3] ) [virtual]

Set / get the bounding box using various methods.

virtual double* vtkBox::GetXMin ( ) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::GetXMin ( double & ,

double & ,

double &

) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::GetXMin ( double [3] ) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::SetXMax ( double ,

double ,

double

) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::SetXMax ( double [3] ) [virtual]

Set / get the bounding box using various methods.

virtual double* vtkBox::GetXMax ( ) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::GetXMax ( double & ,

double & ,

double &

) [virtual]

Set / get the bounding box using various methods.

virtual void vtkBox::GetXMax ( double [3] ) [virtual]

Set / get the bounding box using various methods.

void vtkBox::SetBounds ( double xMin,

double xMax,

double yMin,

double yMax,

double zMin,

double zMax

)

Set / get the bounding box using various methods.

void vtkBox::SetBounds ( double bounds[6] )

Set / get the bounding box using various methods.

void vtkBox::GetBounds ( double & xMin,

double & xMax,

double & yMin,

double & yMax,

double & zMin,

double & zMax

)

Set / get the bounding box using various methods.

void vtkBox::GetBounds ( double bounds[6] )

Set / get the bounding box using various methods.

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

double vtkBox::XMin[3] [protected]

Definition at line 100 of file vtkBox.h.

double vtkBox::XMax[3] [protected]

Definition at line 101 of file vtkBox.h.

The documentation for this class was generated from the following file:

dox/Common/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])

double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)

virtual void	SetXMin (double, double, double)
virtual void	SetXMin (double[3])
virtual double *	GetXMin ()
virtual void	GetXMin (double &, double &, double &)
virtual void	GetXMin (double[3])
virtual void	SetXMax (double, double, double)
virtual void	SetXMax (double[3])
virtual double *	GetXMax ()
virtual void	GetXMax (double &, double &, double &)
virtual void	GetXMax (double[3])
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])
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkBox *	SafeDownCast (vtkObject *o)
vtkBox *	New ()

char	IntersectBox (double bounds[6], double origin[3], double dir[3], double coord[3], double &t)
Protected Member Functions
	vtkBox ()
	~vtkBox ()
Protected Attributes
double	XMin [3]
double	XMax [3]