VTK  9.3.20240725
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractCellArray Class Referenceabstract

abstract object to represent cell connectivity More...

#include <vtkAbstractCellArray.h>

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

Public Types

typedef vtkObject 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.
 
vtkAbstractCellArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void Initialize ()=0
 Free any memory and reset to an empty state.
 
virtual vtkIdType GetNumberOfCells () const =0
 Get the number of cells in the array.
 
virtual vtkIdType GetNumberOfOffsets () const =0
 Get the number of elements in the offsets array.
 
virtual vtkIdType GetOffset (vtkIdType cellId)=0
 Get the offset (into the connectivity) for a specified cell id.
 
virtual vtkIdType GetNumberOfConnectivityIds () const =0
 Get the size of the connectivity array that stores the point ids.
 
virtual bool IsStorageShareable () const =0
 
virtual vtkIdType IsHomogeneous ()=0
 Check if all cells have the same number of vertices.
 
void GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints)
 Return the point ids for the cell at cellId.
 
virtual void GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *ptIds)=0
 Return the point ids for the cell at cellId.
 
virtual void GetCellAtId (vtkIdType cellId, vtkIdList *pts)=0
 Return the point ids for the cell at cellId.
 
virtual void GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType *cellPoints)=0
 Return the point ids for the cell at cellId.
 
virtual vtkIdType GetCellSize (vtkIdType cellId) const =0
 Return the size of the cell at cellId.
 
virtual int GetMaxCellSize ()=0
 Returns the size of the largest cell.
 
virtual void DeepCopy (vtkAbstractCellArray *ca)=0
 Perform a deep copy (no reference counting) of the given cell array.
 
virtual void ShallowCopy (vtkAbstractCellArray *ca)=0
 Shallow copy ca into this cell array.
 
- 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkCommandGetCommand (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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractCellArraySafeDownCast (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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractCellArray ()
 
 ~vtkAbstractCellArray () 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.
 
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 *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkNew< vtkIdListTempCell
 
- 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
 

Additional Inherited Members

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

Detailed Description

abstract object to represent cell connectivity

vtkAbstractCellArray is an abstract base class for storing a connectivity table listing the point ids that make up each cell.

See also
vtkCellArray vtkStructuredCellArray

Definition at line 28 of file vtkAbstractCellArray.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkAbstractCellArray.h.

Constructor & Destructor Documentation

◆ vtkAbstractCellArray()

vtkAbstractCellArray::vtkAbstractCellArray ( )
protected

◆ ~vtkAbstractCellArray()

vtkAbstractCellArray::~vtkAbstractCellArray ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkCellArray, and vtkStructuredCellArray.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractCellArray::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkCellArray, and vtkStructuredCellArray.

◆ NewInstance()

vtkAbstractCellArray * vtkAbstractCellArray::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractCellArray::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 vtkObjectBase.

Reimplemented in vtkCellArray, and vtkStructuredCellArray.

◆ Initialize()

virtual void vtkAbstractCellArray::Initialize ( )
pure virtual

Free any memory and reset to an empty state.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ GetNumberOfCells()

virtual vtkIdType vtkAbstractCellArray::GetNumberOfCells ( ) const
pure virtual

Get the number of cells in the array.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ GetNumberOfOffsets()

virtual vtkIdType vtkAbstractCellArray::GetNumberOfOffsets ( ) const
pure virtual

Get the number of elements in the offsets array.

This will be the number of cells + 1.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ GetOffset()

virtual vtkIdType vtkAbstractCellArray::GetOffset ( vtkIdType  cellId)
pure virtual

Get the offset (into the connectivity) for a specified cell id.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ GetNumberOfConnectivityIds()

virtual vtkIdType vtkAbstractCellArray::GetNumberOfConnectivityIds ( ) const
pure virtual

Get the size of the connectivity array that stores the point ids.

Note
Do not confuse this with the deprecated GetNumberOfConnectivityEntries(), which refers to the legacy memory layout.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ IsStorageShareable()

virtual bool vtkAbstractCellArray::IsStorageShareable ( ) const
pure virtual
Returns
True if the internal storage can be shared as a pointer to vtkIdType, i.e., the type and organization of internal storage is such that copying of data can be avoided, and instead a pointer to vtkIdType can be used.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ IsHomogeneous()

virtual vtkIdType vtkAbstractCellArray::IsHomogeneous ( )
pure virtual

Check if all cells have the same number of vertices.

The return value is coded as:

  • -1 = heterogeneous
  • 0 = Cell array empty
  • n (positive integer) = homogeneous array of cell size n

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ GetCellAtId() [1/4]

void vtkAbstractCellArray::GetCellAtId ( vtkIdType  cellId,
vtkIdType cellSize,
vtkIdType const *&  cellPoints 
)

Return the point ids for the cell at cellId.

Warning
Subsequent calls to this method may invalidate previous call results if the internal storage type is not the same as vtkIdType and cannot be shared through the cellPoints pointer. In other words, the method may not be thread safe. Check if shareable (using IsStorageShareable()), or use a vtkCellArrayIterator to guarantee thread safety.

◆ GetCellAtId() [2/4]

virtual void vtkAbstractCellArray::GetCellAtId ( vtkIdType  cellId,
vtkIdType cellSize,
vtkIdType const *&  cellPoints,
vtkIdList ptIds 
)
pure virtual

Return the point ids for the cell at cellId.

Subsequent calls to this method may invalidate previous call results if the internal storage type is not the same as vtkIdType and cannot be shared through the cellPoints pointer. If that occurs, the method will use ptIds, which is an object that is created by each thread, to guarantee thread safety.

Implemented in vtkCellArray, vtkStructuredCellArray, and vtkCellArray.

◆ GetCellAtId() [3/4]

virtual void vtkAbstractCellArray::GetCellAtId ( vtkIdType  cellId,
vtkIdList pts 
)
pure virtual

Return the point ids for the cell at cellId.

This always copies the cell ids (i.e., the list of points pts into the supplied vtkIdList). This method is thread safe.

Implemented in vtkStructuredCellArray, vtkCellArray, and vtkCellArray.

◆ GetCellAtId() [4/4]

virtual void vtkAbstractCellArray::GetCellAtId ( vtkIdType  cellId,
vtkIdType cellSize,
vtkIdType cellPoints 
)
pure virtual

Return the point ids for the cell at cellId.

This always copies the cell ids into cellSize and cellPoints. This method is thread safe.

Note: the cellPoints need to have the correct size already allocated otherwise memory issues can occur.

Implemented in vtkCellArray, vtkStructuredCellArray, and vtkCellArray.

◆ GetCellSize()

virtual vtkIdType vtkAbstractCellArray::GetCellSize ( vtkIdType  cellId) const
pure virtual

Return the size of the cell at cellId.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ GetMaxCellSize()

virtual int vtkAbstractCellArray::GetMaxCellSize ( )
pure virtual

Returns the size of the largest cell.

The size is the number of points defining the cell.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ DeepCopy()

virtual void vtkAbstractCellArray::DeepCopy ( vtkAbstractCellArray ca)
pure virtual

Perform a deep copy (no reference counting) of the given cell array.

Implemented in vtkCellArray, and vtkStructuredCellArray.

◆ ShallowCopy()

virtual void vtkAbstractCellArray::ShallowCopy ( vtkAbstractCellArray ca)
pure virtual

Shallow copy ca into this cell array.

Implemented in vtkCellArray, and vtkStructuredCellArray.

Member Data Documentation

◆ TempCell

vtkNew<vtkIdList> vtkAbstractCellArray::TempCell
protected

Definition at line 150 of file vtkAbstractCellArray.h.


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