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

Implementation of vtkCellIterator using vtkDataSet API. More...

#include <vtkDataSetCellIterator.h>

Inheritance diagram for vtkDataSetCellIterator:
[legend]
Collaboration diagram for vtkDataSetCellIterator:
[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...
 
vtkDataSetCellIteratorNewInstance () 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...
 
vtkCellArrayGetCellFaces ()
 Get the faces for a polyhedral 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 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkDataSetCellIteratorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetCellIteratorSafeDownCast (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 (vtkTypeBool 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 vtkTypeBool 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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSetCellIterator ()
 
 ~vtkDataSetCellIterator () 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 SetDataSet (vtkDataSet *ds)
 
- Protected Member Functions inherited from vtkCellIterator
 vtkCellIterator ()
 
 ~vtkCellIterator () override
 
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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkDataSetDataSet
 
vtkIdType CellId
 
- Protected Attributes inherited from vtkCellIterator
int CellType
 
vtkPointsPoints
 
vtkIdListPointIds
 
vtkCellArrayFaces
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkDataSet
 

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 using vtkDataSet API.

Tests:
vtkDataSetCellIterator (Tests)

Definition at line 22 of file vtkDataSetCellIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkDataSetCellIterator.h.

Constructor & Destructor Documentation

◆ vtkDataSetCellIterator()

vtkDataSetCellIterator::vtkDataSetCellIterator ( )
protected

◆ ~vtkDataSetCellIterator()

vtkDataSetCellIterator::~vtkDataSetCellIterator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDataSetCellIterator* vtkDataSetCellIterator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataSetCellIterator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataSetCellIterator* vtkDataSetCellIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkDataSetCellIterator::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 vtkDataSetCellIterator::IsDoneWithTraversal ( )
overridevirtual

Returns false while the iterator is valid.

Always safe to call.

Implements vtkCellIterator.

◆ GetCellId()

vtkIdType vtkDataSetCellIterator::GetCellId ( )
overridevirtual

Get the id of the current cell.

Implements vtkCellIterator.

◆ ResetToFirstCell()

void vtkDataSetCellIterator::ResetToFirstCell ( )
overrideprotectedvirtual

Update internal state to point to the first cell.

Implements vtkCellIterator.

◆ IncrementToNextCell()

void vtkDataSetCellIterator::IncrementToNextCell ( )
overrideprotectedvirtual

Update internal state to point to the next cell.

Implements vtkCellIterator.

◆ FetchCellType()

void vtkDataSetCellIterator::FetchCellType ( )
overrideprotectedvirtual

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

Implements vtkCellIterator.

◆ FetchPointIds()

void vtkDataSetCellIterator::FetchPointIds ( )
overrideprotectedvirtual

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

Implements vtkCellIterator.

◆ FetchPoints()

void vtkDataSetCellIterator::FetchPoints ( )
overrideprotectedvirtual

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

Implements vtkCellIterator.

◆ SetDataSet()

void vtkDataSetCellIterator::SetDataSet ( vtkDataSet ds)
protected

Friends And Related Function Documentation

◆ vtkDataSet

friend class vtkDataSet
friend

Definition at line 42 of file vtkDataSetCellIterator.h.

Member Data Documentation

◆ DataSet

vtkSmartPointer<vtkDataSet> vtkDataSetCellIterator::DataSet
protected

Definition at line 45 of file vtkDataSetCellIterator.h.

◆ CellId

vtkIdType vtkDataSetCellIterator::CellId
protected

Definition at line 46 of file vtkDataSetCellIterator.h.


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