vtkImplicitDataSet Class Reference

#include <vtkImplicitDataSet.h>

Inheritance diagram for vtkImplicitDataSet:

Inheritance graph
[legend]
Collaboration diagram for vtkImplicitDataSet:

Collaboration graph
[legend]

List of all members.


Detailed Description

treat a dataset as if it were an implicit function

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
Tests:
vtkImplicitDataSet (Tests)

Definition at line 49 of file vtkImplicitDataSet.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)
unsigned long GetMTime ()
void EvaluateGradient (double x[3], double n[3])
double EvaluateFunction (double x[3])
double EvaluateFunction (double x, double y, double z)
virtual void SetDataSet (vtkDataSet *)
virtual vtkDataSetGetDataSet ()
virtual void SetOutValue (double)
virtual double GetOutValue ()
virtual void SetOutGradient (double, double, double)
virtual void SetOutGradient (double[3])
virtual double * GetOutGradient ()
virtual void GetOutGradient (double &, double &, double &)
virtual void GetOutGradient (double[3])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImplicitDataSetSafeDownCast (vtkObject *o)
static vtkImplicitDataSetNew ()

Protected Member Functions

 vtkImplicitDataSet ()
 ~vtkImplicitDataSet ()
virtual void ReportReferences (vtkGarbageCollector *)

Protected Attributes

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

Member Typedef Documentation

Reimplemented from vtkImplicitFunction.

Definition at line 52 of file vtkImplicitDataSet.h.


Constructor & Destructor Documentation

vtkImplicitDataSet::vtkImplicitDataSet (  )  [protected]

vtkImplicitDataSet::~vtkImplicitDataSet (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkImplicitFunction.

static int vtkImplicitDataSet::IsTypeOf ( const char *  name  )  [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 *  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 vtkImplicitDataSet* vtkImplicitDataSet::SafeDownCast ( vtkObject o  )  [static]

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.

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

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

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

Implements vtkImplicitFunction.

double vtkImplicitDataSet::EvaluateFunction ( double  x,
double  y,
double  z 
) [inline]

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

Reimplemented from vtkImplicitFunction.

Definition at line 66 of file vtkImplicitDataSet.h.

void vtkImplicitDataSet::EvaluateGradient ( double  x[3],
double  n[3] 
) [virtual]

Evaluate implicit function gradient.

Implements vtkImplicitFunction.

virtual void vtkImplicitDataSet::SetDataSet ( vtkDataSet  )  [virtual]

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

virtual vtkDataSet* vtkImplicitDataSet::GetDataSet (  )  [virtual]

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

virtual void vtkImplicitDataSet::SetOutValue ( double   )  [virtual]

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

virtual double vtkImplicitDataSet::GetOutValue (  )  [virtual]

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

virtual void vtkImplicitDataSet::SetOutGradient ( double  ,
double  ,
double   
) [virtual]

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

virtual void vtkImplicitDataSet::SetOutGradient ( double  [3]  )  [virtual]

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

virtual double* vtkImplicitDataSet::GetOutGradient (  )  [virtual]

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

virtual void vtkImplicitDataSet::GetOutGradient ( double &  ,
double &  ,
double &   
) [virtual]

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

virtual void vtkImplicitDataSet::GetOutGradient ( double  [3]  )  [virtual]

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

virtual void vtkImplicitDataSet::ReportReferences ( vtkGarbageCollector  )  [protected, virtual]

Reimplemented from vtkObjectBase.


Member Data Documentation

Definition at line 99 of file vtkImplicitDataSet.h.

double vtkImplicitDataSet::OutValue [protected]

Definition at line 100 of file vtkImplicitDataSet.h.

double vtkImplicitDataSet::OutGradient[3] [protected]

Definition at line 101 of file vtkImplicitDataSet.h.

double* vtkImplicitDataSet::Weights [protected]

Definition at line 103 of file vtkImplicitDataSet.h.

int vtkImplicitDataSet::Size [protected]

Definition at line 104 of file vtkImplicitDataSet.h.


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

Generated on Mon Sep 27 18:29:55 2010 for VTK by  doxygen 1.5.6