VTK
9.1.0
|
Encapsulate traversal logic for vtkCellArray. More...
#include <vtkCellArrayIterator.h>
Public Member Functions | |
vtkCellArray * | GetCellArray () |
Return the vtkCellArray object over which iteration is occuring. | |
void | GoToCell (vtkIdType cellId) |
Intialize the iterator to a specific cell. | |
void | GoToFirstCell () |
The following are methods supporting forward iteration. | |
void | GoToNextCell () |
Advance the forward iterator to the next cell. | |
bool | IsDoneWithTraversal () |
Returns true if the iterator has completed the traversal. | |
vtkIdType | GetCurrentCellId () const |
Returns the id of the current cell during forward iteration. | |
void | ReplaceCurrentCell (vtkIdList *list) |
Specialized methods for performing operations on the vtkCellArray. | |
void | ReplaceCurrentCell (vtkIdType npts, const vtkIdType *pts) |
Replace the current cell with the ids in pts . | |
void | ReverseCurrentCell () |
Reverses the order of the point ids in the current cell. | |
void | GetCellAtId (vtkIdType cellId, vtkIdType &numCellPts, vtkIdType const *&cellPts) |
The following are methods supporting random access iteration. | |
void | GetCellAtId (vtkIdType cellId, vtkIdList *cellIds) |
The following are methods supporting random access iteration. | |
vtkIdList * | GetCellAtId (vtkIdType cellId) |
The following are methods supporting random access iteration. | |
void | GetCurrentCell (vtkIdType &cellSize, vtkIdType const *&cellPoints) |
Returns the definition of the current cell during forward traversal. | |
void | GetCurrentCell (vtkIdList *ids) |
Returns the definition of the current cell during forward traversal. | |
vtkIdList * | GetCurrentCell () |
Returns the definition of the current cell during forward traversal. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given 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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Protected Member Functions | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkSmartPointer< vtkCellArray > | CellArray |
vtkNew< vtkIdList > | TempCell |
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 |
typedef vtkObject | Superclass |
Standard methods for instantiation, type information, and printing. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for instantiation, type information, and printing. | |
static vtkCellArrayIterator * | SafeDownCast (vtkObjectBase *o) |
Standard methods for instantiation, type information, and printing. | |
static vtkCellArrayIterator * | New () |
Standard methods for instantiation, type information, and printing. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for instantiation, type information, and printing. | |
vtkCellArrayIterator * | NewInstance () const |
Standard methods for instantiation, type information, and printing. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for instantiation, type information, and printing. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for instantiation, type information, and printing. | |
Additional Inherited Members | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
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. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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:
Typical usage for random access looks like:
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.
Definition at line 137 of file vtkCellArrayIterator.h.
Standard methods for instantiation, type information, and printing.
Definition at line 144 of file vtkCellArrayIterator.h.
|
protecteddefault |
|
overrideprotecteddefault |
|
static |
Standard methods for instantiation, type information, and printing.
|
virtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkObjectBase.
|
static |
Standard methods for instantiation, type information, and printing.
|
protectedvirtual |
Standard methods for instantiation, type information, and printing.
vtkCellArrayIterator * vtkCellArrayIterator::NewInstance | ( | ) | const |
Standard methods for instantiation, type information, and printing.
|
overridevirtual |
Standard methods for instantiation, type information, and printing.
Reimplemented from vtkObject.
|
static |
Standard methods for instantiation, type information, and printing.
|
inline |
Return the vtkCellArray object over which iteration is occuring.
Definition at line 152 of file vtkCellArrayIterator.h.
|
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 160 of file vtkCellArrayIterator.h.
|
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 180 of file vtkCellArrayIterator.h.
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 185 of file vtkCellArrayIterator.h.
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 190 of file vtkCellArrayIterator.h.
|
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 205 of file vtkCellArrayIterator.h.
|
inline |
Advance the forward iterator to the next cell.
Definition at line 214 of file vtkCellArrayIterator.h.
|
inline |
Returns true if the iterator has completed the traversal.
Definition at line 219 of file vtkCellArrayIterator.h.
|
inline |
Returns the id of the current cell during forward iteration.
Definition at line 224 of file vtkCellArrayIterator.h.
|
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 235 of file vtkCellArrayIterator.h.
|
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 250 of file vtkCellArrayIterator.h.
|
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 255 of file vtkCellArrayIterator.h.
|
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 273 of file vtkCellArrayIterator.h.
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 284 of file vtkCellArrayIterator.h.
|
inline |
Reverses the order of the point ids in the current cell.
Definition at line 293 of file vtkCellArrayIterator.h.
|
protectedvirtual |
|
friend |
Definition at line 299 of file vtkCellArrayIterator.h.
|
protected |
Definition at line 307 of file vtkCellArrayIterator.h.
Definition at line 308 of file vtkCellArrayIterator.h.
|
protected |
Definition at line 309 of file vtkCellArrayIterator.h.
|
protected |
Definition at line 310 of file vtkCellArrayIterator.h.