VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCellArrayIterator Class Reference

Encapsulate traversal logic for vtkCellArray. More...

#include <vtkCellArrayIterator.h>

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

Public Types

typedef vtkObject Superclass
 Standard methods for instantiation, type information, and printing. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCellArrayIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkCellArrayGetCellArray ()
 Return the vtkCellArray object over which iteration is occuring. More...
 
void GoToCell (vtkIdType cellId)
 Intialize the iterator to a specific cell. More...
 
void GetCellAtId (vtkIdType cellId, vtkIdType &numCellPts, vtkIdType const *&cellPts)
 The following are methods supporting random access iteration. More...
 
void GetCellAtId (vtkIdType cellId, vtkIdList *cellIds)
 
vtkIdListGetCellAtId (vtkIdType cellId)
 
void GoToFirstCell ()
 The following are methods supporting forward iteration. More...
 
void GoToNextCell ()
 Advance the forward iterator to the next cell. More...
 
bool IsDoneWithTraversal ()
 Returns true if the iterator has completed the traversal. More...
 
vtkIdType GetCurrentCellId () const
 Returns the id of the current cell during forward iteration. More...
 
void GetCurrentCell (vtkIdType &cellSize, vtkIdType const *&cellPoints)
 Returns the definition of the current cell during forward traversal. More...
 
void GetCurrentCell (vtkIdList *ids)
 
vtkIdListGetCurrentCell ()
 
void ReplaceCurrentCell (vtkIdList *list)
 Specialized methods for performing operations on the vtkCellArray. More...
 
void ReplaceCurrentCell (vtkIdType npts, const vtkIdType *pts)
 Replace the current cell with the ids in pts. More...
 
void ReverseCurrentCell ()
 Reverses the order of the point ids in the current cell. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellArrayIteratorSafeDownCast (vtkObjectBase *o)
 
static vtkCellArrayIteratorNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCellArrayIterator ()=default
 
 ~vtkCellArrayIterator () override=default
 
virtual void SetCellArray (vtkCellArray *)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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 &)
 

Protected Attributes

vtkSmartPointer< vtkCellArrayCellArray
 
vtkNew< vtkIdListTempCell
 
vtkIdType CurrentCellId
 
vtkIdType NumberOfCells
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkCellArray
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Encapsulate traversal logic for vtkCellArray.

This is iterator for thread-safe traversal of a vtkCellArray. It provides random access and forward iteration. Typical usage for forward iteration looks like:

auto iter = vtk::TakeSmartPointer(cellArray->NewIterator());
for (iter->GoToFirstCell(); !iter->IsDoneWithTraversal(); iter->GoToNextCell())
{
// do work with iter
iter->GetCurrentCell(numCellPts, cellPts);
}

Typical usage for random access looks like:

auto iter = vtk::TakeSmartPointer(cellArray->NewIterator());
iter->GetCellAtId(cellId, numCellPts, cellPts);

Here cellId is the id of the ith cell in the vtkCellArray; numCellPts is the number of points defining the cell represented as vtkIdType; and cellPts is a pointer to the point ids defined as vtkIdType const*&.

Internally the iterator may copy data from the vtkCellArray, or reference the internal vtkCellArray storage. This depends on the relationship of vtkIdType to the type and structure of internal storage. If the type of storage is the same as vtkIdType, and the storage is a single-component AOS array (i.e., a 1D array), then shared access to the vtkCellArray storage is provided. Otherwise, the data from storage is copied into an internal iterator buffer. (Of course copying is slower and can result in 3-4x reduction in traversal performance. On the other hand, the vtkCellArray can use the appropriate storage to save memory, perform zero-copy, and/or efficiently represent the cell connectivity information.) Note that referencing internal vtkCellArray storage has implications on the validity of the iterator. If the underlying vtkCellArray storage changes while iterating, and the iterator is referencing this storage, unpredictable and catastrophic results are likely - hence do not modify the vtkCellArray while iterating.

See also
vtkCellArray

Definition at line 78 of file vtkCellArrayIterator.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 85 of file vtkCellArrayIterator.h.

Constructor & Destructor Documentation

◆ vtkCellArrayIterator()

vtkCellArrayIterator::vtkCellArrayIterator ( )
protecteddefault

◆ ~vtkCellArrayIterator()

vtkCellArrayIterator::~vtkCellArrayIterator ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkCellArrayIterator::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkCellArrayIterator::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCellArrayIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCellArrayIterator* vtkCellArrayIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkCellArrayIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ New()

static vtkCellArrayIterator* vtkCellArrayIterator::New ( )
static

◆ GetCellArray()

vtkCellArray* vtkCellArrayIterator::GetCellArray ( )
inline

Return the vtkCellArray object over which iteration is occuring.

Definition at line 93 of file vtkCellArrayIterator.h.

◆ GoToCell()

void vtkCellArrayIterator::GoToCell ( vtkIdType  cellId)
inline

Intialize the iterator to a specific cell.

This will revalidate the iterator if the underlying vtkCellArray has been modified. This method can always be used to set the starting location for forward iteration, and it is also used to support random access.

Definition at line 101 of file vtkCellArrayIterator.h.

◆ GetCellAtId() [1/3]

