VTK  9.1.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkUnstructuredGridCellIterator Class Reference

Implementation of vtkCellIterator specialized for vtkUnstructuredGrid. More...

#include <vtkUnstructuredGridCellIterator.h>

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

Public Member Functions

void GoToCell (vtkIdType cellId)
 A method used to provide random access into cells. More...
 
bool IsDoneWithTraversal () override
 Override superclass methods. More...
 
vtkIdType GetCellId () override
 Override superclass methods. More...
 
- Public Member Functions inherited from vtkCellIterator
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
 vtkAbstractTypeMacro (vtkCellIterator, vtkObject)
 
void InitTraversal ()
 Reset to the first cell. More...
 
void GoToNextCell ()
 Increment to next cell. More...
 
virtual bool IsDoneWithTraversal ()=0
 Returns false while the iterator is valid. More...
 
int GetCellType ()
 Get the current cell type (e.g. More...
 
int GetCellDimension ()
 Get the current cell dimension (0, 1, 2, or 3). More...
 
virtual vtkIdType GetCellId ()=0
 Get the id of the current cell. More...
 
vtkIdListGetPointIds ()
 Get the ids of the points in the current cell. More...
 
vtkPointsGetPoints ()
 Get the points in the current cell. More...
 
vtkIdListGetFaces ()
 Get the faces for a polyhedral cell. More...
 
void GetCell (vtkGenericCell *cell)
 Write the current full cell information into the argument. More...
 
vtkIdType GetNumberOfPoints ()
 Return the number of points in the current cell. More...
 
vtkIdType GetNumberOfFaces ()
 Return the number of faces 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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
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). 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkUnstructuredGridCellIterator ()
 
 ~vtkUnstructuredGridCellIterator () override
 
void ResetToFirstCell () override
 Update internal state to point to the first cell. More...
 
void IncrementToNextCell () override
 Update internal state to point to the next cell. More...
 
void FetchCellType () override
 Lookup the cell type in the data set and store it in this->CellType. More...
 
void FetchPointIds () override
 Lookup the cell point ids in the data set and store them in this->PointIds. More...
 
void FetchPoints () override
 Lookup the cell points in the data set and store them in this->Points. More...
 
void FetchFaces () override
 Lookup the cell faces in the data set and store them in this->Faces. More...
 
void SetUnstructuredGrid (vtkUnstructuredGrid *ug)
 
- Protected Member Functions inherited from vtkCellIterator
 vtkCellIterator ()
 
 ~vtkCellIterator () override
 
virtual void ResetToFirstCell ()=0
 Update internal state to point to the first cell. More...
 
virtual void IncrementToNextCell ()=0
 Update internal state to point to the next cell. More...
 
virtual void FetchCellType ()=0
 Lookup the cell type in the data set and store it in this->CellType. More...
 
virtual void FetchPointIds ()=0
 Lookup the cell point ids in the data set and store them in this->PointIds. More...
 
virtual void FetchPoints ()=0
 Lookup the cell points in the data set and store them in this->Points. More...
 
virtual void FetchFaces ()
 Lookup the cell faces in the data set and store them in this->Faces. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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< vtkCellArrayIteratorCells
 
vtkSmartPointer< vtkUnsignedCharArrayTypes
 
vtkSmartPointer< vtkIdTypeArrayFaceConn
 
vtkSmartPointer< vtkIdTypeArrayFaceLocs
 
vtkSmartPointer< vtkPointsCoords
 
- Protected Attributes inherited from vtkCellIterator
int CellType
 
vtkPointsPoints
 
vtkIdListPointIds
 
vtkIdListFaces
 
- 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 vtkUnstructuredGrid
 
typedef vtkCellIterator Superclass
 Standard methods for instantiation, type information, and printing. More...
 
static vtkUnstructuredGridCellIteratorNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, type information, and printing. More...
 
static vtkUnstructuredGridCellIteratorSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, type information, and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, type information, and printing. More...
 
vtkUnstructuredGridCellIteratorNewInstance () const
 Standard methods for instantiation, type information, and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, type information, and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, type information, and printing. More...
 

Additional Inherited Members

- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Implementation of vtkCellIterator specialized for vtkUnstructuredGrid.

