VTK
9.4.20250219
|
an abstract base class for classes that build topological links from points to cells More...
#include <vtkAbstractCellLinks.h>
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 ()=0 |
Build the link list array from the input dataset. | |
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. | |
virtual void | ShallowCopy (vtkAbstractCellLinks *src)=0 |
Standard ShallowCopy method. | |
virtual int | GetType () |
Return the type of locator (see enum above). | |
virtual void | SetDataSet (vtkDataSet *) |
Set/Get the points/cells defining this dataset. | |
virtual vtkDataSet * | GetDataSet () |
Set/Get the points/cells defining this dataset. | |
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. | |
virtual vtkMTimeType | GetBuildTime () |
Return the time of the last data structure build. | |
bool | UsesGarbageCollector () const override |
Handle the dataset <-> Links loop. | |
![]() | |
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. | |
vtkCommand * | GetCommand (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. | |
![]() | |
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. | |
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 int | ComputeType (vtkIdType maxPtId, vtkIdType maxCellId, vtkIdType connectivitySize) |
![]() | |
static vtkObject * | New () |
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 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 vtkObjectBase * | New () |
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 | |
void | ReportReferences (vtkGarbageCollector *) override |
![]() | |
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. | |
![]() | |
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 | |
vtkDataSet * | DataSet |
bool | SequentialProcessing |
int | Type |
vtkTimeStamp | BuildTime |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
![]() | |
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 vtkAbstractCellLinks * | SafeDownCast (vtkObjectBase *o) |
Standard type and print methods. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard type and print methods. | |
vtkAbstractCellLinks * | NewInstance () const |
Standard type and print methods. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard type and print methods. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard type and print methods. | |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 31 of file vtkAbstractCellLinks.h.
Standard type and print methods.
Definition at line 38 of file vtkAbstractCellLinks.h.
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 96 of file vtkAbstractCellLinks.h.
|
protected |
|
overrideprotected |
|
static |
Standard type and print methods.
|
virtual |
Standard type and print methods.
Reimplemented from vtkObjectBase.
Reimplemented in vtkCellLinks, and vtkStaticCellLinks.
|
static |
Standard type and print methods.
|
protectedvirtual |
Standard type and print methods.
Reimplemented in vtkCellLinks, and vtkStaticCellLinks.
vtkAbstractCellLinks * vtkAbstractCellLinks::NewInstance | ( | ) | const |
Standard type and print methods.
|
overridevirtual |
Standard type and print methods.
Reimplemented from vtkObjectBase.
Reimplemented in vtkCellLinks, and vtkStaticCellLinks.
|
virtual |
Set/Get the points/cells defining this dataset.
|
virtual |
Set/Get the points/cells defining this dataset.
|
pure virtual |
Build the link list array from the input dataset.
Implemented in vtkCellLinks, and vtkStaticCellLinks.
|
pure virtual |
Release memory and revert to empty state.
Implemented in vtkCellLinks, and vtkStaticCellLinks.
|
pure virtual |
Reclaim any unused memory.
Implemented in vtkCellLinks, and vtkStaticCellLinks.
|
pure virtual |
Reset to a state of no entries without freeing the memory.
Implemented in vtkCellLinks, and vtkStaticCellLinks.
|
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.
|
pure virtual |
Standard DeepCopy method.
Before you deep copy, make sure to call SetDataSet()
Implemented in vtkCellLinks, and vtkStaticCellLinks.
|
pure virtual |
Standard ShallowCopy method.
Before you shallow copy, make sure to call SetDataSet()
Implemented in vtkCellLinks, and vtkStaticCellLinks.
|
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.
|
static |
|
virtual |
Return the type of locator (see enum above).
|
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.
|
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.
|
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.
|
inlinevirtual |
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.
Definition at line 163 of file vtkAbstractCellLinks.h.
|
inlinevirtual |
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.
Definition at line 172 of file vtkAbstractCellLinks.h.
|
virtual |
Return the time of the last data structure build.
|
inlineoverridevirtual |
Handle the dataset <-> Links loop.
Reimplemented from vtkObjectBase.
Definition at line 193 of file vtkAbstractCellLinks.h.
|
overrideprotectedvirtual |
Reimplemented from vtkObjectBase.
|
protected |
Definition at line 199 of file vtkAbstractCellLinks.h.
|
protected |
Definition at line 201 of file vtkAbstractCellLinks.h.
|
protected |
Definition at line 202 of file vtkAbstractCellLinks.h.
|
protected |
Definition at line 204 of file vtkAbstractCellLinks.h.