Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkCutter Class Reference

Cut vtkDataSet with user-specified implicit function. More...

#include <vtkCutter.h>

Inheritance diagram for vtkCutter:

Inheritance graph
[legend]
Collaboration diagram for vtkCutter:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 GetMTime ()
virtual void SetCutFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetCutFunction ()
virtual void SetGenerateCutScalars (int)
virtual int GetGenerateCutScalars ()
virtual void GenerateCutScalarsOn ()
virtual void GenerateCutScalarsOff ()
void SetLocator (vtkPointLocator *locator)
virtual vtkPointLocatorGetLocator ()
virtual void SetSortBy (int)
virtual int GetSortBy ()
void SetSortByToSortByValue ()
void SetSortByToSortByCell ()
const char * GetSortByAsString ()
void CreateDefaultLocator ()
void SetLocator (vtkPointLocator &locator)

Static Public Methods

int IsTypeOf (const char *type)
vtkCutter * SafeDownCast (vtkObject *o)
vtkCutter * New ()

Protected Methods

 vtkCutter (vtkImplicitFunction *cf=NULL)
 ~vtkCutter ()
 vtkCutter (const vtkCutter &)
void operator= (const vtkCutter &)
void Execute ()

Protected Attributes

vtkImplicitFunctionCutFunction
vtkPointLocatorLocator
int SortBy
vtkContourValuesContourValues
int GenerateCutScalars

Detailed Description

Cut vtkDataSet with user-specified implicit function.

Date:
2000/12/10 20:08:33
Revision:
1.47

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
Examples:
vtkCutter (examples)


Member Function Documentation

void vtkCutter::CreateDefaultLocator  
 

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

void vtkCutter::GenerateValues int    numContours,
float    rangeStart,
float    rangeEnd
[inline]
 

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

void vtkCutter::GenerateValues int    numContours,
float    range[2]
[inline]
 

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

virtual const char* vtkCutter::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToPolyDataFilter.

unsigned long vtkCutter::GetMTime   [virtual]
 

New GetMTime because we delegate to vtkContourValues & refer to vtkImplicitFunction

Reimplemented from vtkObject.

int vtkCutter::GetNumberOfContours   [inline]
 

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

const char * vtkCutter::GetSortByAsString void    [inline]
 

Return the sorting procedure as a descriptive character string.

float vtkCutter::GetValue int    i [inline]
 

Get the ith contour value.

void vtkCutter::GetValues float *    contourValues [inline]
 

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.

float* vtkCutter::GetValues   [inline]
 

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

virtual int vtkCutter::IsA const char *    type [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToPolyDataFilter.

int vtkCutter::IsTypeOf const char *    type [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToPolyDataFilter.

vtkCutter* vtkCutter::New   [static]
 

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

Reimplemented from vtkPolyDataSource.

void vtkCutter::PrintSelf ostream &    os,
vtkIndent    indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkSource.

vtkCutter* vtkCutter::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToPolyDataFilter.

virtual void vtkCutter::SetCutFunction vtkImplicitFunction   [virtual]
 

Specify the implicit function to perform the cutting.

virtual void vtkCutter::SetGenerateCutScalars int    [virtual]
 

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 vtkCutter::SetLocator vtkPointLocator   locator [inline]
 

For legacy compatibility. Do not use.

void vtkCutter::SetLocator vtkPointLocator   locator
 

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

void vtkCutter::SetNumberOfContours int    number [inline]
 

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.

virtual void vtkCutter::SetSortBy int    [virtual]
 

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 vtkCutter::SetValue int    i,
float    value
[inline]
 

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


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:24:31 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002