VTK
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkStaticCellLinks Class Reference

object represents upward pointers from points to list of cells using each point More...

#include <vtkStaticCellLinks.h>

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

Public Member Functions

void BuildLinks (vtkDataSet *ds) override
 Build the link list array. More...
 
vtkIdType GetNumberOfCells (vtkIdType ptId)
 Get the number of cells using the point specified by ptId. More...
 
vtkIdType GetNcells (vtkIdType ptId)
 Get the number of cells using the point specified by ptId. More...
 
vtkIdTypeGetCells (vtkIdType ptId)
 Return a list of cell ids using the specified point. More...
 
void Initialize () override
 Make sure any previously created links are cleaned up. More...
 
void Squeeze () override
 Reclaim any unused memory. More...
 
void Reset () override
 Reset to a state of no entries without freeing the memory. More...
 
unsigned long GetActualMemorySize () override
 Return the memory in kibibytes (1024 bytes) consumed by this cell links array. More...
 
void DeepCopy (vtkAbstractCellLinks *src) override
 Standard DeepCopy method. 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...
 

Protected Member Functions

 vtkStaticCellLinks ()
 
 ~vtkStaticCellLinks () 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 &)
 

Protected Attributes

vtkStaticCellLinksTemplate< vtkIdType > * Impl
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkAbstractCellLinks Superclass
 Standard methods for instantiation, type manipulation and printing. More...
 
static vtkStaticCellLinksNew ()
 Standard methods for instantiation, type manipulation and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, type manipulation and printing. More...
 
static vtkStaticCellLinksSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, type manipulation and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, type manipulation and printing. More...
 
vtkStaticCellLinksNewInstance () const
 Standard methods for instantiation, type manipulation and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, type manipulation and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, type manipulation and printing. More...
 

Additional Inherited Members

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

Detailed Description

object represents upward pointers from points to list of cells using each point

vtkStaticCellLinks is a supplemental object to vtkCellArray and vtkCellTypes, enabling access from points to the cells using the points. vtkStaticCellLinks is an array of links, each link represents a list of cell ids using a particular point. The information provided by this object can be used to determine cell neighbors and construct other local topological information. This class is a faster implementation of vtkCellLinks. However, it cannot be incrementally constructed; it is meant to be constructed once (statically) and must be rebuilt if the cells change.

Warning
This is a drop-in replacement for vtkCellLinks using static link construction. It uses the templated vtkStaticCellLinksTemplate class, instantiating vtkStaticCellLinksTemplate with a vtkIdType template parameter. Note that for best performance, the vtkStaticCellLinksTemplate class may be used directly, instantiating it with the appropriate id type. This class is also wrappable and can be used from an interpreted language such as Python.
See also
vtkCellLinks vtkStaticCellLinksTemplate
Tests:
vtkStaticCellLinks (Tests)

Definition at line 57 of file vtkStaticCellLinks.h.

Member Typedef Documentation

Standard methods for instantiation, type manipulation and printing.

Definition at line 65 of file vtkStaticCellLinks.h.

Constructor & Destructor Documentation

vtkStaticCellLinks::vtkStaticCellLinks ( )
protected
vtkStaticCellLinks::~vtkStaticCellLinks ( )
overrideprotected

Member Function Documentation

static vtkStaticCellLinks* vtkStaticCellLinks::New ( )
static

Standard methods for instantiation, type manipulation and printing.

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

Standard methods for instantiation, type manipulation and printing.

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

Standard methods for instantiation, type manipulation and printing.

Reimplemented from vtkAbstractCellLinks.

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

Standard methods for instantiation, type manipulation and printing.

virtual vtkObjectBase* vtkStaticCellLinks::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, type manipulation and printing.

Reimplemented from vtkAbstractCellLinks.

vtkStaticCellLinks* vtkStaticCellLinks::NewInstance ( ) const

Standard methods for instantiation, type manipulation and printing.

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

Standard methods for instantiation, type manipulation and printing.

Reimplemented from vtkAbstractCellLinks.

void vtkStaticCellLinks::BuildLinks ( vtkDataSet ds)
inlineoverridevirtual

Build the link list array.

Satisfy the superclass API.

Implements vtkAbstractCellLinks.

Definition at line 72 of file vtkStaticCellLinks.h.

vtkIdType vtkStaticCellLinks::GetNumberOfCells ( vtkIdType  ptId)
inline

Get the number of cells using the point specified by ptId.

Definition at line 81 of file vtkStaticCellLinks.h.

vtkIdType vtkStaticCellLinks::GetNcells ( vtkIdType  ptId)
inline

Get the number of cells using the point specified by ptId.

This is an alias for GetNumberOfCells(); consistent with the vtkCellLinks API.

Definition at line 88 of file vtkStaticCellLinks.h.

vtkIdType* vtkStaticCellLinks::GetCells ( vtkIdType  ptId)
inline

Return a list of cell ids using the specified point.

Definition at line 94 of file vtkStaticCellLinks.h.

void vtkStaticCellLinks::Initialize ( )
inlineoverridevirtual

Make sure any previously created links are cleaned up.

Implements vtkAbstractCellLinks.

Definition at line 100 of file vtkStaticCellLinks.h.

void vtkStaticCellLinks::Squeeze ( )
inlineoverridevirtual

Reclaim any unused memory.

Implements vtkAbstractCellLinks.

Definition at line 105 of file vtkStaticCellLinks.h.

void vtkStaticCellLinks::Reset ( )
inlineoverridevirtual

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

Implements vtkAbstractCellLinks.

Definition at line 110 of file vtkStaticCellLinks.h.

unsigned long vtkStaticCellLinks::GetActualMemorySize ( )
inlineoverridevirtual

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.

Implements vtkAbstractCellLinks.

Definition at line 120 of file vtkStaticCellLinks.h.

void vtkStaticCellLinks::DeepCopy ( vtkAbstractCellLinks src)
inlineoverridevirtual

Standard DeepCopy method.

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

Implements vtkAbstractCellLinks.

Definition at line 127 of file vtkStaticCellLinks.h.

Member Data Documentation

vtkStaticCellLinksTemplate<vtkIdType>* vtkStaticCellLinks::Impl
protected

Definition at line 134 of file vtkStaticCellLinks.h.


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