VTK  9.0.20200813
Public Types | Public Member Functions | Static 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 Types

typedef vtkCellIterator Superclass
 

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...
 
vtkUnstructuredGridCellIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool IsDoneWithTraversal () override
 Returns false while the iterator is valid. More...
 
vtkIdType GetCellId () override
 Get the id of the current cell. More...
 
- Public Member Functions inherited from vtkCellIterator
 vtkAbstractTypeMacro (vtkCellIterator, vtkObject)
 
void InitTraversal ()
 Reset to the first cell. More...
 
void GoToNextCell ()
 Increment to next cell. More...
 
int GetCellType ()
 Get the current cell type (e.g. More...
 
int GetCellDimension ()
 Get the current cell dimension (0, 1, 2, or 3). 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...
 
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 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...
 
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 vtkUnstructuredGridCellIteratorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridCellIteratorSafeDownCast (vtkObjectBase *o)
 
- 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
 
 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
 
- 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 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
 

Additional Inherited Members

- 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

Definition at line 39 of file vtkUnstructuredGridCellIterator.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGridCellIterator()

vtkUnstructuredGridCellIterator::vtkUnstructuredGridCellIterator ( )
protected

◆ ~vtkUnstructuredGridCellIterator()

vtkUnstructuredGridCellIterator::~vtkUnstructuredGridCellIterator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkUnstructuredGridCellIterator* vtkUnstructuredGridCellIterator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkUnstructuredGridCellIterator::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 vtkUnstructuredGridCellIterator* vtkUnstructuredGridCellIterator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkUnstructuredGridCellIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkUnstructuredGridCellIterator* vtkUnstructuredGridCellIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkUnstructuredGridCellIterator::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 vtkCellIterator.

◆ IsDoneWithTraversal()

bool vtkUnstructuredGridCellIterator::IsDoneWithTraversal ( )
overridevirtual

Returns false while the iterator is valid.

Always safe to call.

Implements vtkCellIterator.

◆ GetCellId()

vtkIdType vtkUnstructuredGridCellIterator::GetCellId ( )
overridevirtual

Get the id of the current cell.

Implements vtkCellIterator.

◆ 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 56 of file vtkUnstructuredGridCellIterator.h.

Member Data Documentation

◆ Cells

vtkSmartPointer<vtkCellArrayIterator> vtkUnstructuredGridCellIterator::Cells
protected

Definition at line 59 of file vtkUnstructuredGridCellIterator.h.

◆ Types

vtkSmartPointer<vtkUnsignedCharArray> vtkUnstructuredGridCellIterator::Types
protected

Definition at line 60 of file vtkUnstructuredGridCellIterator.h.

◆ FaceConn

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGridCellIterator::FaceConn
protected

Definition at line 61 of file vtkUnstructuredGridCellIterator.h.

◆ FaceLocs

vtkSmartPointer<vtkIdTypeArray> vtkUnstructuredGridCellIterator::FaceLocs
protected

Definition at line 62 of file vtkUnstructuredGridCellIterator.h.

◆ Coords

vtkSmartPointer<vtkPoints> vtkUnstructuredGridCellIterator::Coords
protected

Definition at line 63 of file vtkUnstructuredGridCellIterator.h.


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