VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkClipPolyData Class Reference

clip polygonal data with user-specified implicit function or input scalar data More...

#include <vtkClipPolyData.h>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkClipPolyDataNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkPolyData * GetClippedOutput ()
 
void CreateDefaultLocator ()
 
unsigned long GetMTime ()
 
virtual void SetValue (double)
 
virtual double GetValue ()
 
virtual void SetInsideOut (int)
 
virtual int GetInsideOut ()
 
virtual void InsideOutOn ()
 
virtual void InsideOutOff ()
 
virtual void SetClipFunction (vtkImplicitFunction *)
 
virtual vtkImplicitFunction * GetClipFunction ()
 
virtual void SetGenerateClipScalars (int)
 
virtual int GetGenerateClipScalars ()
 
virtual void GenerateClipScalarsOn ()
 
virtual void GenerateClipScalarsOff ()
 
virtual void SetGenerateClippedOutput (int)
 
virtual int GetGenerateClippedOutput ()
 
virtual void GenerateClippedOutputOn ()
 
virtual void GenerateClippedOutputOff ()
 
vtkAlgorithmOutput * GetClippedOutputPort ()
 
void SetLocator (vtkIncrementalPointLocator *locator)
 
virtual
vtkIncrementalPointLocator * 
GetLocator ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkClipPolyDataSafeDownCast (vtkObjectBase *o)
 
static vtkClipPolyDataNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkClipPolyData (vtkImplicitFunction *cf=NULL)
 
 ~vtkClipPolyData ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkImplicitFunction * ClipFunction
 
vtkIncrementalPointLocator * Locator
 
int InsideOut
 
double Value
 
int GenerateClipScalars
 
int GenerateClippedOutput
 

Detailed Description

clip polygonal data with user-specified implicit function or input scalar data

vtkClipPolyData is a filter that clips polygonal data using either any subclass of vtkImplicitFunction, or the input scalar data. Clipping means that it actually "cuts" through the cells of the dataset, returning everything inside of the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this with vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is polygonal data.

To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or GenerateClipScalars is off (the default), then the input's scalar data will be used to clip the polydata.

You can also specify a scalar 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 or using the input scalar data for each point in the dataset. This is compared to the scalar 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.

Warning
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 vtkClipVolume
Examples:
vtkClipPolyData (Examples)
Tests:
vtkClipPolyData (Tests)

Definition at line 73 of file vtkClipPolyData.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkClipPolyData::Superclass

Definition at line 76 of file vtkClipPolyData.h.

Constructor & Destructor Documentation

vtkClipPolyData::vtkClipPolyData ( vtkImplicitFunction *  cf = NULL)
protected
vtkClipPolyData::~vtkClipPolyData ( )
protected

Member Function Documentation

static int vtkClipPolyData::IsTypeOf ( const char *  type)
static
virtual int vtkClipPolyData::IsA ( const char *  type)
virtual
static vtkClipPolyData* vtkClipPolyData::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkClipPolyData::NewInstanceInternal ( ) const
protectedvirtual
vtkClipPolyData* vtkClipPolyData::NewInstance ( ) const
void vtkClipPolyData::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkClipPolyData* vtkClipPolyData::New ( )
static

Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.

virtual void vtkClipPolyData::SetValue ( double  )
virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual double vtkClipPolyData::GetValue ( )
virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual void vtkClipPolyData::SetInsideOut ( int  )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its 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.

virtual int vtkClipPolyData::GetInsideOut ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its 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.

virtual void vtkClipPolyData::InsideOutOn ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its 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.

virtual void vtkClipPolyData::InsideOutOff ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its 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.

virtual void vtkClipPolyData::SetClipFunction ( vtkImplicitFunction *  )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the input scalar data will be used for clipping.

virtual vtkImplicitFunction* vtkClipPolyData::GetClipFunction ( )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the input scalar data will be used for clipping.

virtual void vtkClipPolyData::SetGenerateClipScalars ( 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. If you enable this flag but do not provide an implicit function an error will be reported.

virtual int vtkClipPolyData::GetGenerateClipScalars ( )
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. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipPolyData::GenerateClipScalarsOn ( )
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. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipPolyData::GenerateClipScalarsOff ( )
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. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipPolyData::SetGenerateClippedOutput ( int  )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual int vtkClipPolyData::GetGenerateClippedOutput ( )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkClipPolyData::GenerateClippedOutputOn ( )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkClipPolyData::GenerateClippedOutputOff ( )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

vtkPolyData* vtkClipPolyData::GetClippedOutput ( )

Return the Clipped output.

vtkAlgorithmOutput* vtkClipPolyData::GetClippedOutputPort ( )
inline

Return the output port (a vtkAlgorithmOutput) of the clipped output.

Definition at line 133 of file vtkClipPolyData.h.

void vtkClipPolyData::SetLocator ( vtkIncrementalPointLocator *  locator)

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

virtual vtkIncrementalPointLocator* vtkClipPolyData::GetLocator ( )
virtual

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

void vtkClipPolyData::CreateDefaultLocator ( )

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

unsigned long vtkClipPolyData::GetMTime ( )

Return the mtime also considering the locator and clip function.

int vtkClipPolyData::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

vtkImplicitFunction* vtkClipPolyData::ClipFunction
protected

Definition at line 158 of file vtkClipPolyData.h.

vtkIncrementalPointLocator* vtkClipPolyData::Locator
protected

Definition at line 160 of file vtkClipPolyData.h.

int vtkClipPolyData::InsideOut
protected

Definition at line 161 of file vtkClipPolyData.h.

double vtkClipPolyData::Value
protected

Definition at line 162 of file vtkClipPolyData.h.

int vtkClipPolyData::GenerateClipScalars
protected

Definition at line 163 of file vtkClipPolyData.h.

int vtkClipPolyData::GenerateClippedOutput
protected

Definition at line 165 of file vtkClipPolyData.h.


The documentation for this class was generated from the following file: