VTK  9.1.0
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

virtual void BuildLinks (vtkDataSet *data)=0
 Build the link list array.
 
virtual void Initialize ()=0
 Release memory and revert to empty state.
 
virtual void Squeeze ()=0
 Reclaim any unused memory.
 
virtual void Reset ()=0
 Reset to a state of no entries without freeing the memory.
 
virtual unsigned long GetActualMemorySize ()=0
 Return the memory in kibibytes (1024 bytes) consumed by this cell links array.
 
virtual void DeepCopy (vtkAbstractCellLinks *src)=0
 Standard DeepCopy method.
 
int GetType ()
 Return the type of locator (see enum above).
 
virtual void SelectCells (vtkIdType minMaxDegree[2], unsigned char *cellSelection)=0
 These methods are not virtual due to performance concerns.
 
virtual void SetSequentialProcessing (bool)
 Force sequential processing (i.e.
 
virtual bool GetSequentialProcessing ()
 Force sequential processing (i.e.
 
virtual void SequentialProcessingOn ()
 Force sequential processing (i.e.
 
virtual void SequentialProcessingOff ()
 Force sequential processing (i.e.
 
- 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)
 
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.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
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.
 
virtual 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.
 

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.
 
- 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 (int 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 int 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

 vtkAbstractCellLinks ()
 
 ~vtkAbstractCellLinks () 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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool SequentialProcessing
 
int Type
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkObject Superclass
 Standard type and print methods.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard type and print methods.
 
static vtkAbstractCellLinksSafeDownCast (vtkObjectBase *o)
 Standard type and print methods.
 
virtual vtkTypeBool IsA (const char *type)
 Standard type and print methods.
 
vtkAbstractCellLinksNewInstance () const
 Standard type and print methods.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard type and print methods.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard type and print methods.
 

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 41 of file vtkAbstractCellLinks.h.

Member Typedef Documentation

◆ Superclass

Standard type and print methods.

Definition at line 48 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 90 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 vtkCellLinks, and vtkStaticCellLinks.

◆ 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 vtkCellLinks, and vtkStaticCellLinks.

◆ 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 vtkCellLinks, and vtkStaticCellLinks.

◆ BuildLinks()

virtual void vtkAbstractCellLinks::BuildLinks ( vtkDataSet data)
pure virtual

Build the link list array.

All subclasses must implement this method.

Implemented in vtkCellLinks, and vtkStaticCellLinks.

◆ Initialize()

virtual void vtkAbstractCellLinks::Initialize ( )
pure virtual

Release memory and revert to empty state.

Implemented in vtkCellLinks, and vtkStaticCellLinks.

◆ Squeeze()

virtual void vtkAbstractCellLinks::Squeeze ( )
pure virtual

Reclaim any unused memory.

Implemented in vtkCellLinks, and vtkStaticCellLinks.

◆ Reset()

virtual void vtkAbstractCellLinks::Reset ( )
pure virtual

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

Implemented in vtkCellLinks, and vtkStaticCellLinks.

◆ 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 vtkCellLinks, and vtkStaticCellLinks.

◆ 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 vtkCellLinks, and vtkStaticCellLinks.

◆ ComputeType()

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.

◆ GetType()

int vtkAbstractCellLinks::GetType ( )
inline

Return the type of locator (see enum above).

Definition at line 116 of file vtkAbstractCellLinks.h.

◆ 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 vtkCellLinks, and vtkStaticCellLinks.

◆ 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.

Member Data Documentation

◆ SequentialProcessing

bool vtkAbstractCellLinks::SequentialProcessing
protected

Definition at line 160 of file vtkAbstractCellLinks.h.

◆ Type

int vtkAbstractCellLinks::Type
protected

Definition at line 161 of file vtkAbstractCellLinks.h.


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