VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImplicitVolume Class Reference

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

#include <vtkImplicitVolume.h>

Inheritance diagram for vtkImplicitVolume:
Inheritance graph
[legend]
Collaboration diagram for vtkImplicitVolume:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkImplicitFunction Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkImplicitVolumeNewInstance () 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 SetVolume (vtkImageData *)
virtual vtkImageDataGetVolume ()
virtual void SetOutValue (double)
virtual double GetOutValue ()
virtual void SetOutGradient (double, double, double)
virtual void SetOutGradient (double[3])
virtual doubleGetOutGradient ()
virtual void GetOutGradient (double &, double &, double &)
virtual void GetOutGradient (double[3])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImplicitVolumeSafeDownCast (vtkObjectBase *o)
static vtkImplicitVolumeNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkImplicitVolume ()
 ~vtkImplicitVolume ()

Protected Attributes

vtkImageDataVolume
double OutValue
double OutGradient [3]
vtkIdListPointIds

Detailed Description

treat a volume as if it were an implicit function

vtkImplicitVolume treats a volume (e.g., structured point dataset) as if it were an implicit function. This means it computes a function value and gradient. vtkImplicitVolume 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:
The input volume data is only updated when GetMTime() is called. Works for 3D structured points datasets, 0D-2D datasets won't work properly.
See also:
vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter vtkImplicitWindowFunction

Definition at line 48 of file vtkImplicitVolume.h.


Member Typedef Documentation

Reimplemented from vtkImplicitFunction.

Definition at line 51 of file vtkImplicitVolume.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkImplicitVolume::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 vtkImplicitVolume::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.

Reimplemented from vtkImplicitFunction.

virtual vtkObjectBase* vtkImplicitVolume::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImplicitFunction.

Reimplemented from vtkImplicitFunction.

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

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

Reimplemented from vtkObject.

unsigned long vtkImplicitVolume::GetMTime ( ) [virtual]

Returns the mtime also considering the volume. This also calls Update on the volume, and it therefore must be called before the function is evaluated.

Reimplemented from vtkImplicitFunction.

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

Implements vtkImplicitFunction.

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

Reimplemented from vtkImplicitFunction.

Definition at line 67 of file vtkImplicitVolume.h.

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

Evaluate ImplicitVolume gradient.

Implements vtkImplicitFunction.

virtual void vtkImplicitVolume::SetVolume ( vtkImageData ) [virtual]

Specify the volume for the implicit function.

Specify the volume for the implicit function.

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

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

virtual double vtkImplicitVolume::GetOutValue ( ) [virtual]

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

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

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

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

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

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

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

virtual void vtkImplicitVolume::GetOutGradient ( double ,
double ,
double  
) [virtual]

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

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

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


Member Data Documentation

Definition at line 96 of file vtkImplicitVolume.h.

Definition at line 97 of file vtkImplicitVolume.h.

Definition at line 98 of file vtkImplicitVolume.h.

Definition at line 100 of file vtkImplicitVolume.h.


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