Documentation for vtkCutter

vtkCutter - Cut vtkDataSet with user-specified implicit function

Super Class: vtkDataSetToPolyDataFilter

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

 

Methods:

void vtkCutter (vtkImplicitFunction *)
void vtkCutter ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkCutter *New ()
void SetValue (int ,float )
float GetValue (int )
float *GetValues ()
void GetValues (float *)
void SetNumberOfContours (int )
int GetNumberOfContours ()
void GenerateValues (int ,float )
void GenerateValues (int ,float ,float )
unsigned long GetMTime ()
void SetCutFunction (vtkImplicitFunction *)
vtkImplicitFunction *GetCutFunction ()
void SetGenerateCutScalars (int )
int GetGenerateCutScalars ()
void GenerateCutScalarsOn ()
void GenerateCutScalarsOff ()
void SetLocator (vtkPointLocator *)
vtkPointLocator *GetLocator ()
void SetSortBy (int )
int GetSortBy ()
void SetSortByToSortByValue ()
void SetSortByToSortByCell ()
char *GetSortByAsString ()
void CreateDefaultLocator ()
void SetLocator (vtkPointLocator &)
void Execute ()

 

Detailed Method Descriptions:

Construct with user-specified implicit function; initial value of 0.0; and generating cut scalars turned off.

static vtkCutter *New ()

Set a particular contour value at contour number i. The index i ranges between 0<=i

void SetValue (int ,float )

Get the ith contour value.

float GetValue (int )

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

float *GetValues ()

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 GetValues (float *)

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.

void SetNumberOfContours (int )

Get the number of contours in the list of contour values.

int GetNumberOfContours ()

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

void GenerateValues (int ,float )
void GenerateValues (int ,float ,float )

New GetMTime because we delegate to vtkContourValues & refer to vtkImplicitFunction

unsigned long GetMTime ()

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 SetGenerateCutScalars (int )
int GetGenerateCutScalars ()
void GenerateCutScalarsOn ()
void GenerateCutScalarsOff ()

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

void SetLocator (vtkPointLocator *)
vtkPointLocator *GetLocator ()

Set the sorting order for the generated polydata. There are two possibilities: 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).

void SetSortBy (int )
int GetSortBy ()
void SetSortByToSortByValue ()
void SetSortByToSortByCell ()
char *GetSortByAsString ()

Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.

void CreateDefaultLocator ()

For legacy compatibility. Do not use.

void SetLocator (vtkPointLocator &)