Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkCellArray Class Reference

object to represent cell connectivity. More...

#include <vtkCellArray.h>

Inheritance diagram for vtkCellArray:

Inheritance graph
[legend]
Collaboration diagram for vtkCellArray:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
int Allocate (const int sz, const int ext=1000)
void Initialize ()
int GetNumberOfCells ()
int EstimateSize (int numCells, int maxPtsPerCell)
void InitTraversal ()
int GetNextCell (int &npts, int *&pts)
int GetSize ()
int GetNumberOfConnectivityEntries ()
void GetCell (int loc, int &npts, int *&pts)
int InsertNextCell (vtkCell *cell)
int InsertNextCell (int npts, int *pts)
int InsertNextCell (vtkIdList *pts)
int InsertNextCell (int npts)
void InsertCellPoint (int id)
void UpdateCellCount (int npts)
int GetInsertLocation (int npts)
int GetTraversalLocation ()
void SetTraversalLocation (int loc)
int GetTraversalLocation (int npts)
void ReverseCell (int loc)
void ReplaceCell (int loc, int npts, int *pts)
int GetMaxCellSize ()
int * GetPointer ()
int * WritePointer (const int ncells, const int size)
void SetCells (int ncells, vtkIntArray *cells)
void DeepCopy (vtkCellArray *ca)
vtkDataArray * GetData ()
void Reset ()
void Squeeze ()
unsigned long GetActualMemorySize ()
int InsertNextCell (vtkIdList &pts)

Static Public Methods

int IsTypeOf (const char *type)
vtkCellArray * SafeDownCast (vtkObject *o)
vtkCellArray * New ()

Protected Methods

 vtkCellArray ()
 vtkCellArray (const int sz, const int ext=1000)
 ~vtkCellArray ()
 vtkCellArray (const vtkCellArray &)
void operator= (const vtkCellArray &)

Protected Attributes

int NumberOfCells
int InsertLocation
int TraversalLocation
vtkIntArray * Ia

Detailed Description

object to represent cell connectivity.

Date:
2000/12/10 20:08:06
Revision:
1.76

vtkCellArray is a supporting object that explicitly represents cell connectivity. The cell array structure is a raw integer list of the form: (n,id1,id2,...,idn, n,id1,id2,...,idn, ...) where n is the number of points in the cell, and id is a zero-offset index into an associated point list.

Advantages of this data structure are its compactness, simplicity, and easy interface to external data. However, it is totally inadequate for random access. This functionality (when necessary) is accomplished by using the vtkCellTypes and vtkCellLinks objects to extend the definition of the data structure.

See also:
vtkCellTypes vtkCellLinks
Examples:
vtkCellArray (examples)

Definition at line 70 of file vtkCellArray.h.

Constructor & Destructor Documentation

vtkCellArray::vtkCellArray (    )  [protected]
 

vtkCellArray::vtkCellArray (  const int    sz,
const int    ext = 1000
)  [protected]
 

vtkCellArray::~vtkCellArray (    )  [protected]
 

vtkCellArray::vtkCellArray (  const vtkCellArray &    )  [inline, protected]
 

Definition at line 223 of file vtkCellArray.h.

Member Function Documentation

virtual const char* vtkCellArray::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

int vtkCellArray::IsTypeOf (  const char *    type )  [static]
 

Return 1 if this class type 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 vtkObject.

