Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkPolyDataConnectivityFilter Class Reference

#include <vtkPolyDataConnectivityFilter.h>

Inheritance diagram for vtkPolyDataConnectivityFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkPolyDataConnectivityFilter:

Collaboration graph
[legend]
List of all members.

Detailed Description

extract polygonal data based on geometric connectivity

vtkPolyDataConnectivityFilter is a filter that extracts cells that share common points and/or satisfy a scalar threshold criterion. (Such a group of cells is called a region.) The filter works in one of six ways: 1) extract the largest connected region in the dataset; 2) extract specified region numbers; 3) extract all regions sharing specified point ids; 4) extract all regions sharing specified cell ids; 5) extract the region closest to the specified point; or 6) extract all regions (used to color regions).

This filter is specialized for polygonal data. This means it runs a bit faster and is easier to construct visualization networks that process polygonal data.

The behavior of vtkPolyDataConnectivityFilter can be modified by turning on the boolean ivar ScalarConnectivity. If this flag is on, the connectivity algorithm is modified so that cells are considered connected only if 1) they are geometrically connected (share a point) and 2) the scalar values of one of the cell's points falls in the scalar range specified. This use of ScalarConnectivity is particularly useful for selecting cells for later processing.

See also:
vtkConnectivityFilter
Created by:
  • Schroeder, Will
CVS contributions (if > 5%):
  • Schroeder, Will (61%)
  • Martin, Ken (17%)
  • Lorensen, Bill (6%)
  • Law, Charles (5%)
CVS logs (CVSweb):
  • .cxx (/Graphics/vtkPolyDataConnectivityFilter.cxx)
  • .h (/Graphics/vtkPolyDataConnectivityFilter.h)
Tests:
vtkPolyDataConnectivityFilter (Tests)

Definition at line 75 of file vtkPolyDataConnectivityFilter.h.

Public Types

typedef vtkPolyDataToPolyDataFilter Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void InitializeSeedList ()
void AddSeed (int id)
void DeleteSeed (int id)
void InitializeSpecifiedRegionList ()
void AddSpecifiedRegion (int id)
void DeleteSpecifiedRegion (int id)
int GetNumberOfExtractedRegions ()
virtual void SetScalarConnectivity (int)
virtual int GetScalarConnectivity ()
virtual void ScalarConnectivityOn ()
virtual void ScalarConnectivityOff ()
virtual void SetScalarRange (double data[])
virtual double * GetScalarRange ()
virtual void GetScalarRange (double data[2])
virtual void SetExtractionMode (int)
virtual int GetExtractionMode ()
void SetExtractionModeToPointSeededRegions ()
void SetExtractionModeToCellSeededRegions ()
void SetExtractionModeToLargestRegion ()
void SetExtractionModeToSpecifiedRegions ()
void SetExtractionModeToClosestPointRegion ()
void SetExtractionModeToAllRegions ()
const char * GetExtractionModeAsString ()
virtual void SetClosestPoint (double, double, double)
virtual void SetClosestPoint (double[3])
virtual double * GetClosestPoint ()
virtual void GetClosestPoint (double data[3])
virtual void SetColorRegions (int)
virtual int GetColorRegions ()
virtual void ColorRegionsOn ()
virtual void ColorRegionsOff ()

Static Public Member Functions

int IsTypeOf (const char *type)
vtkPolyDataConnectivityFilterSafeDownCast (vtkObject *o)
vtkPolyDataConnectivityFilterNew ()

Protected Member Functions

 vtkPolyDataConnectivityFilter ()
 ~vtkPolyDataConnectivityFilter ()
void Execute ()
void TraverseAndMark ()

Protected Attributes

int ColorRegions
int ExtractionMode
vtkIdListSeeds
vtkIdListSpecifiedRegionIds
vtkIdTypeArrayRegionSizes
double ClosestPoint [3]
int ScalarConnectivity
double ScalarRange [2]


Member Typedef Documentation

typedef vtkPolyDataToPolyDataFilter vtkPolyDataConnectivityFilter::Superclass
 

