VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImplicitDataSet Class Reference

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

#include <vtkImplicitDataSet.h>

Inherits vtkImplicitFunction.

Public Types

typedef vtkImplicitFunction Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImplicitDataSetNewInstance () const
 
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 vtkDataSet * GetDataSet ()
 
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 (vtkObjectBase *o)
 
static vtkImplicitDataSetNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkImplicitDataSet ()
 
 ~vtkImplicitDataSet ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 

Protected Attributes

vtkDataSet * DataSet
 
double OutValue
 
double OutGradient [3]
 
double * Weights
 
int Size
 

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 50 of file vtkImplicitDataSet.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkImplicitDataSet::Superclass

Definition at line 53 of file vtkImplicitDataSet.h.

Constructor & Destructor Documentation

vtkImplicitDataSet::vtkImplicitDataSet ( )
protected
vtkImplicitDataSet::~vtkImplicitDataSet ( )
protected

Member Function Documentation

static int vtkImplicitDataSet::IsTypeOf ( const char *  type)
static
virtual int vtkImplicitDataSet::IsA ( const char *  type)
virtual
static vtkImplicitDataSet* vtkImplicitDataSet::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImplicitDataSet::NewInstanceInternal ( ) const
protectedvirtual
vtkImplicitDataSet* vtkImplicitDataSet::NewInstance ( ) const
void vtkImplicitDataSet::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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).

unsigned long vtkImplicitDataSet::GetMTime ( )

Return the MTime also considering the DataSet dependency.

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

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

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

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

Definition at line 67 of file vtkImplicitDataSet.h.

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

Evaluate implicit function gradient.

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 *  )
protectedvirtual

Member Data Documentation

vtkDataSet* vtkImplicitDataSet::DataSet
protected

Definition at line 100 of file vtkImplicitDataSet.h.

double vtkImplicitDataSet::OutValue
protected

Definition at line 101 of file vtkImplicitDataSet.h.

double vtkImplicitDataSet::OutGradient[3]
protected

Definition at line 102 of file vtkImplicitDataSet.h.

double* vtkImplicitDataSet::Weights
protected

Definition at line 104 of file vtkImplicitDataSet.h.

int vtkImplicitDataSet::Size
protected

Definition at line 105 of file vtkImplicitDataSet.h.


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