Man Page for vtkCutter
Table of Contents

NAME

vtkCutter - Cut vtkDataSet with user-specified implicit function

SYNOPSIS


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

class VTK_EXPORT vtkCutter : public vtkDataSetToPolyDataFilter

vtkCutter(vtkImplicitFunction *cf=NULL);
~vtkCutter();
static vtkCutter *New() {return new vtkCutter;};
const char *GetClassName() {return "vtkCutter";};
void PrintSelf(ostream& os, vtkIndent indent);
void SetValue(int i, float value);
float GetValue(int i);
float *GetValues();
void GetValues(float *contourValues);
void SetNumberOfContours(int number);
int GetNumberOfContours();
void GenerateValues(int numContours, float range[2]);
void GenerateValues(int numContours, float rangeStart, float rangeEnd);
unsigned long int GetMTime();
void SetCutFunction(vtkImplicitFunction*);
void SetCutFunction(vtkImplicitFunction& );
vtkImplicitFunction *GetCutFunction();
void SetGenerateCutScalars(int);
int GetGenerateCutScalars();
void GenerateCutScalarsOn();
void GenerateCutScalarsOff();
void SetLocator(vtkPointLocator *locator);
void SetLocator(vtkPointLocator& locator) {this->SetLocator(&locator);};
vtkPointLocator *GetLocator();
void SetSortBy(int);
int GetSortBy();
void SetSortByToSortByValue() {this->SetSortBy(VTK_SORT_BY_VALUE);};
void SetSortByToSortByCell() {this->SetSortBy(VTK_SORT_BY_CELL);};
char *GetSortByAsString();
void CreateDefaultLocator();

DESCRIPTION

vtkCutter is a filter to cut through data using any subclass of vtkImplicitFunction. That is, a polygonal surface is created corresponding to the implicit function F(x,y,z) = value(s), where you can specify one or more values used to cut with.

SEE ALSO

vtkImplicitFunction vtkClipPolyData

DEFINED MACROS

VTK_SORT_BY_VALUE 0

VTK_SORT_BY_CELL 1

SUMMARY

void SetGenerateCutScalars(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 SetSortBy(int)
Set the sorting order for the generated polydata. There are two Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

char *GetSortByAsString(void)
Create default locator. Used to create one when none is specified. The locator is used to merge coincident points. Return the sorting procedure as a descriptive character string.

void SetValue(int i, float value)
Set a particular contour value at contour number i. The index i ranges between 0<=i float GetValue(int i)
Get the ith contour value.

float *GetValues()
Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.

void GetValues(float *contourValues)
Fill a supplied list with contour values. There will be GetNumberOfContours() values in the list. Make sure you allocate enough memory to hold the list.

void SetNumberOfContours(int number)
Set the number of contours to place into the list. You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.

int GetNumberOfContours()
Get the number of contours in the list of contour values.

void GenerateValues(int numContours, float range[2])
Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

void GenerateValues(int numContours, float
Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

vtkCutter(vtkImplicitFunction *cf)
Construct with user-specified implicit function; initial value of 0.0; and generating cut scalars turned off.

unsigned long GetMTime()
Overload standard modified time function. If cut functions is modified, or contour values 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.


Table of Contents