Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImplicitDataSet Class Reference

treat a dataset as if it were an implicit function. More...

#include <vtkImplicitDataSet.h>

Inheritance diagram for vtkImplicitDataSet:

Inheritance graph
[legend]
Collaboration diagram for vtkImplicitDataSet:

Collaboration graph
[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 EvaluateFunction (float x[3])
float EvaluateFunction (float x, float y, float z)
void EvaluateGradient (float x[3], float n[3])
virtual void SetDataSet (vtkDataSet *)
virtual vtkDataSetGetDataSet ()
virtual void SetOutValue (float)
virtual float GetOutValue ()
virtual void SetOutGradient (float, float, float)
virtual void SetOutGradient (float[3])
virtual float * GetOutGradient ()
virtual void GetOutGradient (float &, float &, float &)
virtual void GetOutGradient (float[3])

Static Public Methods

int IsTypeOf (const char *type)
vtkImplicitDataSet * SafeDownCast (vtkObject *o)
vtkImplicitDataSet * New ()

Protected Methods

 vtkImplicitDataSet ()
 ~vtkImplicitDataSet ()
 vtkImplicitDataSet (const vtkImplicitDataSet &)
void operator= (const vtkImplicitDataSet &)

Protected Attributes

vtkDataSetDataSet
float OutValue
float OutGradient [3]
float * Weights
int Size

Detailed Description

treat a dataset as if it were an implicit function.

Date:
2000/12/10 20:08:39
Revision:
1.20

vtkImplicitDataSet treats any type of dataset as if it were an implicit function. This means it computes a function value and gradient. vtkImplicitDataSet is a concrete implementation of vtkImplicitFunction.

vtkImplicitDataSet computes the function (at the point x) by performing cell interpolation. That is, it finds the cell containing x, and then uses the cell's interpolation functions to compute an interpolated scalar value at x. (A similar approach is used to find the gradient, if requested.) Points outside of the dataset are assigned the value of the ivar OutValue, and the gradient value OutGradient.

Warning:
Any type of dataset can be used as an implicit function as long as it has scalar data associated with it.
See also:
vtkImplicitFunction vtkImplicitVolume vtkClipPolyData vtkCutter vtkImplicitWindowFunction
Examples:
vtkImplicitDataSet (examples)

Definition at line 75 of file vtkImplicitDataSet.h.


Constructor & Destructor Documentation

vtkImplicitDataSet::vtkImplicitDataSet   [protected]
 

vtkImplicitDataSet::~vtkImplicitDataSet   [protected]
 

vtkImplicitDataSet::vtkImplicitDataSet const vtkImplicitDataSet &    [inline, protected]
 

Definition at line 114 of file vtkImplicitDataSet.h.


Member Function Documentation

virtual const char* vtkImplicitDataSet::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 vtkImplicitFunction.

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

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

vtkImplicitDataSet* vtkImplicitDataSet::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 vtkImplicitFunction.

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

vtkImplicitDataSet* vtkImplicitDataSet::New   [static]
 

Construct an vtkImplicitDataSet with no initial dataset; the OutValue set to a large negative number; and the OutGradient set to (0,0,1).

Reimplemented from vtkObject.

unsigned long vtkImplicitDataSet::GetMTime   [virtual]
 

Return the MTime also considering the DataSet dependency.

Reimplemented from vtkImplicitFunction.

float vtkImplicitDataSet::EvaluateFunction float    x[3] [virtual]
 

Evaluate the implicit function. This returns the interpolated scalar value at x[3].

Reimplemented from vtkImplicitFunction.

float vtkImplicitDataSet::EvaluateFunction float    x,
float    y,
float    z
[inline]
 

Reimplemented from vtkImplicitFunction.

Definition at line 91 of file vtkImplicitDataSet.h.

void vtkImplicitDataSet::EvaluateGradient float    x[3],
float    n[3]
[virtual]
 

Evaluate implicit function gradient.

Reimplemented from vtkImplicitFunction.

virtual void vtkImplicitDataSet::SetDataSet vtkDataSet   [virtual]
 

Set / get the dataset used for the implicit function evaluation.

virtual vtkDataSet* vtkImplicitDataSet::GetDataSet   [virtual]
 

virtual void vtkImplicitDataSet::SetOutValue float    [virtual]
 

Set / get the function value to use for points outside of the dataset.

virtual float vtkImplicitDataSet::GetOutValue   [virtual]
 

virtual void vtkImplicitDataSet::SetOutGradient float   ,
float   ,
float   
[virtual]
 

Set / get the function gradient to use for points outside of the dataset.

virtual void vtkImplicitDataSet::SetOutGradient float   [3] [virtual]
 

virtual float* vtkImplicitDataSet::GetOutGradient   [virtual]
 

virtual void vtkImplicitDataSet::GetOutGradient float &   ,
float &   ,
float &   
[virtual]
 

virtual void vtkImplicitDataSet::GetOutGradient float   [3] [virtual]
 

void vtkImplicitDataSet::operator= const vtkImplicitDataSet &    [inline, protected]
 

Definition at line 115 of file vtkImplicitDataSet.h.


Member Data Documentation

vtkDataSet* vtkImplicitDataSet::DataSet [protected]
 

Definition at line 117 of file vtkImplicitDataSet.h.

float vtkImplicitDataSet::OutValue [protected]
 

Definition at line 118 of file vtkImplicitDataSet.h.

float vtkImplicitDataSet::OutGradient[3] [protected]
 

Definition at line 119 of file vtkImplicitDataSet.h.

float* vtkImplicitDataSet::Weights [protected]
 

Definition at line 121 of file vtkImplicitDataSet.h.

int vtkImplicitDataSet::Size [protected]
 

Definition at line 122 of file vtkImplicitDataSet.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:49:10 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001