VTK
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
}
 
typedef vtkObject Superclass
 Standard type and print methods. More...
 

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...
 
vtkAbstractCellLinksNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void BuildLinks (vtkDataSet *data)=0
 Build the link list array. 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...
 
int GetType ()
 Return the type of locator (see enum above). More...
 
virtual void SetSequentialProcessing (bool)
 These methods are not virtual due to performance concerns. More...
 
virtual bool GetSequentialProcessing ()
 
virtual void SequentialProcessingOn ()
 
virtual void SequentialProcessingOff ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractCellLinksSafeDownCast (vtkObjectBase *o)
 
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 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
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
 

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

Member Typedef Documentation

◆ Superclass

Standard type and print methods.

Definition at line 49 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 91 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

◆ IsA()

virtual vtkTypeBool vtkAbstractCellLinks::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 vtkStaticCellLinks, and vtkCellLinks.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractCellLinks::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

◆ NewInstance()

vtkAbstractCellLinks* vtkAbstractCellLinks::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractCellLinks::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 vtkObject.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

◆ BuildLinks()

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

Build the link list array.

All subclasses must implement this method.

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

◆ SetSequentialProcessing()

virtual void vtkAbstractCellLinks::SetSequentialProcessing ( bool  )
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) 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

◆ SequentialProcessingOn()

virtual void vtkAbstractCellLinks::SequentialProcessingOn ( )
virtual

◆ SequentialProcessingOff()

virtual void vtkAbstractCellLinks::SequentialProcessingOff ( )
virtual

Member Data Documentation

◆ SequentialProcessing

bool vtkAbstractCellLinks::SequentialProcessing
protected

Definition at line 151 of file vtkAbstractCellLinks.h.

◆ Type

int vtkAbstractCellLinks::Type
protected

Definition at line 152 of file vtkAbstractCellLinks.h.


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