vtkGenericGeometryFilter Class Reference

#include <vtkGenericGeometryFilter.h>

Inheritance diagram for vtkGenericGeometryFilter:

[legend]

Collaboration diagram for vtkGenericGeometryFilter:

[legend]

List of all members.

Detailed Description

extract geometry from data (or convert data to polygonal type)

vtkGenericGeometryFilter is a general-purpose filter to extract geometry (and associated data) from any type of dataset. Geometry is obtained as follows: all 0D, 1D, and 2D cells are extracted. All 2D faces that are used by only one 3D cell (i.e., boundary faces) are extracted. It also is possible to specify conditions on point ids, cell ids, and on bounding box (referred to as "Extent") to control the extraction process.

This filter also may be used to convert any type of data to polygonal type. The conversion process may be less than satisfactory for some 3D datasets. For example, this filter will extract the outer surface of a volume or structured grid dataset. (For structured data you may want to use vtkImageDataGeometryFilter, vtkStructuredGridGeometryFilter, vtkExtractUnstructuredGrid, vtkRectilinearGridGeometryFilter, or vtkExtractVOI.)

Warning:: When vtkGenericGeometryFilter extracts cells (or boundaries of cells) it will (by default) merge duplicate vertices. This may cause problems in some cases. For example, if you've run vtkPolyDataNormals to generate normals, which may split meshes and create duplicate vertices, vtkGenericGeometryFilter will merge these points back together. Turn merging off to prevent this from occurring.

See also:: vtkImageDataGeometryFilter vtkStructuredGridGeometryFilter vtkExtractGeometry vtkExtractVOI

Tests:: vtkGenericGeometryFilter (Tests)

Definition at line 57 of file vtkGenericGeometryFilter.h.


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

virtual void	SetPointClipping (int)
virtual int	GetPointClipping ()
virtual void	PointClippingOn ()
virtual void	PointClippingOff ()

virtual void	SetCellClipping (int)
virtual int	GetCellClipping ()
virtual void	CellClippingOn ()
virtual void	CellClippingOff ()

virtual void	SetExtentClipping (int)
virtual int	GetExtentClipping ()
virtual void	ExtentClippingOn ()
virtual void	ExtentClippingOff ()

virtual void	SetPointMinimum (vtkIdType)
virtual vtkIdType	GetPointMinimum ()

virtual void	SetPointMaximum (vtkIdType)
virtual vtkIdType	GetPointMaximum ()

virtual void	SetCellMinimum (vtkIdType)
virtual vtkIdType	GetCellMinimum ()

virtual void	SetCellMaximum (vtkIdType)
virtual vtkIdType	GetCellMaximum ()

void	SetExtent (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)

void	SetExtent (double extent[6])
double *	GetExtent ()

virtual void	SetMerging (int)
virtual int	GetMerging ()
virtual void	MergingOn ()
virtual void	MergingOff ()

void	SetLocator (vtkIncrementalPointLocator *locator)
virtual vtkIncrementalPointLocator *	GetLocator ()

virtual void	SetPassThroughCellIds (int)
virtual int	GetPassThroughCellIds ()
virtual void	PassThroughCellIdsOn ()
virtual void	PassThroughCellIdsOff ()
Static Public Member Functions
static vtkGenericGeometryFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkGenericGeometryFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkGenericGeometryFilter ()
	~vtkGenericGeometryFilter ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
void	PolyDataExecute ()
void	UnstructuredGridExecute ()
void	StructuredGridExecute ()
int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
int	FillInputPortInformation (int, vtkInformation *)
Protected Attributes
vtkIdType	PointMaximum
vtkIdType	PointMinimum
vtkIdType	CellMinimum
vtkIdType	CellMaximum
double	Extent [6]
int	PointClipping
int	CellClipping
int	ExtentClipping
int	Merging
vtkIncrementalPointLocator *	Locator
vtkPointData *	InternalPD
int	PassThroughCellIds

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkGenericGeometryFilter::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 61 of file vtkGenericGeometryFilter.h.

Constructor & Destructor Documentation

vtkGenericGeometryFilter::vtkGenericGeometryFilter ( ) [protected]

vtkGenericGeometryFilter::~vtkGenericGeometryFilter ( ) [protected]

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkGenericGeometryFilter::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 vtkPolyDataAlgorithm.

virtual int vtkGenericGeometryFilter::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 vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

void vtkGenericGeometryFilter::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 vtkPolyDataAlgorithm.

virtual void vtkGenericGeometryFilter::SetPointClipping ( int ) [virtual]

Turn on/off selection of geometry by point id.

virtual int vtkGenericGeometryFilter::GetPointClipping ( ) [virtual]

Turn on/off selection of geometry by point id.

virtual void vtkGenericGeometryFilter::PointClippingOn ( ) [virtual]

Turn on/off selection of geometry by point id.

virtual void vtkGenericGeometryFilter::PointClippingOff ( ) [virtual]

Turn on/off selection of geometry by point id.

virtual void vtkGenericGeometryFilter::SetCellClipping ( int ) [virtual]

Turn on/off selection of geometry by cell id.

virtual int vtkGenericGeometryFilter::GetCellClipping ( ) [virtual]

