VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGenericCellIterator Class Referenceabstract

iterator used to traverse cells More...

#include <vtkGenericCellIterator.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkGenericCellIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Begin ()=0
 
virtual int IsAtEnd ()=0
 
virtual vtkGenericAdaptorCellNewCell ()=0
 
virtual void GetCell (vtkGenericAdaptorCell *c)=0
 
virtual vtkGenericAdaptorCellGetCell ()=0
 
virtual void Next ()=0
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkGenericCellIteratorSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkGenericCellIterator ()
 
virtual ~vtkGenericCellIterator ()
 
- 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

iterator used to traverse cells

This class (and subclasses) are used to iterate over cells. Use it only in conjunction with vtkGenericDataSet (i.e., the adaptor framework).

Typical use is:

vtkGenericDataSet *dataset;
vtkGenericCellIterator *it = dataset->NewCellIterator(2);
for (it->Begin(); !it->IsAtEnd(); it->Next());
  {
  spec=it->GetCell();
  }
Tests:
vtkGenericCellIterator (Tests)

Definition at line 43 of file vtkGenericCellIterator.h.

Member Typedef Documentation

◆ Superclass

Standard VTK construction and type macros.

Definition at line 48 of file vtkGenericCellIterator.h.

Constructor & Destructor Documentation

◆ vtkGenericCellIterator()

vtkGenericCellIterator::vtkGenericCellIterator ( )
protected

◆ ~vtkGenericCellIterator()

virtual vtkGenericCellIterator::~vtkGenericCellIterator ( )
protectedvirtual

Member Function Documentation

◆ IsTypeOf()

static int vtkGenericCellIterator::IsTypeOf ( const char *  type)
static

◆ IsA()

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

Reimplemented in vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnDataSet, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnCellBoundaries, and vtkBridgeCellIterator.

◆ SafeDownCast()

static vtkGenericCellIterator* vtkGenericCellIterator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericCellIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGenericCellIterator* vtkGenericCellIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericCellIterator::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.

Reimplemented in vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnDataSet, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnCellBoundaries, and vtkBridgeCellIterator.

◆ Begin()

virtual void vtkGenericCellIterator::Begin ( )
pure virtual

◆ IsAtEnd()

virtual int vtkGenericCellIterator::IsAtEnd ( )
pure virtual

◆ NewCell()

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::NewCell ( )
pure virtual

Create an empty cell. The user is responsible for deleting it.

Postcondition
result_exists: result!=0

Implemented in vtkBridgeCellIteratorStrategy, and vtkBridgeCellIterator.

◆ GetCell() [1/2]

virtual void vtkGenericCellIterator::GetCell ( vtkGenericAdaptorCell c)
pure virtual

Get the cell at current position. The cell should be instantiated with the NewCell() method.

Precondition
not_at_end: !IsAtEnd()
c_exists: c!=0 THREAD SAFE

Implemented in vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnDataSet, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnCellBoundaries, and vtkBridgeCellIterator.

◆ GetCell() [2/2]

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::GetCell ( )
pure virtual

Get the cell at the current traversal position. NOT THREAD SAFE

Precondition
not_at_end: !IsAtEnd()
Postcondition
result_exits: result!=0

Implemented in vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnDataSet, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnCellBoundaries, and vtkBridgeCellIterator.

◆ Next()

virtual void vtkGenericCellIterator::Next ( )
pure virtual

Move the iterator to the next position in the list.

Precondition
not_at_end: !IsAtEnd()

Implemented in vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnDataSet, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnCellBoundaries, and vtkBridgeCellIterator.


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