---

vtkImplicitFunction Class Reference

abstract interface for implicit functions. More...

#include <vtkImplicitFunction.h>

Inheritance diagram for vtkImplicitFunction:

[legend]Collaboration diagram for vtkImplicitFunction:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
unsigned long	GetMTime ()
float	FunctionValue (const float x[3])
float	FunctionValue (float x, float y, float z)
void	FunctionGradient (const float x[3], float g[3])
float *	FunctionGradient (const float x[3])
float *	FunctionGradient (float x, float y, float z)
virtual void	SetTransform (vtkAbstractTransform *)
virtual vtkAbstractTransform *	GetTransform ()
virtual float	EvaluateFunction (float x[3])=0
float	EvaluateFunction (float x, float y, float z)
virtual void	EvaluateGradient (float x[3], float g[3])=0
Static Public Methods
int	IsTypeOf (const char *type)
vtkImplicitFunction *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImplicitFunction ()
	~vtkImplicitFunction ()
	vtkImplicitFunction (const vtkImplicitFunction &)
void	operator= (const vtkImplicitFunction &)
Protected Attributes
vtkAbstractTransform *	Transform
float	ReturnValue [3]

---

Detailed Description

abstract interface for implicit functions.

Date:

2000/12/10 20:08:11

Revision:

1.43

vtkImplicitFunction specifies an abstract interface for implicit functions. Implicit functions are of the form F(x,y,z) = 0. Two primitive operations are required: the ability to evaluate the function, and the function gradient at a given point.

Implicit functions are very powerful. It is possible to represent almost any type of geometry with implicit functions, especially if you use boolean combinations 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 77 of file vtkImplicitFunction.h.

---

Constructor & Destructor Documentation

vtkImplicitFunction::vtkImplicitFunction (    )  [protected]

vtkImplicitFunction::~vtkImplicitFunction (    )  [protected]

vtkImplicitFunction::vtkImplicitFunction (  const vtkImplicitFunction &    )  [inline, protected]

Definition at line 124 of file vtkImplicitFunction.h.

---

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere.

int vtkImplicitFunction::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere.

virtual int vtkImplicitFunction::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere. Referenced by vtkImplicitFunctionCollection::GetNextItem().

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 vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere.

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 vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, and vtkImplicitWindowFunction.

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

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

float vtkImplicitFunction::FunctionValue (  float    x, float    y, float    z )  [inline]

Definition at line 90 of file vtkImplicitFunction.h.

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

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

float* vtkImplicitFunction::FunctionGradient (  const float    x[3] )  [inline]

Definition at line 96 of file vtkImplicitFunction.h.

float* vtkImplicitFunction::FunctionGradient (  float    x, float    y, float    z )  [inline]

Definition at line 99 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 vtkAbstractTransform* vtkImplicitFunction::GetTransform (    )  [virtual]

virtual float vtkImplicitFunction::EvaluateFunction (  float    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. Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere. Referenced by vtkSphere::EvaluateFunction(), vtkPlanes::EvaluateFunction(), vtkImplicitWindowFunction::EvaluateFunction(), vtkImplicitVolume::EvaluateFunction(), vtkImplicitSelectionLoop::EvaluateFunction(), vtkImplicitDataSet::EvaluateFunction(), vtkImplicitBoolean::EvaluateFunction(), vtkCylinder::EvaluateFunction(), vtkCone::EvaluateFunction(), vtkSuperquadric::EvaluateFunction(), vtkQuadric::EvaluateFunction(), and vtkPlane::EvaluateFunction().

float vtkImplicitFunction::EvaluateFunction (  float    x, float    y, float    z )  [inline]

Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere. Definition at line 112 of file vtkImplicitFunction.h.

virtual void vtkImplicitFunction::EvaluateGradient (  float    x[3], float    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. Reimplemented in vtkPlane, vtkQuadric, vtkSuperquadric, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPlanes, and vtkSphere.

void vtkImplicitFunction::operator= (  const vtkImplicitFunction &    )  [inline, protected]

Definition at line 125 of file vtkImplicitFunction.h.

---

Member Data Documentation

vtkAbstractTransform* vtkImplicitFunction::Transform [protected]

Definition at line 127 of file vtkImplicitFunction.h.

float vtkImplicitFunction::ReturnValue[3] [protected]

Definition at line 128 of file vtkImplicitFunction.h.

---

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

• common/vtkImplicitFunction.h

---