VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | 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 Member Functions

virtual void BuildLinks (vtkDataSet *data)=0
 Build the link list array. 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)
 
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...
 
- 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 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...
 
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 GetIdType (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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

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

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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

Standard type and print methods.

Definition at line 49 of file vtkAbstractCellLinks.h.

Constructor & Destructor Documentation

vtkAbstractCellLinks::vtkAbstractCellLinks ( )
protected
vtkAbstractCellLinks::~vtkAbstractCellLinks ( )
overrideprotected

Member Function Documentation

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

Standard type and print methods.

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

Standard type and print methods.

Reimplemented from vtkObjectBase.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

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

Standard type and print methods.

virtual vtkObjectBase* vtkAbstractCellLinks::NewInstanceInternal ( ) const
protectedvirtual

Standard type and print methods.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

vtkAbstractCellLinks* vtkAbstractCellLinks::NewInstance ( ) const

Standard type and print methods.

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

Standard type and print methods.

Reimplemented from vtkObject.

Reimplemented in vtkStaticCellLinks, and vtkCellLinks.

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

Build the link list array.

All subclasses must implement this method.

Implemented in vtkStaticCellLinks, and vtkCellLinks.

static int vtkAbstractCellLinks::GetIdType ( 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 (VTK_ID_TYPE,VTK_INT,VTK_SHORT) defined in the file vtkType.h. Subclasses may choose to instantiate themselves with different integral types for performance and/or memory reasons.


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