vtkGeometryFilter Class Reference

#include <vtkGeometryFilter.h>

Inheritance diagram for vtkGeometryFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkGeometryFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

vtkGeometryFilter 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 vtkGeometryFilter 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, vtkGeometryFilter will merge these points back together. Turn merging off to prevent this from occurring.
See also:
vtkImageDataGeometryFilter vtkStructuredGridGeometryFilter vtkExtractGeometry vtkExtractVOI
Examples:
vtkGeometryFilter (Examples)
Tests:
vtkGeometryFilter (Tests)

Definition at line 59 of file vtkGeometryFilter.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 ()

Static Public Member Functions

static vtkGeometryFilterNew ()
static int IsTypeOf (const char *type)
static vtkGeometryFilterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGeometryFilter ()
 ~vtkGeometryFilter ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)
void PolyDataExecute (vtkDataSet *, vtkPolyData *, vtkInformation *)
void UnstructuredGridExecute (vtkDataSet *, vtkPolyData *, vtkInformation *)
void StructuredGridExecute (vtkDataSet *, vtkPolyData *, vtkInformation *)
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkIdType PointMaximum
vtkIdType PointMinimum
vtkIdType CellMinimum
vtkIdType CellMaximum
double Extent [6]
int PointClipping
int CellClipping
int ExtentClipping
int Merging
vtkIncrementalPointLocatorLocator

Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 63 of file vtkGeometryFilter.h.


Constructor & Destructor Documentation

vtkGeometryFilter::vtkGeometryFilter (  )  [protected]

vtkGeometryFilter::~vtkGeometryFilter (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkGeometryFilter::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 vtkGeometryFilter::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 vtkGeometryFilter* vtkGeometryFilter::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkPolyDataAlgorithm.

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

Turn on/off selection of geometry by point id.

virtual int vtkGeometryFilter::GetPointClipping (  )  [virtual]

Turn on/off selection of geometry by point id.

virtual void vtkGeometryFilter::PointClippingOn (  )  [virtual]

Turn on/off selection of geometry by point id.

virtual void vtkGeometryFilter::PointClippingOff (  )  [virtual]

Turn on/off selection of geometry by point id.

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

Turn on/off selection of geometry by cell id.

virtual int vtkGeometryFilter::GetCellClipping (  )  [virtual]

Turn on/off selection of geometry by cell id.

virtual void vtkGeometryFilter::CellClippingOn (  )  [virtual]

Turn on/off selection of geometry by cell id.

virtual void vtkGeometryFilter::CellClippingOff (  )  [virtual]

Turn on/off selection of geometry by cell id.

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

Turn on/off selection of geometry via bounding box.

virtual int vtkGeometryFilter::GetExtentClipping (  )  [virtual]

Turn on/off selection of geometry via bounding box.

virtual void vtkGeometryFilter::ExtentClippingOn (  )  [virtual]

Turn on/off selection of geometry via bounding box.

virtual void vtkGeometryFilter::ExtentClippingOff (  )  [virtual]

Turn on/off selection of geometry via bounding box.

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

Specify the minimum point id for point id selection.

virtual vtkIdType vtkGeometryFilter::GetPointMinimum (  )  [virtual]

Specify the minimum point id for point id selection.

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

Specify the maximum point id for point id selection.

virtual vtkIdType vtkGeometryFilter::GetPointMaximum (  )  [virtual]

Specify the maximum point id for point id selection.

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

Specify the minimum cell id for point id selection.

virtual vtkIdType vtkGeometryFilter::GetCellMinimum (  )  [virtual]

Specify the minimum cell id for point id selection.

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

Specify the maximum cell id for point id selection.

virtual vtkIdType vtkGeometryFilter::GetCellMaximum (  )  [virtual]

Specify the maximum cell id for point id selection.

void vtkGeometryFilter::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 vtkGeometryFilter::SetExtent ( double  extent[6]  ) 

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

double* vtkGeometryFilter::GetExtent (  )  [inline]

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

Definition at line 122 of file vtkGeometryFilter.h.

virtual void vtkGeometryFilter::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 vtkGeometryFilter::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 vtkGeometryFilter::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 vtkGeometryFilter::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 vtkGeometryFilter::SetLocator ( vtkIncrementalPointLocator locator  ) 

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

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

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

void vtkGeometryFilter::CreateDefaultLocator (  ) 

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

unsigned long vtkGeometryFilter::GetMTime (  )  [virtual]

Return the MTime also considering the locator.

Reimplemented from vtkObject.

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

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

void vtkGeometryFilter::PolyDataExecute ( vtkDataSet ,
vtkPolyData ,
vtkInformation  
) [protected]

void vtkGeometryFilter::UnstructuredGridExecute ( vtkDataSet ,
vtkPolyData ,
vtkInformation  
) [protected]

void vtkGeometryFilter::StructuredGridExecute ( vtkDataSet ,
vtkPolyData ,
vtkInformation  
) [protected]

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

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

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

Definition at line 160 of file vtkGeometryFilter.h.

Definition at line 161 of file vtkGeometryFilter.h.

Definition at line 162 of file vtkGeometryFilter.h.

Definition at line 163 of file vtkGeometryFilter.h.

double vtkGeometryFilter::Extent[6] [protected]

Definition at line 164 of file vtkGeometryFilter.h.

Definition at line 165 of file vtkGeometryFilter.h.

Definition at line 166 of file vtkGeometryFilter.h.

Definition at line 167 of file vtkGeometryFilter.h.

int vtkGeometryFilter::Merging [protected]

Definition at line 169 of file vtkGeometryFilter.h.

Definition at line 170 of file vtkGeometryFilter.h.


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

Generated on Mon Sep 27 18:25:34 2010 for VTK by  doxygen 1.5.6