implicit function for a bounding box More...

#include <vtkBox.h>

Inheritance diagram for vtkBox:

Collaboration diagram for vtkBox:

Public Types
typedef vtkImplicitFunction	Superclass

Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkBox *	NewInstance () const

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 (const 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 (const 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)

Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long	GetMTime ()

double	FunctionValue (const double x[3])

double	FunctionValue (double x, double y, double z)

void	FunctionGradient (const double x[3], double g[3])

double *	FunctionGradient (const double x[3])

double *	FunctionGradient (double x, double y, double z)

virtual void	SetTransform (vtkAbstractTransform *)

virtual void	SetTransform (const double elements[16])

virtual vtkAbstractTransform *	GetTransform ()

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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkBox *	SafeDownCast (vtkObjectBase *o)

static vtkBox *	New ()


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


static int	IntersectWithLine (const double bounds[6], const double p1[3], const double p2[3], double &t1, double &t2, double x1[3], double x2[3], int &plane1, int &plane2)

Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)

static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBox ()

	~vtkBox ()

Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()

	~vtkImplicitFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkBoundingBox *	BBox

double	Bounds [6]

Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform

double	ReturnValue [3]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Tests:: vtkBox (Tests)

Definition at line 40 of file vtkBox.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkBox::Superclass

Definition at line 43 of file vtkBox.h.

Constructor & Destructor Documentation

vtkBox::vtkBox ( )

protected

vtkBox::~vtkBox ( )

protected

Member Function Documentation

static int vtkBox::IsTypeOf ( const char * type )

static

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

static vtkBox* vtkBox::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkBox::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkBox* vtkBox::NewInstance ( ) const

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 vtkObject.

static vtkBox* vtkBox::New ( )

static

Construct box with center at (0,0,0) and each side of length 1.0.

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

Definition at line 52 of file vtkBox.h.

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

Set / get the bounding box using various methods.

Definition at line 132 of file vtkBox.h.

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 p[3] )

inline

Definition at line 137 of file vtkBox.h.

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 ( const 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 ( const 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.)

static int vtkBox::IntersectWithLine	(	const double	bounds[6],
		const double	p1[3],
		const double	p2[3],
		double &	t1,
		double &	t2,
		double	x1[3],
		double	x2[3],
		int &	plane1,
		int &	plane2
	)

static

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

Member Data Documentation

vtkBoundingBox* vtkBox::BBox

protected

Definition at line 122 of file vtkBox.h.

double vtkBox::Bounds[6]

protected

Definition at line 123 of file vtkBox.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkBox.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation