VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCellLinks Class Reference

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

#include <vtkCellLinks.h>

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

Classes

class  Link
 

Public Types

typedef vtkAbstractCellLinks Superclass
 

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...
 
vtkCellLinksNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void BuildLinks (vtkDataSet *data) override
 Build the link list array. More...
 
void Allocate (vtkIdType numLinks, vtkIdType ext=1000)
 Allocate the specified number of links (i.e., number of points) that will be built. More...
 
void Initialize () override
 Clear out any previously allocated data structures. More...
 
LinkGetLink (vtkIdType ptId)
 Get a link structure given a point id. 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 point. More...
 
vtkIdType InsertNextPoint (int numLinks)
 Insert a new point into the cell-links data structure. More...
 
void InsertNextCellReference (vtkIdType ptId, vtkIdType cellId)
 Insert a cell id into the list of cells (at the end) using the cell id provided. More...
 
void DeletePoint (vtkIdType ptId)
 Delete point (and storage) by destroying links to using cells. More...
 
void RemoveCellReference (vtkIdType cellId, vtkIdType ptId)
 Delete the reference to the cell (cellId) from the point (ptId). More...
 
void AddCellReference (vtkIdType cellId, vtkIdType ptId)
 Add the reference to the cell (cellId) from the point (ptId). More...
 
void ResizeCellList (vtkIdType ptId, int size)
 Change the length of a point's link list (i.e., list of cells using a point) by the size specified. 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...
 
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 vtkCellLinksNew ()
 Standard methods to instantiate, print, and obtain type information. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellLinksSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkCellLinks ()
 
 ~vtkCellLinks () override
 
void IncrementLinkCount (vtkIdType ptId)
 Increment the count of the number of cells using the point. More...
 
void AllocateLinks (vtkIdType n)
 
void InsertCellReference (vtkIdType ptId, vtkIdType pos, vtkIdType cellId)
 Insert a cell id into the list of cells using the point. More...
 
LinkResize (vtkIdType sz)
 
- 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

LinkArray
 
vtkIdType Size
 
vtkIdType MaxId
 
vtkIdType Extend
 
- 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

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

vtkCellLinks is a supplemental object to vtkCellArray and vtkCellTypes, enabling access from points to the cells using the points. vtkCellLinks is a list of cell ids, each such link representing a dynamic list of cell ids using the point. The information provided by this object can be used to determine neighbors and construct other local topological information.

Warning
vtkCellLinks supports incremental (i.e., "editable") operations such as inserting a new cell, or deleting a point. Because of this, it is less memory efficient, and slower to construct and delete than static classes such as vtkStaticCellLinks or vtkStaticCellLinksTemplate. However these other classes are typically meant for one-time (static) construction.
See also
vtkCellArray vtkCellTypes vtkStaticCellLinks vtkStaticCellLinksTemplate

Definition at line 45 of file vtkCellLinks.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkCellLinks.h.

Constructor & Destructor Documentation

◆ vtkCellLinks()

vtkCellLinks::vtkCellLinks ( )
inlineprotected

Definition at line 161 of file vtkCellLinks.h.

◆ ~vtkCellLinks()

vtkCellLinks::~vtkCellLinks ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCellLinks* vtkCellLinks::New ( )
static

Standard methods to instantiate, print, and obtain type information.

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCellLinks::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractCellLinks.

◆ NewInstance()

vtkCellLinks* vtkCellLinks::NewInstance ( ) const

◆ PrintSelf()

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

◆ BuildLinks()

void vtkCellLinks::BuildLinks ( vtkDataSet data)
overridevirtual

Build the link list array.

All subclasses of vtkAbstractCellLinks must support this method.

Implements vtkAbstractCellLinks.

◆ Allocate()

void vtkCellLinks::Allocate ( vtkIdType  numLinks,
vtkIdType  ext = 1000 
)

Allocate the specified number of links (i.e., number of points) that will be built.

◆ Initialize()

void vtkCellLinks::Initialize ( )
overridevirtual

Clear out any previously allocated data structures.

Implements vtkAbstractCellLinks.

◆ GetLink()

Link& vtkCellLinks::GetLink ( vtkIdType  ptId)
inline

Get a link structure given a point id.

Definition at line 84 of file vtkCellLinks.h.

◆ GetNcells()

vtkIdType vtkCellLinks::GetNcells ( vtkIdType  ptId)
inline

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

Definition at line 89 of file vtkCellLinks.h.

◆ GetCells()

vtkIdType* vtkCellLinks::GetCells ( vtkIdType  ptId)
inline

Return a list of cell ids using the point.

Definition at line 94 of file vtkCellLinks.h.

◆ InsertNextPoint()

vtkIdType vtkCellLinks::InsertNextPoint ( int  numLinks)

Insert a new point into the cell-links data structure.

The size parameter is the initial size of the list.

◆ InsertNextCellReference()

void vtkCellLinks::InsertNextCellReference ( vtkIdType  ptId,
vtkIdType  cellId 
)
inline

Insert a cell id into the list of cells (at the end) using the cell id provided.

(Make sure to extend the link list (if necessary) using the method ResizeCellList().)

Definition at line 208 of file vtkCellLinks.h.

◆ DeletePoint()

void vtkCellLinks::DeletePoint ( vtkIdType  ptId)
inline

Delete point (and storage) by destroying links to using cells.

Definition at line 200 of file vtkCellLinks.h.

◆ RemoveCellReference()

void vtkCellLinks::RemoveCellReference ( vtkIdType  cellId,
vtkIdType  ptId 
)
inline

Delete the reference to the cell (cellId) from the point (ptId).

This removes the reference to the cellId from the cell list, but does not resize the list (recover memory with ResizeCellList(), if necessary).

Definition at line 214 of file vtkCellLinks.h.

◆ AddCellReference()

void vtkCellLinks::AddCellReference ( vtkIdType  cellId,
vtkIdType  ptId 
)
inline

Add the reference to the cell (cellId) from the point (ptId).

This adds a reference to the cellId from the cell list, but does not resize the list (extend memory with ResizeCellList(), if necessary).

Definition at line 234 of file vtkCellLinks.h.

◆ ResizeCellList()

void vtkCellLinks::ResizeCellList ( vtkIdType  ptId,
int  size 
)
inline

Change the length of a point's link list (i.e., list of cells using a point) by the size specified.

Definition at line 240 of file vtkCellLinks.h.

◆ Squeeze()

void vtkCellLinks::Squeeze ( )
overridevirtual

Reclaim any unused memory.

Implements vtkAbstractCellLinks.

◆ Reset()

void vtkCellLinks::Reset ( )
overridevirtual

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

Implements vtkAbstractCellLinks.

◆ GetActualMemorySize()

unsigned long vtkCellLinks::GetActualMemorySize ( )
overridevirtual

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.

◆ DeepCopy()

void vtkCellLinks::DeepCopy ( vtkAbstractCellLinks src)
overridevirtual

Standard DeepCopy method.

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

Implements vtkAbstractCellLinks.

◆ IncrementLinkCount()

void vtkCellLinks::IncrementLinkCount ( vtkIdType  ptId)
inlineprotected

Increment the count of the number of cells using the point.

Definition at line 173 of file vtkCellLinks.h.

◆ AllocateLinks()

void vtkCellLinks::AllocateLinks ( vtkIdType  n)
protected

◆ InsertCellReference()

void vtkCellLinks::InsertCellReference ( vtkIdType  ptId,
vtkIdType  pos,
vtkIdType  cellId 
)
inlineprotected

Insert a cell id into the list of cells using the point.

Definition at line 194 of file vtkCellLinks.h.

◆ Resize()

Link* vtkCellLinks::Resize ( vtkIdType  sz)
protected

Member Data Documentation

◆ Array

Link* vtkCellLinks::Array
protected

Definition at line 182 of file vtkCellLinks.h.

◆ Size

vtkIdType vtkCellLinks::Size
protected

Definition at line 183 of file vtkCellLinks.h.

◆ MaxId

vtkIdType vtkCellLinks::MaxId
protected

Definition at line 184 of file vtkCellLinks.h.

◆ Extend

vtkIdType vtkCellLinks::Extend
protected

Definition at line 185 of file vtkCellLinks.h.


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