Reimplemented from vtkPolyDataToPolyDataFilter.

Definition at line 78 of file vtkPolyDataConnectivityFilter.h.


Constructor & Destructor Documentation

vtkPolyDataConnectivityFilter::vtkPolyDataConnectivityFilter  )  [protected]
 

vtkPolyDataConnectivityFilter::~vtkPolyDataConnectivityFilter  )  [protected]
 


Member Function Documentation

virtual const char* vtkPolyDataConnectivityFilter::GetClassName  )  [virtual]
 

Reimplemented from vtkPolyDataToPolyDataFilter.

int vtkPolyDataConnectivityFilter::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

virtual int vtkPolyDataConnectivityFilter::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

vtkPolyDataConnectivityFilter* vtkPolyDataConnectivityFilter::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkPolyDataToPolyDataFilter.

void vtkPolyDataConnectivityFilter::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 vtkPolyDataToPolyDataFilter.

vtkPolyDataConnectivityFilter* vtkPolyDataConnectivityFilter::New  )  [static]
 

Construct with default extraction mode to extract largest regions.

Reimplemented from vtkAlgorithm.

virtual void vtkPolyDataConnectivityFilter::SetScalarConnectivity int   )  [virtual]
 

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual int vtkPolyDataConnectivityFilter::GetScalarConnectivity  )  [virtual]
 

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual void vtkPolyDataConnectivityFilter::ScalarConnectivityOn  )  [virtual]
 

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual void vtkPolyDataConnectivityFilter::ScalarConnectivityOff  )  [virtual]
 

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual void vtkPolyDataConnectivityFilter::SetScalarRange double  data[]  )  [virtual]
 

Set the scalar range to use to extract cells based on scalar connectivity.

virtual double* vtkPolyDataConnectivityFilter::GetScalarRange  )  [virtual]
 

Set the scalar range to use to extract cells based on scalar connectivity.

virtual void vtkPolyDataConnectivityFilter::GetScalarRange double  data[2]  )  [virtual]
 

Set the scalar range to use to extract cells based on scalar connectivity.

virtual void vtkPolyDataConnectivityFilter::SetExtractionMode int   )  [virtual]
 

Control the extraction of connected surfaces.

virtual int vtkPolyDataConnectivityFilter::GetExtractionMode  )  [virtual]
 

Control the extraction of connected surfaces.

void vtkPolyDataConnectivityFilter::SetExtractionModeToPointSeededRegions  )  [inline]
 

Control the extraction of connected surfaces.

Definition at line 106 of file vtkPolyDataConnectivityFilter.h.

References VTK_EXTRACT_POINT_SEEDED_REGIONS.

void vtkPolyDataConnectivityFilter::SetExtractionModeToCellSeededRegions  )  [inline]
 

Control the extraction of connected surfaces.

Definition at line 108 of file vtkPolyDataConnectivityFilter.h.

References VTK_EXTRACT_CELL_SEEDED_REGIONS.

void vtkPolyDataConnectivityFilter::SetExtractionModeToLargestRegion  )  [inline]
 

Control the extraction of connected surfaces.

Definition at line 110 of file vtkPolyDataConnectivityFilter.h.

References VTK_EXTRACT_LARGEST_REGION.

void vtkPolyDataConnectivityFilter::SetExtractionModeToSpecifiedRegions  )  [inline]
 

Control the extraction of connected surfaces.

Definition at line 112 of file vtkPolyDataConnectivityFilter.h.

References VTK_EXTRACT_SPECIFIED_REGIONS.

void vtkPolyDataConnectivityFilter::SetExtractionModeToClosestPointRegion  )  [inline]
 

Control the extraction of connected surfaces.

Definition at line 114 of file vtkPolyDataConnectivityFilter.h.

References VTK_EXTRACT_CLOSEST_POINT_REGION.

void vtkPolyDataConnectivityFilter::SetExtractionModeToAllRegions  )  [inline]
 

Control the extraction of connected surfaces.