Turn on/off selection of geometry by cell id.

virtual void vtkGenericGeometryFilter::CellClippingOn ( ) [virtual]

Turn on/off selection of geometry by cell id.

virtual void vtkGenericGeometryFilter::CellClippingOff ( ) [virtual]

Turn on/off selection of geometry by cell id.

virtual void vtkGenericGeometryFilter::SetExtentClipping ( int ) [virtual]

Turn on/off selection of geometry via bounding box.

virtual int vtkGenericGeometryFilter::GetExtentClipping ( ) [virtual]

Turn on/off selection of geometry via bounding box.

virtual void vtkGenericGeometryFilter::ExtentClippingOn ( ) [virtual]

Turn on/off selection of geometry via bounding box.

virtual void vtkGenericGeometryFilter::ExtentClippingOff ( ) [virtual]

Turn on/off selection of geometry via bounding box.

virtual void vtkGenericGeometryFilter::SetPointMinimum ( vtkIdType ) [virtual]

Specify the minimum point id for point id selection.

virtual vtkIdType vtkGenericGeometryFilter::GetPointMinimum ( ) [virtual]

Specify the minimum point id for point id selection.

virtual void vtkGenericGeometryFilter::SetPointMaximum ( vtkIdType ) [virtual]

Specify the maximum point id for point id selection.

virtual vtkIdType vtkGenericGeometryFilter::GetPointMaximum ( ) [virtual]

Specify the maximum point id for point id selection.

virtual void vtkGenericGeometryFilter::SetCellMinimum ( vtkIdType ) [virtual]

Specify the minimum cell id for point id selection.

virtual vtkIdType vtkGenericGeometryFilter::GetCellMinimum ( ) [virtual]

Specify the minimum cell id for point id selection.

virtual void vtkGenericGeometryFilter::SetCellMaximum ( vtkIdType ) [virtual]

Specify the maximum cell id for point id selection.

virtual vtkIdType vtkGenericGeometryFilter::GetCellMaximum ( ) [virtual]

Specify the maximum cell id for point id selection.

void vtkGenericGeometryFilter::SetExtent	(	double	xMin,
		double	xMax,
		double	yMin,
		double	yMax,
		double	zMin,
		double	zMax
	)

Specify a (xmin,xmax, ymin,ymax, zmin,zmax) bounding box to clip data.

void vtkGenericGeometryFilter::SetExtent ( double extent[6] )

Set / get a (xmin,xmax, ymin,ymax, zmin,zmax) bounding box to clip data.

double* vtkGenericGeometryFilter::GetExtent ( ) [inline]

Set / get a (xmin,xmax, ymin,ymax, zmin,zmax) bounding box to clip data.

Definition at line 120 of file vtkGenericGeometryFilter.h.

virtual void vtkGenericGeometryFilter::SetMerging ( int ) [virtual]

Turn on/off merging of coincident points. Note that is merging is on, points with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.

virtual int vtkGenericGeometryFilter::GetMerging ( ) [virtual]

Turn on/off merging of coincident points. Note that is merging is on, points with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.

virtual void vtkGenericGeometryFilter::MergingOn ( ) [virtual]

Turn on/off merging of coincident points. Note that is merging is on, points with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.

virtual void vtkGenericGeometryFilter::MergingOff ( ) [virtual]

Turn on/off merging of coincident points. Note that is merging is on, points with different point attributes (e.g., normals) are merged, which may cause rendering artifacts.

void vtkGenericGeometryFilter::SetLocator ( vtkIncrementalPointLocator * locator )

Set / get a spatial locator for merging points. By default an instance of vtkMergePoints is used.

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

Set / get a spatial locator for merging points. By default an instance of vtkMergePoints is used.

void vtkGenericGeometryFilter::CreateDefaultLocator ( )

Create default locator. Used to create one when none is specified.

unsigned long vtkGenericGeometryFilter::GetMTime ( ) [virtual]

Return the MTime also considering the locator.

Reimplemented from vtkObject.

virtual void vtkGenericGeometryFilter::SetPassThroughCellIds ( int ) [virtual]

If on, the output polygonal dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The default is off to conserve memory.

virtual int vtkGenericGeometryFilter::GetPassThroughCellIds ( ) [virtual]

If on, the output polygonal dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The default is off to conserve memory.

virtual void vtkGenericGeometryFilter::PassThroughCellIdsOn ( ) [virtual]

If on, the output polygonal dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The default is off to conserve memory.

virtual void vtkGenericGeometryFilter::PassThroughCellIdsOff ( ) [virtual]

If on, the output polygonal dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. The default is off to conserve memory.

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

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

Reimplemented from vtkPolyDataAlgorithm.

void vtkGenericGeometryFilter::PolyDataExecute ( ) [protected]

void vtkGenericGeometryFilter::UnstructuredGridExecute ( ) [protected]

void vtkGenericGeometryFilter::StructuredGridExecute ( ) [protected]

int vtkGenericGeometryFilter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

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

Reimplemented from vtkPolyDataAlgorithm.

int vtkGenericGeometryFilter::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

Reimplemented from vtkPolyDataAlgorithm.

int vtkGenericGeometryFilter::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 vtkPolyDataAlgorithm.