abstract interface for implicit functions More...

#include <vtkImplicitFunction.h>

Inheritance diagram for vtkImplicitFunction:

Collaboration diagram for vtkImplicitFunction:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkImplicitFunction *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long	GetMTime ()

virtual void	EvaluateGradient (double x[3], double g[3])=0


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


virtual double	EvaluateFunction (double x[3])=0

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

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

abstract interface for implicit functions

vtkImplicitFunction specifies an abstract interface for implicit functions. Implicit functions are real valued functions defined in 3D space, w = F(x,y,z). Two primitive operations are required: the ability to evaluate the function, and the function gradient at a given point. The implicit function divides space into three regions: on the surface (F(x,y,z)=w), outside of the surface (F(x,y,z)>c), and inside the surface (F(x,y,z)<c). (When c is zero, positive values are outside, negative values are inside, and zero is on the surface. Note also that the function gradient points from inside to outside.)

Implicit functions are very powerful. It is possible to represent almost any type of geometry with the level sets w = const, especially if you use boolean combinations of implicit functions (see vtkImplicitBoolean).

vtkImplicitFunction provides a mechanism to transform the implicit function(s) via a vtkAbstractTransform. This capability can be used to translate, orient, scale, or warp implicit functions. For example, a sphere implicit function can be transformed into an oriented ellipse.

Warning: The transformation transforms a point into the space of the implicit function (i.e., the model space). Typically we want to transform the implicit model into world coordinates. In this case the inverse of the transformation is required.

See also: vtkAbstractTransform vtkSphere vtkCylinder vtkImplicitBoolean vtkPlane vtkPlanes vtkQuadric vtkImplicitVolume vtkSampleFunction vtkCutter vtkClipPolyData

Definition at line 57 of file vtkImplicitFunction.h.

Member Typedef Documentation

typedef vtkObject vtkImplicitFunction::Superclass

Definition at line 60 of file vtkImplicitFunction.h.

Constructor & Destructor Documentation

vtkImplicitFunction::vtkImplicitFunction ( )

protected

vtkImplicitFunction::~vtkImplicitFunction ( )

protected

Member Function Documentation

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

static

virtual int vtkImplicitFunction::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 vtkObject.

Reimplemented in vtkImplicitSelectionLoop, vtkPlanes, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkImplicitDataSet, vtkPlanesIntersection, vtkImplicitBoolean, vtkImplicitVolume, vtkCone, vtkPerlinNoise, vtkPolyPlane, vtkImplicitSum, vtkImplicitWindowFunction, vtkBox, vtkImplicitHalo, vtkPlane, vtkCylinder, vtkSphere, and vtkQuadric.

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

static

virtual vtkObjectBase* vtkImplicitFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkImplicitSelectionLoop, vtkPlanes, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkImplicitDataSet, vtkPlanesIntersection, vtkImplicitBoolean, vtkImplicitVolume, vtkCone, vtkPerlinNoise, vtkPolyPlane, vtkImplicitSum, vtkImplicitWindowFunction, vtkBox, vtkImplicitHalo, vtkPlane, vtkCylinder, vtkSphere, and vtkQuadric.

vtkImplicitFunction* vtkImplicitFunction::NewInstance ( ) const

void vtkImplicitFunction::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.

Reimplemented in vtkImplicitSelectionLoop, vtkPlanes, vtkSuperquadric, vtkPlanesIntersection, vtkImplicitPolyDataDistance, vtkImplicitVolume, vtkPerlinNoise, vtkPolyPlane, vtkImplicitSum, vtkImplicitWindowFunction, vtkImplicitHalo, vtkPlane, vtkSphere, and vtkQuadric.

unsigned long vtkImplicitFunction::GetMTime ( )

virtual

Overload standard modified time function. If Transform is modified, then this object is modified as well.

Reimplemented from vtkObject.

Reimplemented in vtkImplicitSelectionLoop, vtkImplicitWindowFunction, vtkPolyPlane, vtkImplicitVolume, vtkImplicitSum, and vtkImplicitPolyDataDistance.

double vtkImplicitFunction::FunctionValue ( const double x[3] )

Evaluate function at position x-y-z and return value. Point x[3] is transformed through transform (if provided).

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

inline

Evaluate function at position x-y-z and return value. Point x[3] is transformed through transform (if provided).

Definition at line 71 of file vtkImplicitFunction.h.

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

Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).

double* vtkImplicitFunction::FunctionGradient ( const double x[3] )

inline

Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).

Definition at line 79 of file vtkImplicitFunction.h.

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

inline

Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).

Definition at line 82 of file vtkImplicitFunction.h.

virtual void vtkImplicitFunction::SetTransform ( vtkAbstractTransform * )

virtual

Set/Get a transformation to apply to input points before executing the implicit function.

virtual void vtkImplicitFunction::SetTransform ( const double elements[16] )

virtual

Set/Get a transformation to apply to input points before executing the implicit function.

virtual vtkAbstractTransform* vtkImplicitFunction::GetTransform ( )

virtual

Set/Get a transformation to apply to input points before executing the implicit function.

virtual double vtkImplicitFunction::EvaluateFunction ( double x[3] )

pure virtual

Evaluate function at position x-y-z and return value. You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Implemented in vtkImplicitSelectionLoop, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitVolume, vtkPlanes, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkPerlinNoise, vtkCone, vtkImplicitWindowFunction, vtkBox, vtkPolyPlane, vtkImplicitSum, vtkCylinder, vtkImplicitHalo, vtkPlane, vtkSphere, and vtkQuadric.

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

inline

Evaluate function at position x-y-z and return value. You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Definition at line 100 of file vtkImplicitFunction.h.

virtual void vtkImplicitFunction::EvaluateGradient	(	double	x[3],
		double	g[3]
	)

pure virtual

Evaluate function gradient at position x-y-z and pass back vector. You should generally not call this method directly, you should use FunctionGradient() instead. This method must be implemented by any derived class.

Implemented in vtkImplicitSelectionLoop, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitVolume, vtkPlanes, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkPerlinNoise, vtkCone, vtkImplicitWindowFunction, vtkBox, vtkImplicitSum, vtkPolyPlane, vtkImplicitHalo, vtkCylinder, vtkPlane, vtkSphere, and vtkQuadric.

Member Data Documentation

vtkAbstractTransform* vtkImplicitFunction::Transform

protected

Definition at line 114 of file vtkImplicitFunction.h.

double vtkImplicitFunction::ReturnValue[3]

protected

Definition at line 115 of file vtkImplicitFunction.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/vtkImplicitFunction.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