VTK
Public Member Functions | Protected Member Functions
vtkGenericCellIterator Class Reference

iterator used to traverse cells More...

#include <vtkGenericCellIterator.h>

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

List of all members.

- Public Types inherited from vtkObject

Public Member Functions

virtual void Begin ()=0
virtual int IsAtEnd ()=0
virtual vtkGenericAdaptorCell * NewCell ()=0
virtual void GetCell (vtkGenericAdaptorCell *c)=0
virtual vtkGenericAdaptorCell * GetCell ()=0
virtual void Next ()=0
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommand * GetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()
- Static Public Member Functions inherited from vtkObject
static vtkObject * New ()
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)
typedef vtkObject Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
static int IsTypeOf (const char *type)
static vtkGenericCellIterator * SafeDownCast (vtkObject *o)

Additional Inherited Members

- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int 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 42 of file vtkGenericCellIterator.h.

Member Typedef Documentation

typedef vtkObject vtkGenericCellIterator::Superclass

Standard VTK construction and type macros.

Reimplemented from vtkObject.

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

Definition at line 47 of file vtkGenericCellIterator.h.

Constructor & Destructor Documentation

vtkGenericCellIterator::vtkGenericCellIterator ( )
protected
virtual vtkGenericCellIterator::~vtkGenericCellIterator ( )
protectedvirtual

Member Function Documentation

virtual const char* vtkGenericCellIterator::GetClassName ( )
virtual

Standard VTK construction and type macros.

Reimplemented from vtkObject.

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

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

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

virtual int vtkGenericCellIterator::IsA ( const char *  type)
virtual

Standard VTK construction and type macros.

Reimplemented from vtkObject.

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

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

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

void vtkGenericCellIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Standard VTK construction and type macros.

Reimplemented from vtkObject.

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

virtual void vtkGenericCellIterator::Begin ( )
pure virtual

Move iterator to first position if any (loop initialization).

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

virtual int vtkGenericCellIterator::IsAtEnd ( )
pure virtual

Is the iterator at the end of traversal?

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

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::NewCell ( )
pure virtual

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

Postcondition:
result_exists: result!=0

Implemented in vtkBridgeCellIterator, and vtkBridgeCellIteratorStrategy.

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 vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

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 vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual void vtkGenericCellIterator::Next ( )
pure virtual

Move the iterator to the next position in the list.

Precondition:
not_at_end: !IsAtEnd()

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

The documentation for this class was generated from the following file:
Generated on Wed May 30 2012 13:23:28 for VTK by   doxygen 1.8.1