Man Page for vtkImplicitVolume
Table of Contents

NAME

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

SYNOPSIS


#include "/opt/vtk-c++/graphics/vtkImplicitVolume.h"

class VTK_EXPORT vtkImplicitVolume : public vtkImplicitFunction

vtkImplicitVolume();
static vtkImplicitVolume *New() {return new vtkImplicitVolume;};
const char *GetClassName() {return "vtkImplicitVolume";};
void PrintSelf(ostream& os, vtkIndent indent);
unsigned long int GetMTime();
float EvaluateFunction(float x[3]);
void EvaluateGradient(float x[3], float n[3]);
void SetVolume(vtkStructuredPoints*);
void SetVolume(vtkStructuredPoints& );
vtkStructuredPoints *GetVolume();
void SetOutValue(float);
float GetOutValue();
void SetOutGradient(float, float, float);
void SetOutGradient(float *);
void SetOutGradient(float, float, float);
void SetOutGradient(float *);

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

SUMMARY

void SetVolume(vtkStructuredPoints*)
void SetVolume(vtkStructuredPoints& )
Specify the volume for the implicit function.

void SetOutValue(float)
Set the function value to use for points outside of the dataset.

void SetOutGradient(float, float, float)
void SetOutGradient(float *)
Set the function gradient to use for points outside of the dataset.


Table of Contents