Definition at line 35 of file vtkUnstructuredGridCellIterator.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 43 of file vtkUnstructuredGridCellIterator.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGridCellIterator()

vtkUnstructuredGridCellIterator::vtkUnstructuredGridCellIterator ( )
protected

◆ ~vtkUnstructuredGridCellIterator()

vtkUnstructuredGridCellIterator::~vtkUnstructuredGridCellIterator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkUnstructuredGridCellIterator * vtkUnstructuredGridCellIterator::New ( )
static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

Standard methods for instantiation, type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkUnstructuredGridCellIterator::IsA ( const char *  type)
virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

Standard methods for instantiation, type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUnstructuredGridCellIterator::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, type information, and printing.

◆ NewInstance()

vtkUnstructuredGridCellIterator * vtkUnstructuredGridCellIterator::NewInstance ( ) const

Standard methods for instantiation, type information, and printing.

◆ PrintSelf()

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

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkCellIterator.

◆ IsDoneWithTraversal()

bool vtkUnstructuredGridCellIterator::IsDoneWithTraversal ( )
overridevirtual

Override superclass methods.

Implements vtkCellIterator.

◆ GetCellId()

vtkIdType vtkUnstructuredGridCellIterator::GetCellId ( )
overridevirtual

Override superclass methods.

Implements vtkCellIterator.

◆ GoToCell()

void vtkUnstructuredGridCellIterator::GoToCell ( vtkIdType  cellId)
inline

A method used to provide random access into cells.

The iterator is initialized to a specific cell. 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 61 of file vtkUnstructuredGridCellIterator.h.

◆ ResetToFirstCell()

void vtkUnstructuredGridCellIterator::ResetToFirstCell ( )
overrideprotectedvirtual

Update internal state to point to the first cell.

Implements vtkCellIterator.

◆ IncrementToNextCell()

void vtkUnstructuredGridCellIterator::IncrementToNextCell ( )
overrideprotectedvirtual

Update internal state to point to the next cell.

Implements vtkCellIterator.

◆ FetchCellType()

void vtkUnstructuredGridCellIterator::FetchCellType ( )
overrideprotectedvirtual

Lookup the cell type in the data set and store it in this->CellType.

Implements vtkCellIterator.

◆ FetchPointIds()

void vtkUnstructuredGridCellIterator::FetchPointIds ( )
overrideprotectedvirtual

Lookup the cell point ids in the data set and store them in this->PointIds.

Implements vtkCellIterator.

◆ FetchPoints()

void vtkUnstructuredGridCellIterator::FetchPoints ( )
overrideprotectedvirtual

Lookup the cell points in the data set and store them in this->Points.

Implements vtkCellIterator.

◆ FetchFaces()

void vtkUnstructuredGridCellIterator::FetchFaces ( )
overrideprotectedvirtual

Lookup the cell faces in the data set and store them in this->Faces.

Few data sets support faces, so this method has a no-op default implementation. See vtkUnstructuredGrid::GetFaceStream for a description of the layout that Faces should have.

Reimplemented from vtkCellIterator.

◆ SetUnstructuredGrid()

void vtkUnstructuredGridCellIterator::SetUnstructuredGrid ( vtkUnstructuredGrid ug)
protected

Friends And Related Function Documentation

◆ vtkUnstructuredGrid

friend class vtkUnstructuredGrid
friend

Definition at line 74 of file vtkUnstructuredGridCellIterator.h.

Member Data Documentation

◆ Cells

vtkSmartPointer<vtkCellArrayIterator> vtkUnstructuredGridCellIterator::Cells
protected

Definition at line 77 of file vtkUnstructuredGridCellIterator.h.

◆ Types

vtkSmartPointer<vtkUnsignedCharArray> vtkUnstructuredGridCellIterator::Types
protected

Definition at line 78 of file vtkUnstructuredGridCellIterator.h.

◆ FaceConn

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGridCellIterator::FaceConn
protected

Definition at line 79 of file vtkUnstructuredGridCellIterator.h.

◆ FaceLocs

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGridCellIterator::FaceLocs
protected

Definition at line 80 of file vtkUnstructuredGridCellIterator.h.

◆ Coords

vtkSmartPointer<vtkPoints> vtkUnstructuredGridCellIterator::Coords
protected

Definition at line 81 of file vtkUnstructuredGridCellIterator.h.


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