virtual int vtkCellArray::IsA (  const char *    type )  [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 vtkObject.

vtkCellArray* vtkCellArray::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

vtkCellArray* vtkCellArray::New (    )  [static]
 

Instantiate cell array (connectivity list).

Reimplemented from vtkObject.

int vtkCellArray::Allocate (  const int    sz,
const int    ext = 1000
)  [inline]
 

Allocate memory and set the size to extend by.

Definition at line 79 of file vtkCellArray.h.

void vtkCellArray::Initialize (    )  [inline]
 

Free any memory and reset to an empty state.

Definition at line 83 of file vtkCellArray.h.

int vtkCellArray::GetNumberOfCells (    )  [inline]
 

Get the number of cells in the array.

Definition at line 87 of file vtkCellArray.h.

int vtkCellArray::EstimateSize (  int    numCells,
int    maxPtsPerCell
)  [inline]
 

Utility routines help manage memory of cell array. EstimateSize() returns a value used to initialize and allocate memory for array based on number of cells and maximum number of points making up cell. If every cell is the same size (in terms of number of points), then the memory estimate is guaranteed exact. (If not exact, use Squeeze() to reclaim any extra memory.)

Definition at line 96 of file vtkCellArray.h.

void vtkCellArray::InitTraversal (    )  [inline]
 

A cell traversal methods that is more efficient than vtkDataSet traversal methods. InitTraversal() initializes the traversal of the list of cells.

Definition at line 102 of file vtkCellArray.h.

int vtkCellArray::GetNextCell (  int &    npts,
int *&    pts
)  [inline]
 

A cell traversal methods that is more efficient than vtkDataSet traversal methods. GetNextCell() gets the next cell in the list. If end of list is encountered, 0 is returned.

Definition at line 311 of file vtkCellArray.h.

int vtkCellArray::GetSize (    )  [inline]
 

Get the size of the allocated connectivity array.

Definition at line 110 of file vtkCellArray.h.

int vtkCellArray::GetNumberOfConnectivityEntries (    )  [inline]
 

Get the total number of entries (i.e., data values) in the connectivity array. This may be much less than the allocated size (i.e., return value from GetSize().)

Definition at line 116 of file vtkCellArray.h.

void vtkCellArray::GetCell (  int    loc,
int &    npts,
int *&    pts
)  [inline]
 

Internal method used to retrieve a cell given an offset into the internal array.

Definition at line 327 of file vtkCellArray.h.

int vtkCellArray::InsertNextCell (  vtkCell *    cell )  [inline]
 

Insert a cell object. Return the cell id of the cell.

Definition at line 284 of file vtkCellArray.h.

int vtkCellArray::InsertNextCell (  int    npts,
int *    pts
)  [inline]
 

Create a cell by specifying the number of points and an array of point id's. Return the cell id of the cell.

Definition at line 233 of file vtkCellArray.h.

int vtkCellArray::InsertNextCell (  vtkIdList *    pts )  [inline]
 

Create a cell by specifying a list of point ids. Return the cell id of the cell.

Definition at line 249 of file vtkCellArray.h.

int vtkCellArray::InsertNextCell (  int    npts )  [inline]
 

Create cells by specifying count, and then adding points one at a time using method InsertCellPoint(). If you don't know the count initially, use the method UpdateCellCount() to complete the cell. Return the cell id of the cell.

Definition at line 266 of file vtkCellArray.h.

void vtkCellArray::InsertCellPoint (  int    id )  [inline]
 

Used in conjunction with InsertNextCell(int npts) to add another point to the list of cells.

Definition at line 274 of file vtkCellArray.h.

void vtkCellArray::UpdateCellCount (  int    npts )  [inline]
 

Used in conjunction with InsertNextCell(int npts) and InsertCellPoint() to update the number of points defining the cell.

Definition at line 279 of file vtkCellArray.h.

int vtkCellArray::GetInsertLocation (  int    npts )  [inline]
 

Computes the current insertion location within the internal array. Used in conjunction with GetCell(int loc,...).

Definition at line 150 of file vtkCellArray.h.

int vtkCellArray::GetTraversalLocation (    )  [inline]
 

Get/Set the current traversal location.

Definition at line 153 of file vtkCellArray.h.

void vtkCellArray::SetTraversalLocation (  int    loc )  [inline]
 

Definition at line 155 of file vtkCellArray.h.

int vtkCellArray::GetTraversalLocation (  int    npts )  [inline]
 

Computes the current traversal location within the internal array. Used in conjunction with GetCell(int loc,...).

Definition at line 160 of file vtkCellArray.h.

void vtkCellArray::ReverseCell (  int    loc )  [inline]
 

Special method inverts ordering of current cell. Must be called carefully or the cell topology may be corrupted.

Definition at line 333 of file vtkCellArray.h.

void vtkCellArray::ReplaceCell (  int    loc,
int    npts,
int *    pts
)  [inline]
 

Replace the point ids of the cell with a different list of point ids.

Definition at line 346 of file vtkCellArray.h.

int vtkCellArray::GetMaxCellSize (    ) 
 

Returns the size of the largest cell. The size is the number of points defining the cell.

int* vtkCellArray::GetPointer (    )  [inline]
 

Get pointer to array of cell data.

Definition at line 175 of file vtkCellArray.h.

int * vtkCellArray::WritePointer (  const int    ncells,
const int    size
)  [inline]
 

Get pointer to data array for purpose of direct writes of data. Size is the total storage consumed by the cell array. ncells is the number of cells represented in the array.

Definition at line 355 of file vtkCellArray.h.

void vtkCellArray::SetCells (  int    ncells,
vtkIntArray *    cells
) 
 

Define multiple cells by providing a connectivity list. The list is in the form (npts,p0,p1,...p(npts-1), repeated for each cell). Be careful using this method because it discards the old cells, and anything referring these cells becomes invalid (for example, if BuildCells() has been called see vtkPolyData). The traversal location is reset to the beginning of the list; the insertion location is set to the end of the list.

void vtkCellArray::DeepCopy (  vtkCellArray *    ca ) 
 

Perform a deep copy (no reference counting) of the given cell array.

vtkDataArray* vtkCellArray::GetData (    )  [inline]
 

Return the underlying data as a data array.

Definition at line 196 of file vtkCellArray.h.

void vtkCellArray::Reset (    )  [inline]
 

Reuse list. Reset to initial condition.

Definition at line 302 of file vtkCellArray.h.

void vtkCellArray::Squeeze (    )  [inline]
 

Reclaim any extra memory.

Definition at line 203 of file vtkCellArray.h.

unsigned long vtkCellArray::GetActualMemorySize (    ) 
 

Return the memory in kilobytes consumed by this cell 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.

int vtkCellArray::InsertNextCell (  vtkIdList &    pts ) 
 

For legacy compatibility. Do not use.

void vtkCellArray::operator= (  const vtkCellArray &    )  [inline, protected]
 

Definition at line 224 of file vtkCellArray.h.

Member Data Documentation

int vtkCellArray::NumberOfCells [protected]
 

Definition at line 226 of file vtkCellArray.h.

int vtkCellArray::InsertLocation [protected]
 

Definition at line 227 of file vtkCellArray.h.

int vtkCellArray::TraversalLocation [protected]
 

Definition at line 228 of file vtkCellArray.h.

vtkIntArray* vtkCellArray::Ia [protected]
 

Definition at line 229 of file vtkCellArray.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:46:41 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001