Definition at line 116 of file vtkPolyDataConnectivityFilter.h.

References VTK_EXTRACT_ALL_REGIONS.

const char * vtkPolyDataConnectivityFilter::GetExtractionModeAsString void   )  [inline]
 

Return the method of extraction as a string.

Definition at line 198 of file vtkPolyDataConnectivityFilter.h.

References ExtractionMode.

void vtkPolyDataConnectivityFilter::InitializeSeedList  ) 
 

Initialize list of point ids/cell ids used to seed regions.

void vtkPolyDataConnectivityFilter::AddSeed int  id  ) 
 

Add a seed id (point or cell id). Note: ids are 0-offset.

void vtkPolyDataConnectivityFilter::DeleteSeed int  id  ) 
 

Delete a seed id (point or cell id). Note: ids are 0-offset.

void vtkPolyDataConnectivityFilter::InitializeSpecifiedRegionList  ) 
 

Initialize list of region ids to extract.

void vtkPolyDataConnectivityFilter::AddSpecifiedRegion int  id  ) 
 

Add a region id to extract. Note: ids are 0-offset.

void vtkPolyDataConnectivityFilter::DeleteSpecifiedRegion int  id  ) 
 

Delete a region id to extract. Note: ids are 0-offset.

virtual void vtkPolyDataConnectivityFilter::SetClosestPoint double  ,
double  ,
double 
[virtual]
 

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual void vtkPolyDataConnectivityFilter::SetClosestPoint double  [3]  )  [virtual]
 

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual double* vtkPolyDataConnectivityFilter::GetClosestPoint  )  [virtual]
 

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual void vtkPolyDataConnectivityFilter::GetClosestPoint double  data[3]  )  [virtual]
 

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

int vtkPolyDataConnectivityFilter::GetNumberOfExtractedRegions  ) 
 

Obtain the number of connected regions.

virtual void vtkPolyDataConnectivityFilter::SetColorRegions int   )  [virtual]
 

Turn on/off the coloring of connected regions.

virtual int vtkPolyDataConnectivityFilter::GetColorRegions  )  [virtual]
 

Turn on/off the coloring of connected regions.

virtual void vtkPolyDataConnectivityFilter::ColorRegionsOn  )  [virtual]
 

Turn on/off the coloring of connected regions.

virtual void vtkPolyDataConnectivityFilter::ColorRegionsOff  )  [virtual]
 

Turn on/off the coloring of connected regions.

void vtkPolyDataConnectivityFilter::Execute  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

void vtkPolyDataConnectivityFilter::TraverseAndMark  )  [protected]
 


Member Data Documentation

int vtkPolyDataConnectivityFilter::ColorRegions [protected]
 

Definition at line 163 of file vtkPolyDataConnectivityFilter.h.

int vtkPolyDataConnectivityFilter::ExtractionMode [protected]
 

Definition at line 164 of file vtkPolyDataConnectivityFilter.h.

Referenced by GetExtractionModeAsString().

vtkIdList* vtkPolyDataConnectivityFilter::Seeds [protected]
 

Definition at line 165 of file vtkPolyDataConnectivityFilter.h.

vtkIdList* vtkPolyDataConnectivityFilter::SpecifiedRegionIds [protected]
 

Definition at line 166 of file vtkPolyDataConnectivityFilter.h.

vtkIdTypeArray* vtkPolyDataConnectivityFilter::RegionSizes [protected]
 

Definition at line 167 of file vtkPolyDataConnectivityFilter.h.

double vtkPolyDataConnectivityFilter::ClosestPoint[3] [protected]
 

Definition at line 169 of file vtkPolyDataConnectivityFilter.h.

int vtkPolyDataConnectivityFilter::ScalarConnectivity [protected]
 

Definition at line 171 of file vtkPolyDataConnectivityFilter.h.

double vtkPolyDataConnectivityFilter::ScalarRange[2] [protected]
 

Definition at line 172 of file vtkPolyDataConnectivityFilter.h.


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