vtkClipDataSet Class Reference

#include <vtkClipDataSet.h>

Inheritance diagram for vtkClipDataSet:

[legend]

Collaboration diagram for vtkClipDataSet:

[legend]

List of all members.

Detailed Description

clip any dataset with user-specified implicit function or input scalar data

vtkClipDataSet is a filter that clips any type of dataset 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 an unstructured grid.

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 clipping 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 part of the cell that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.

Warning:: vtkClipDataSet will triangulate all types of 3D cells (i.e., create tetrahedra). This is true even if the cell is not actually cut. This is necessary to preserve compatibility across face neighbors. 2D cells will only be triangulated if the cutting function passes through them.

See also:: vtkImplicitFunction vtkCutter vtkClipVolume vtkClipPolyData

Tests:: vtkClipDataSet (Tests)

Definition at line 71 of file vtkClipDataSet.h.


Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkUnstructuredGrid *	GetClippedOutput ()
void	CreateDefaultLocator ()
unsigned long	GetMTime ()

virtual void	SetValue (double)
virtual double	GetValue ()

virtual void	SetUseValueAsOffset (bool)
virtual bool	GetUseValueAsOffset ()
virtual void	UseValueAsOffsetOn ()
virtual void	UseValueAsOffsetOff ()

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 ()

virtual void	SetMergeTolerance (double)
virtual double	GetMergeTolerance ()

void	SetLocator (vtkIncrementalPointLocator *locator)
virtual vtkIncrementalPointLocator *	GetLocator ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkClipDataSet *	SafeDownCast (vtkObject *o)
static vtkClipDataSet *	New ()
Protected Member Functions
	vtkClipDataSet (vtkImplicitFunction *cf=NULL)
	~vtkClipDataSet ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
void	InternalProgressCallback (vtkAlgorithm *algorithm)
void	ClipVolume (vtkDataSet input, vtkUnstructuredGrid output)
int	ClipPoints (vtkDataSet input, vtkUnstructuredGrid output, vtkInformationVector **inputVector)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )
Static Protected Member Functions
static void	InternalProgressCallbackFunction (vtkObject , unsigned long, void clientdata, void *)
Protected Attributes
vtkImplicitFunction *	ClipFunction
vtkIncrementalPointLocator *	Locator
int	InsideOut
double	Value
int	GenerateClipScalars
int	GenerateClippedOutput
double	MergeTolerance
vtkCallbackCommand *	InternalProgressObserver
bool	UseValueAsOffset

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkClipDataSet::Superclass

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 74 of file vtkClipDataSet.h.

Constructor & Destructor Documentation

vtkClipDataSet::vtkClipDataSet ( vtkImplicitFunction * cf = NULL ) [protected]

vtkClipDataSet::~vtkClipDataSet ( ) [protected]

Member Function Documentation

virtual const char* vtkClipDataSet::GetClassName ( ) [virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkClipDataSet::IsTypeOf ( const char * name ) [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 vtkUnstructuredGridAlgorithm.

virtual int vtkClipDataSet::IsA ( const char * name ) [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 vtkUnstructuredGridAlgorithm.

static vtkClipDataSet* vtkClipDataSet::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkClipDataSet::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 vtkUnstructuredGridAlgorithm.

static vtkClipDataSet* vtkClipDataSet::New ( ) [static]

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

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual void vtkClipDataSet::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. This value is ignored if UseValueAsOffset is true and a clip function is defined.

virtual double vtkClipDataSet::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. This value is ignored if UseValueAsOffset is true and a clip function is defined.

virtual void vtkClipDataSet::SetUseValueAsOffset ( bool ) [virtual]

If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default is true.

virtual bool vtkClipDataSet::GetUseValueAsOffset ( ) [virtual]

If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default is true.

virtual void vtkClipDataSet::UseValueAsOffsetOn ( ) [virtual]

If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default is true.

virtual void vtkClipDataSet::UseValueAsOffsetOff ( ) [virtual]

If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. Default is true.

virtual void vtkClipDataSet::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 vtkClipDataSet::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 vtkClipDataSet::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 vtkClipDataSet::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 vtkClipDataSet::SetClipFunction ( vtkImplicitFunction * ) [virtual]

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

virtual vtkImplicitFunction* vtkClipDataSet::GetClipFunction ( ) [virtual]

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

virtual void vtkClipDataSet::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 vtkClipDataSet::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 vtkClipDataSet::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 vtkClipDataSet::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 vtkClipDataSet::SetGenerateClippedOutput ( int ) [virtual]

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

virtual int vtkClipDataSet::GetGenerateClippedOutput ( ) [virtual]

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

virtual void vtkClipDataSet::GenerateClippedOutputOn ( ) [virtual]

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

virtual void vtkClipDataSet::GenerateClippedOutputOff ( ) [virtual]

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

virtual void vtkClipDataSet::SetMergeTolerance ( double ) [virtual]

Set the tolerance for merging clip intersection points that are near the vertices of cells. This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable.

virtual double vtkClipDataSet::GetMergeTolerance ( ) [virtual]

Set the tolerance for merging clip intersection points that are near the vertices of cells. This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable.

vtkUnstructuredGrid* vtkClipDataSet::GetClippedOutput ( )

Return the Clipped output.

void vtkClipDataSet::SetLocator ( vtkIncrementalPointLocator * locator )

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

virtual vtkIncrementalPointLocator* vtkClipDataSet::GetLocator ( ) [virtual]

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

void vtkClipDataSet::CreateDefaultLocator ( )

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

unsigned long vtkClipDataSet::GetMTime ( ) [virtual]

Return the mtime also considering the locator and clip function.

Reimplemented from vtkObject.

virtual int vtkClipDataSet::ProcessRequest	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

Overridden to process REQUEST_UPDATE_EXTENT_INFORMATION.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkClipDataSet::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

This is called by the superclass. This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkClipDataSet::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkUnstructuredGridAlgorithm.