VTK  9.2.20230129
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractCellLinks Class Referenceabstract

an abstract base class for classes that build topological links from points to cells More...

#include <vtkAbstractCellLinks.h>

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

Public Types

enum  CellLinksTypes {
  LINKS_NOT_DEFINED = 0 , CELL_LINKS = 1 , STATIC_CELL_LINKS_USHORT = 2 , STATIC_CELL_LINKS_UINT = 3 ,
  STATIC_CELL_LINKS_IDTYPE = 4 , STATIC_CELL_LINKS_SPECIALIZED = 5
}
 

Public Member Functions

void BuildLinks (vtkDataSet *data)
 Set the input dataset and build the link list array. More...
 
virtual void BuildLinks ()=0
 Build the link list array from the input dataset. More...
 
virtual void Initialize ()=0
 Release memory and revert to empty state. More...
 
virtual void Squeeze ()=0
 Reclaim any unused memory. More...
 
virtual void Reset ()=0
 Reset to a state of no entries without freeing the memory. More...
 
virtual unsigned long GetActualMemorySize ()=0
 Return the memory in kibibytes (1024 bytes) consumed by this cell links array. More...
 
virtual void DeepCopy (vtkAbstractCellLinks *src)=0
 Standard DeepCopy method. More...
 
virtual int GetType ()
 Return the type of locator (see enum above). More...
 
virtual void SetDataSet (vtkDataSet *)
 Set/Get the points/cells defining this dataset. More...
 
virtual vtkDataSetGetDataSet ()
 Set/Get the points/cells defining this dataset. More...
 
virtual void SelectCells (vtkIdType minMaxDegree[2], unsigned char *cellSelection)=0
 These methods are not virtual due to performance concerns. More...
 
virtual void SetSequentialProcessing (bool)
 Force sequential processing (i.e. More...
 
virtual bool GetSequentialProcessing ()
 Force sequential processing (i.e. More...
 
virtual void SequentialProcessingOn ()
 Force sequential processing (i.e. More...
 
virtual void SequentialProcessingOff ()
 Force sequential processing (i.e. More...
 
virtual vtkMTimeType GetBuildTime ()
 Return the time of the last data structure build. More...
 
bool UsesGarbageCollector () const override
 Handle the dataset <-> Links loop. 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)
 
int InvokeEvent (unsigned long event)
 
int 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...
 
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...
 
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...
 
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...
 

Static Public Member Functions

static int ComputeType (vtkIdType maxPtId, vtkIdType maxCellId, vtkCellArray *ca)
 Based on the input (i.e., number of points, number of cells, and length of connectivity array) this helper method returns the integral type to use when instantiating cell link-related classes in order to properly represent the data. More...
 
static int ComputeType (vtkIdType maxPtId, vtkIdType maxCellId, vtkIdType connectivitySize)
 
- 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...
 

Protected Member Functions

 vtkAbstractCellLinks ()
 
 ~vtkAbstractCellLinks () override
 
void ReportReferences (vtkGarbageCollector *) 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataSetDataSet
 
bool SequentialProcessing
 
int Type
 
vtkTimeStamp BuildTime
 
- 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
 
typedef vtkObject Superclass
 Standard type and print methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard type and print methods. More...
 
static vtkAbstractCellLinksSafeDownCast (vtkObjectBase *o)
 Standard type and print methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard type and print methods. More...
 
vtkAbstractCellLinksNewInstance () const
 Standard type and print methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type and print methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard type and print methods. More...
 

Additional Inherited Members

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

Detailed Description

an abstract base class for classes that build topological links from points to cells

vtkAbstractCellLinks is a family of supplemental objects to vtkCellArray and vtkCellTypes, enabling fast access from points to the cells using the points. vtkAbstractCellLinks is an array of links, each link representing a list of cell ids using a particular point. The information provided by this object can be used to determine neighbors and construct other local topological information.

See also
vtkCellLinks vtkStaticCellLinks vtkStaticCellLinksTemplate

Definition at line 43 of file vtkAbstractCellLinks.h.

Member Typedef Documentation

◆ Superclass

Standard type and print methods.

Definition at line 50 of file vtkAbstractCellLinks.h.

Member Enumeration Documentation

◆ CellLinksTypes

Enumerator
LINKS_NOT_DEFINED 
CELL_LINKS 
STATIC_CELL_LINKS_USHORT 
STATIC_CELL_LINKS_UINT 
STATIC_CELL_LINKS_IDTYPE 
STATIC_CELL_LINKS_SPECIALIZED 

Definition at line 106 of file vtkAbstractCellLinks.h.

Constructor & Destructor Documentation

◆ vtkAbstractCellLinks()

vtkAbstractCellLinks::vtkAbstractCellLinks ( )
protected

◆ ~vtkAbstractCellLinks()

vtkAbstractCellLinks::~vtkAbstractCellLinks ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

Standard type and print methods.

◆ IsA()

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

Standard type and print methods.

Reimplemented from vtkObjectBase.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

◆ SafeDownCast()

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

Standard type and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractCellLinks::NewInstanceInternal ( ) const
protectedvirtual

Standard type and print methods.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

◆ NewInstance()

vtkAbstractCellLinks* vtkAbstractCellLinks::NewInstance ( ) const

Standard type and print methods.

◆ PrintSelf()

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

Standard type and print methods.

Reimplemented from vtkObject.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

◆ SetDataSet()

virtual void vtkAbstractCellLinks::SetDataSet ( vtkDataSet )
virtual

Set/Get the points/cells defining this dataset.

◆ GetDataSet()

virtual vtkDataSet* vtkAbstractCellLinks::GetDataSet ( )
virtual

Set/Get the points/cells defining this dataset.

◆ BuildLinks() [1/2]

void vtkAbstractCellLinks::BuildLinks ( vtkDataSet data)

Set the input dataset and build the link list array.

◆ BuildLinks() [2/2]

virtual void vtkAbstractCellLinks::BuildLinks ( )
pure virtual

Build the link list array from the input dataset.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ Initialize()

virtual void vtkAbstractCellLinks::Initialize ( )
pure virtual

Release memory and revert to empty state.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ Squeeze()

virtual void vtkAbstractCellLinks::Squeeze ( )
pure virtual

Reclaim any unused memory.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ Reset()

virtual void vtkAbstractCellLinks::Reset ( )
pure virtual

Reset to a state of no entries without freeing the memory.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ GetActualMemorySize()

virtual unsigned long vtkAbstractCellLinks::GetActualMemorySize ( )
pure virtual

Return the memory in kibibytes (1024 bytes) consumed by this cell links array.

Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ DeepCopy()

virtual void vtkAbstractCellLinks::DeepCopy ( vtkAbstractCellLinks src)
pure virtual

Standard DeepCopy method.

Since this object contains no reference to other objects, there is no ShallowCopy.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ ComputeType() [1/2]

static int vtkAbstractCellLinks::ComputeType ( vtkIdType  maxPtId,
vtkIdType  maxCellId,
vtkCellArray ca 
)
static

Based on the input (i.e., number of points, number of cells, and length of connectivity array) this helper method returns the integral type to use when instantiating cell link-related classes in order to properly represent the data.

The return value is one of the types defined in the enum CellLinksType enum defined previously. Subclasses may choose to instantiate themselves with different integral types for performance and/or memory reasons. This method is useful when instantiating a vtkStaticCellLinksTemplate; when instantiating a vtkCellLinks the class is hardwired for vtkIdType.

◆ ComputeType() [2/2]

static int vtkAbstractCellLinks::ComputeType ( vtkIdType  maxPtId,
vtkIdType  maxCellId,
vtkIdType  connectivitySize 
)
static

◆ GetType()

virtual int vtkAbstractCellLinks::GetType ( )
virtual

Return the type of locator (see enum above).

◆ SelectCells()

virtual void vtkAbstractCellLinks::SelectCells ( vtkIdType  minMaxDegree[2],
unsigned char *  cellSelection 
)
pure virtual

These methods are not virtual due to performance concerns.

However, subclasses of this class will implement them, using a combination of static_cast<> and templating used to invoke the methods in a way that the compiler can optimize.

Get the number of cells using the point specified by ptId: vtkIdType GetNcells(vtkIdType ptId)

Return a list of cell ids using the point. TIds *GetCells(vtkIdType ptId) Select all cells with a point degree in the range [minDegree,maxDegree). The degree is the number of cells using a point. The selection is indicated through the provided unsigned char array, with a non-zero value indicates selection. The memory allocated for cellSelection must be the maximum cell id referenced in the links.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

◆ SetSequentialProcessing()

virtual void vtkAbstractCellLinks::SetSequentialProcessing ( bool  )
virtual

Force sequential processing (i.e.

single thread) of the link building process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

◆ GetSequentialProcessing()

virtual bool vtkAbstractCellLinks::GetSequentialProcessing ( )
virtual

Force sequential processing (i.e.

single thread) of the link building process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

◆ SequentialProcessingOn()

virtual void vtkAbstractCellLinks::SequentialProcessingOn ( )
virtual

Force sequential processing (i.e.

single thread) of the link building process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

◆ SequentialProcessingOff()

virtual void vtkAbstractCellLinks::SequentialProcessingOff ( )
virtual

Force sequential processing (i.e.

single thread) of the link building process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

◆ GetBuildTime()

virtual vtkMTimeType vtkAbstractCellLinks::GetBuildTime ( )
virtual

Return the time of the last data structure build.

◆ UsesGarbageCollector()

bool vtkAbstractCellLinks::UsesGarbageCollector ( ) const
inlineoverridevirtual

Handle the dataset <-> Links loop.

Reimplemented from vtkObjectBase.

Definition at line 184 of file vtkAbstractCellLinks.h.

◆ ReportReferences()

void vtkAbstractCellLinks::ReportReferences ( vtkGarbageCollector )
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

◆ DataSet

vtkDataSet* vtkAbstractCellLinks::DataSet
protected

Definition at line 190 of file vtkAbstractCellLinks.h.

◆ SequentialProcessing

bool vtkAbstractCellLinks::SequentialProcessing
protected

Definition at line 191 of file vtkAbstractCellLinks.h.

◆ Type

int vtkAbstractCellLinks::Type
protected

Definition at line 192 of file vtkAbstractCellLinks.h.

◆ BuildTime

vtkTimeStamp vtkAbstractCellLinks::BuildTime
protected

Definition at line 194 of file vtkAbstractCellLinks.h.


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