VTK
Classes | 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 Member Functions

virtual void BuildLinks (vtkDataSet *data)
 
void BuildLinks (vtkDataSet *data, vtkCellArray *Connectivity)
 
void Allocate (vtkIdType numLinks, vtkIdType ext=1000)
 
void Initialize ()
 
LinkGetLink (vtkIdType ptId)
 
unsigned short GetNcells (vtkIdType ptId)
 
vtkIdTypeGetCells (vtkIdType ptId)
 
vtkIdType InsertNextPoint (int numLinks)
 
void InsertNextCellReference (vtkIdType ptId, vtkIdType cellId)
 
void DeletePoint (vtkIdType ptId)
 
void RemoveCellReference (vtkIdType cellId, vtkIdType ptId)
 
void AddCellReference (vtkIdType cellId, vtkIdType ptId)
 
void ResizeCellList (vtkIdType ptId, int size)
 
void Squeeze ()
 
void Reset ()
 
unsigned long GetActualMemorySize ()
 
void DeepCopy (vtkCellLinks *src)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Protected Member Functions

 vtkCellLinks ()
 
virtual ~vtkCellLinks ()
 
void IncrementLinkCount (vtkIdType ptId)
 
void AllocateLinks (vtkIdType n)
 
LinkResize (vtkIdType sz)
 
void InsertCellReference (vtkIdType ptId, unsigned short pos, vtkIdType cellId)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkAbstractCellLinks Superclass
 
static vtkCellLinksNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCellLinksSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkCellLinksNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBaseNewInstanceInternal () const
 

Additional Inherited Members

- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

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
Note that this class is designed to support incremental link construction. More efficient cell links structures can be built with vtkStaticCellLinks (and vtkStaticCellLinksTemplate). However these other classes are typically meant for one-time (static) construction.
See also
vtkCellArray vtkCellTypes vtkStaticCellLinks vtkStaticCellLinksTemplate

Definition at line 43 of file vtkCellLinks.h.

Member Typedef Documentation

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

Definition at line 58 of file vtkCellLinks.h.

Constructor & Destructor Documentation

vtkCellLinks::vtkCellLinks ( )
inlineprotected

Definition at line 130 of file vtkCellLinks.h.

virtual vtkCellLinks::~vtkCellLinks ( )
protectedvirtual

Member Function Documentation

static vtkCellLinks* vtkCellLinks::New ( )
static

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

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

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

virtual int vtkCellLinks::IsA ( const char *  type)
virtual

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

Reimplemented from vtkAbstractCellLinks.

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

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

virtual vtkObjectBase* vtkCellLinks::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkAbstractCellLinks.

vtkCellLinks* vtkCellLinks::NewInstance ( ) const

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

void vtkCellLinks::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

Reimplemented from vtkAbstractCellLinks.

virtual void vtkCellLinks::BuildLinks ( vtkDataSet data)
virtual

Build the link list array. All subclasses of vtkAbstractCellLinks must support this method.

Implements vtkAbstractCellLinks.

void vtkCellLinks::BuildLinks ( vtkDataSet data,
vtkCellArray Connectivity 
)

Build the link list array with a provided connectivity array.

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

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

void vtkCellLinks::Initialize ( )

Clear out any previously allocated data structures

Link& vtkCellLinks::GetLink ( vtkIdType  ptId)
inline

Get a link structure given a point id.

Definition at line 77 of file vtkCellLinks.h.

unsigned short vtkCellLinks::GetNcells ( vtkIdType  ptId)
inline

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

Definition at line 80 of file vtkCellLinks.h.

vtkIdType* vtkCellLinks::GetCells ( vtkIdType  ptId)
inline

Return a list of cell ids using the point.

Definition at line 83 of file vtkCellLinks.h.

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.

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 172 of file vtkCellLinks.h.

void vtkCellLinks::DeletePoint ( vtkIdType  ptId)
inline

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

Definition at line 164 of file vtkCellLinks.h.

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 179 of file vtkCellLinks.h.

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 199 of file vtkCellLinks.h.

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 205 of file vtkCellLinks.h.

void vtkCellLinks::Squeeze ( )

Reclaim any unused memory.

void vtkCellLinks::Reset ( )

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

unsigned long vtkCellLinks::GetActualMemorySize ( )

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.

void vtkCellLinks::DeepCopy ( vtkCellLinks src)

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

void vtkCellLinks::IncrementLinkCount ( vtkIdType  ptId)
inlineprotected

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

Definition at line 134 of file vtkCellLinks.h.

void vtkCellLinks::AllocateLinks ( vtkIdType  n)
protected
void vtkCellLinks::InsertCellReference ( vtkIdType  ptId,
unsigned short  pos,
vtkIdType  cellId 
)
inlineprotected

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

Definition at line 156 of file vtkCellLinks.h.

Link* vtkCellLinks::Resize ( vtkIdType  sz)
protected

Member Data Documentation

Link* vtkCellLinks::Array
protected

Definition at line 144 of file vtkCellLinks.h.

vtkIdType vtkCellLinks::Size
protected

Definition at line 145 of file vtkCellLinks.h.

vtkIdType vtkCellLinks::MaxId
protected

Definition at line 146 of file vtkCellLinks.h.

vtkIdType vtkCellLinks::Extend
protected

Definition at line 147 of file vtkCellLinks.h.


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