NAME
vtkClipPolyData - clip polygonal data with user-specified implicit function
SYNOPSIS
#include "/opt/vtk-c++/graphics/vtkClipPolyData.h"
class VTK_EXPORT vtkClipPolyData : public vtkPolyDataToPolyDataFilter
vtkClipPolyData(vtkImplicitFunction *cf=NULL);
~vtkClipPolyData();
static vtkClipPolyData *New() {return new vtkClipPolyData;};
const char *GetClassName() {return "vtkClipPolyData";};
void PrintSelf(ostream& os, vtkIndent indent);
void SetValue(float);
float GetValue();
void SetInsideOut(int);
int GetInsideOut();
void InsideOutOn();
void InsideOutOff();
void SetClipFunction(vtkImplicitFunction*);
void SetClipFunction(vtkImplicitFunction& );
vtkImplicitFunction *GetClipFunction();
void SetGenerateClipScalars(int);
int GetGenerateClipScalars();
void GenerateClipScalarsOn();
void GenerateClipScalarsOff();
void SetGenerateClippedOutput(int);
int GetGenerateClippedOutput();
void GenerateClippedOutputOn();
void GenerateClippedOutputOff();
vtkPolyData *GetClippedOutput() {return this->ClippedOutput;};
void SetLocator(vtkPointLocator *locator);
void SetLocator(vtkPointLocator& locator) {this->SetLocator(&locator);};
vtkPointLocator *GetLocator();
void CreateDefaultLocator();
unsigned long int GetMTime();
DESCRIPTION
vtkClipPolyData is a filter that clips polygonal data to by a any subclass of vtkImplicitFunction. Clipping means that it actually "cuts" through the cells of the dataset, returning everthing inside of the specified implicit function, including "pieces" of a cell. (Compare this with vtkExtractGeometry, which pulls out entire, uncut cells.)
To use this filter, at a minimum you need to specify an implicit function. You can also specify a implicit function value, which is used to decide what is inside and outside of the implicit function. You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The cutting algorithm proceeds by computing an implicit function value for each point in the dataset. This is compared to the implicit function value to determine inside/outside.)
This filter can be configured to compute a second output. The second output is the polygonal data that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.
CAVEATS
In order to cut all types of cells in polygonal data, vtkClipPolyData triangulates some cells, and then cuts the resulting simplices (i.e., points, lines, and triangles). This means that the resulting output may consist of different cell types than the input data.
SEE ALSO
vtkImplicitFunction vtkCutter
SUMMARY
void SetValue(float)
Set the clipping value of the implicit function. Default is 0.0.
void SetInsideOut(int)
Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its implicit
function value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.
void SetGenerateClipScalars(int)
If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
void SetGenerateClippedOutput(int)
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
vtkClipPolyData(vtkImplicitFunction *cf)
Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.
unsigned long GetMTime()
Overload standard modified time function. If Clip functions is modified, then this object is modified as well.
void SetLocator(vtkPointLocator *locator)
Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.