Documentation for vtkImplicitVolume

vtkImplicitVolume - treat a volume as if it were an implicit function

Super Class: vtkImplicitFunction

Description:

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.

 

Caveats:

Works for 3D structured points datasets, 0D-2D datasets won't work properly.

 

See Also:

vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter vtkImplicitWindowFunction

 

Methods:

void vtkImplicitVolume ()
void vtkImplicitVolume ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkImplicitVolume *New ()
unsigned long GetMTime ()
float EvaluateFunction (float )
void EvaluateGradient (float ,float )
void SetVolume (vtkStructuredPoints *)
vtkStructuredPoints *GetVolume ()
void SetOutValue (float )
float GetOutValue ()
void SetOutGradient (float ,float ,float )
void SetOutGradient (float *)
float *GetOutGradient ()

 

Detailed Method Descriptions:

Returns the mtime also considering the volume.

static vtkImplicitVolume *New ()
unsigned long GetMTime ()

Specify the volume for the implicit function.

void SetVolume (vtkStructuredPoints *)
vtkStructuredPoints *GetVolume ()

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

void SetOutValue (float )
float GetOutValue ()

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

void SetOutGradient (float ,float ,float )
void SetOutGradient (float *)
float *GetOutGradient ()