VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMergeCells Class Reference

merges any number of vtkDataSets back into a single vtkUnstructuredGrid More...

#include <vtkMergeCells.h>

Inheritance diagram for vtkMergeCells:
[legend]
Collaboration diagram for vtkMergeCells:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkMergeCellsNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetUnstructuredGrid (vtkUnstructuredGrid *)
 
virtual vtkUnstructuredGridGetUnstructuredGrid ()
 
virtual void SetTotalNumberOfCells (vtkIdType)
 
virtual vtkIdType GetTotalNumberOfCells ()
 
virtual void SetTotalNumberOfPoints (vtkIdType)
 
virtual vtkIdType GetTotalNumberOfPoints ()
 
virtual void SetUseGlobalIds (int)
 
virtual int GetUseGlobalIds ()
 
virtual void SetPointMergeTolerance (float)
 
virtual float GetPointMergeTolerance ()
 
virtual void SetUseGlobalCellIds (int)
 
virtual int GetUseGlobalCellIds ()
 
virtual void SetMergeDuplicatePoints (int)
 
virtual int GetMergeDuplicatePoints ()
 
virtual void MergeDuplicatePointsOn ()
 
virtual void MergeDuplicatePointsOff ()
 
virtual void SetTotalNumberOfDataSets (int)
 
virtual int GetTotalNumberOfDataSets ()
 
int MergeDataSet (vtkDataSet *set)
 
void Finish ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMergeCellsSafeDownCast (vtkObjectBase *o)
 
static vtkMergeCellsNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMergeCells ()
 
 ~vtkMergeCells ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

merges any number of vtkDataSets back into a single vtkUnstructuredGrid

Designed to work with distributed vtkDataSets, this class will take vtkDataSets and merge them back into a single vtkUnstructuredGrid.

The vtkPoints object of the unstructured grid will have data type VTK_FLOAT, regardless of the data type of the points of the input vtkDataSets. If this is a problem, someone must let me know.

It is assumed the different DataSets have the same field arrays. If the name of a global point ID array is provided, this class will refrain from including duplicate points in the merged Ugrid. This class differs from vtkAppendFilter in these ways: (1) it uses less memory than that class (which uses memory equal to twice the size of the final Ugrid) but requires that you know the size of the final Ugrid in advance (2) this class assumes the individual DataSets have the same field arrays, while vtkAppendFilter intersects the field arrays (3) this class knows duplicate points may be appearing in the DataSets and can filter those out, (4) this class is not a filter.

Definition at line 57 of file vtkMergeCells.h.

Member Typedef Documentation

Definition at line 60 of file vtkMergeCells.h.

Constructor & Destructor Documentation

vtkMergeCells::vtkMergeCells ( )
protected
vtkMergeCells::~vtkMergeCells ( )
protected

Member Function Documentation

static int vtkMergeCells::IsTypeOf ( const char *  type)
static
virtual int vtkMergeCells::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 vtkObject.

static vtkMergeCells* vtkMergeCells::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMergeCells::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkMergeCells* vtkMergeCells::NewInstance ( ) const
virtual void vtkMergeCells::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 vtkObject.

static vtkMergeCells* vtkMergeCells::New ( )
static
virtual void vtkMergeCells::SetUnstructuredGrid ( vtkUnstructuredGrid )
virtual

Set the vtkUnstructuredGrid object that will become the union of the DataSets specified in MergeDataSet calls. vtkMergeCells assumes this grid is empty at first.

virtual vtkUnstructuredGrid* vtkMergeCells::GetUnstructuredGrid ( )
virtual
virtual void vtkMergeCells::SetTotalNumberOfCells ( vtkIdType  )
virtual

Specify the total number of cells in the final vtkUnstructuredGrid. Make this call before any call to MergeDataSet().

virtual vtkIdType vtkMergeCells::GetTotalNumberOfCells ( )
virtual
virtual void vtkMergeCells::SetTotalNumberOfPoints ( vtkIdType  )
virtual

Specify the total number of points in the final vtkUnstructuredGrid Make this call before any call to MergeDataSet(). This is an upper bound, since some points may be duplicates.

virtual vtkIdType vtkMergeCells::GetTotalNumberOfPoints ( )
virtual
virtual void vtkMergeCells::SetUseGlobalIds ( int  )
virtual

vtkMergeCells attempts eliminate duplicate points when merging data sets. This is done most efficiently if a global point ID field array is available. Set the name of the point array if you have one.

virtual int vtkMergeCells::GetUseGlobalIds ( )
virtual
virtual void vtkMergeCells::SetPointMergeTolerance ( float  )
virtual

vtkMergeCells attempts eliminate duplicate points when merging data sets. If no global point ID field array name is provided, it will use a point locator to find duplicate points. You can set a tolerance for that locator here. The default tolerance is 10e-4.

virtual float vtkMergeCells::GetPointMergeTolerance ( )
virtual
virtual void vtkMergeCells::SetUseGlobalCellIds ( int  )
virtual

vtkMergeCells will detect and filter out duplicate cells if you provide it the name of a global cell ID array.

virtual int vtkMergeCells::GetUseGlobalCellIds ( )
virtual
virtual void vtkMergeCells::SetMergeDuplicatePoints ( int  )
virtual

vtkMergeCells attempts eliminate duplicate points when merging data sets. If for some reason you don't want it to do this, than MergeDuplicatePointsOff().

virtual int vtkMergeCells::GetMergeDuplicatePoints ( )
virtual
virtual void vtkMergeCells::MergeDuplicatePointsOn ( )
virtual
virtual void vtkMergeCells::MergeDuplicatePointsOff ( )
virtual
virtual void vtkMergeCells::SetTotalNumberOfDataSets ( int  )
virtual

We need to know the number of different data sets that will be merged into one so we can pre-allocate some arrays. This can be an upper bound, not necessarily exact.

virtual int vtkMergeCells::GetTotalNumberOfDataSets ( )
virtual
int vtkMergeCells::MergeDataSet ( vtkDataSet set)

Provide a DataSet to be merged in to the final UnstructuredGrid. This call returns after the merge has completed. Be sure to call SetTotalNumberOfCells, SetTotalNumberOfPoints, and SetTotalNumberOfDataSets before making this call. Return 0 if OK, -1 if error.

void vtkMergeCells::Finish ( )

Call Finish() after merging last DataSet to free unneeded memory and to make sure the ugrid's GetNumberOfPoints() reflects the actual number of points set, not the number allocated.


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