void vtkCellArrayIterator::GetCellAtId ( vtkIdType  cellId,
vtkIdType numCellPts,
vtkIdType const *&  cellPts 
)
inline

The following are methods supporting random access iteration.

Initialize the iterator to a specific cell and return the cell. Note that methods passing vtkIdLists always copy data from the vtkCellArray storage buffer into the vtkIdList. Otherwise, a fastpath returning (numCellPts,cellPts) which may return a pointer to internal vtkCellArray storage is possible, if vtkIdType is the same as the vtkCellArray buffer (which is typical).

Definition at line 121 of file vtkCellArrayIterator.h.

◆ GetCellAtId() [2/3]

void vtkCellArrayIterator::GetCellAtId ( vtkIdType  cellId,
vtkIdList cellIds 
)
inline

Definition at line 126 of file vtkCellArrayIterator.h.

◆ GetCellAtId() [3/3]

vtkIdList* vtkCellArrayIterator::GetCellAtId ( vtkIdType  cellId)
inline

Definition at line 131 of file vtkCellArrayIterator.h.

◆ GoToFirstCell()

void vtkCellArrayIterator::GoToFirstCell ( )
inline

The following are methods supporting forward iteration.

Initialize the iterator for forward iteration. This will revalidate the iterator if the underlying vtkCellArray has been modified.

Definition at line 146 of file vtkCellArrayIterator.h.

◆ GoToNextCell()

void vtkCellArrayIterator::GoToNextCell ( )
inline

Advance the forward iterator to the next cell.

Definition at line 155 of file vtkCellArrayIterator.h.

◆ IsDoneWithTraversal()

bool vtkCellArrayIterator::IsDoneWithTraversal ( )
inline

Returns true if the iterator has completed the traversal.

Definition at line 160 of file vtkCellArrayIterator.h.

◆ GetCurrentCellId()

vtkIdType vtkCellArrayIterator::GetCurrentCellId ( ) const
inline

Returns the id of the current cell during forward iteration.

Definition at line 165 of file vtkCellArrayIterator.h.

◆ GetCurrentCell() [1/3]

void vtkCellArrayIterator::GetCurrentCell ( vtkIdType cellSize,
vtkIdType const *&  cellPoints 
)
inline

Returns the definition of the current cell during forward traversal.

Note that methods passing vtkIdLists always copy data from the vtkCellArray storage buffer into the vtkIdList. Otherwise, a fastpath returning (numCellPts,cellPts) - which may return a pointer to internal vtkCellArray storage - is possible, if vtkIdType is the same as the vtkCellArray storage (which is typical).

Definition at line 176 of file vtkCellArrayIterator.h.

◆ GetCurrentCell() [2/3]

void vtkCellArrayIterator::GetCurrentCell ( vtkIdList ids)
inline

Definition at line 191 of file vtkCellArrayIterator.h.

◆ GetCurrentCell() [3/3]

vtkIdList* vtkCellArrayIterator::GetCurrentCell ( )
inline

Definition at line 196 of file vtkCellArrayIterator.h.

◆ ReplaceCurrentCell() [1/2]

void vtkCellArrayIterator::ReplaceCurrentCell ( vtkIdList list)
inline

Specialized methods for performing operations on the vtkCellArray.

Replace the current cell with the ids in list. Note that this method CANNOT change the number of points in the cell, it can only redefine the ids (e.g. list must contain the same number of entries as the current cell's points).

Definition at line 214 of file vtkCellArrayIterator.h.

◆ ReplaceCurrentCell() [2/2]

void vtkCellArrayIterator::ReplaceCurrentCell ( vtkIdType  npts,
const vtkIdType pts 
)
inline

Replace the current cell with the ids in pts.

Note that this method CANNOT change the number of points in the cell, it can only redefine the ids (e.g. npts must equal the current cell's number of points).

Definition at line 225 of file vtkCellArrayIterator.h.

◆ ReverseCurrentCell()

void vtkCellArrayIterator::ReverseCurrentCell ( )
inline

Reverses the order of the point ids in the current cell.

Definition at line 234 of file vtkCellArrayIterator.h.

◆ SetCellArray()

virtual void vtkCellArrayIterator::SetCellArray ( vtkCellArray )
protectedvirtual

Friends And Related Function Documentation

◆ vtkCellArray

friend class vtkCellArray
friend

Definition at line 240 of file vtkCellArrayIterator.h.

Member Data Documentation

◆ CellArray

vtkSmartPointer<vtkCellArray> vtkCellArrayIterator::CellArray
protected

Definition at line 246 of file vtkCellArrayIterator.h.

◆ TempCell

vtkNew<vtkIdList> vtkCellArrayIterator::TempCell
protected

Definition at line 249 of file vtkCellArrayIterator.h.

◆ CurrentCellId

vtkIdType vtkCellArrayIterator::CurrentCellId
protected

Definition at line 250 of file vtkCellArrayIterator.h.

◆ NumberOfCells

vtkIdType vtkCellArrayIterator::NumberOfCells
protected

Definition at line 251 of file vtkCellArrayIterator.h.


The documentation for this class was generated from the following file:
vtk::TakeSmartPointer
vtkSmartPointer< T > TakeSmartPointer(T *obj)
Construct a vtkSmartPointer<T> containing obj.
Definition: vtkSmartPointer.h:341