vtkCellTypes Class Reference

#include <vtkCellTypes.h>

Inheritance diagram for vtkCellTypes:

Inheritance graph
Collaboration diagram for vtkCellTypes:

Collaboration graph

List of all members.

Detailed Description

object provides direct access to cells in vtkCellArray and type information

This class is a supplemental object to vtkCellArray to allow random access into cells as well as representing cell type information. The "location" field is the location in the vtkCellArray list in terms of an integer offset. An integer offset was used instead of a pointer for easy storage and inter-process communication. The type information is defined in the file vtkCellType.h.

Sometimes this class is used to pass type information independent of the random access (i.e., location) information. For example, see vtkDataSet::GetCellTypes(). If you use the class in this way, you can use a location value of -1.
See also:
vtkCellArray vtkCellLinks
vtkCellTypes (Examples)
vtkCellTypes (Tests)

Definition at line 50 of file vtkCellTypes.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int Allocate (int sz=512, int ext=1000)
void InsertCell (int id, unsigned char type, int loc)
int InsertNextCell (unsigned char type, int loc)
void SetCellTypes (int ncells, vtkUnsignedCharArray *cellTypes, vtkIntArray *cellLocations)
int GetCellLocation (int cellId)
void DeleteCell (vtkIdType cellId)
int GetNumberOfTypes ()
int IsType (unsigned char type)
int InsertNextType (unsigned char type)
unsigned char GetCellType (int cellId)
void Squeeze ()
void Reset ()
unsigned long GetActualMemorySize ()
void DeepCopy (vtkCellTypes *src)

Static Public Member Functions

static vtkCellTypesNew ()
static int IsTypeOf (const char *type)
static vtkCellTypesSafeDownCast (vtkObject *o)
static const char * GetClassNameFromTypeId (int typeId)
static int GetTypeIdFromClassName (const char *classname)
static int IsLinear (unsigned char type)

Protected Member Functions

 vtkCellTypes ()
 ~vtkCellTypes ()

Protected Attributes

int Size
int MaxId
int Extend

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 54 of file vtkCellTypes.h.

Constructor & Destructor Documentation

vtkCellTypes::vtkCellTypes (  )  [protected]

vtkCellTypes::~vtkCellTypes (  )  [protected]

Member Function Documentation

static vtkCellTypes* vtkCellTypes::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkCellTypes::IsTypeOf ( const char *  name  )  [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 vtkCellTypes::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 vtkObject.

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

Reimplemented from vtkObject.

void vtkCellTypes::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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

int vtkCellTypes::Allocate ( int  sz = 512,
int  ext = 1000 

Allocate memory for this array. Delete old storage only if necessary.

void vtkCellTypes::InsertCell ( int  id,
unsigned char  type,
int  loc 

Add a cell at specified id.

int vtkCellTypes::InsertNextCell ( unsigned char  type,
int  loc 

Add a cell to the object in the next available slot.

void vtkCellTypes::SetCellTypes ( int  ncells,
vtkUnsignedCharArray cellTypes,
vtkIntArray cellLocations 

Specify a group of cell types.

int vtkCellTypes::GetCellLocation ( int  cellId  )  [inline]

Return the location of the cell in the associated vtkCellArray.

Definition at line 70 of file vtkCellTypes.h.

void vtkCellTypes::DeleteCell ( vtkIdType  cellId  )  [inline]

Delete cell by setting to NULL cell type.

Definition at line 73 of file vtkCellTypes.h.

int vtkCellTypes::GetNumberOfTypes (  )  [inline]

Return the number of types in the list.

Definition at line 76 of file vtkCellTypes.h.

int vtkCellTypes::IsType ( unsigned char  type  )  [inline]

Return 1 if type specified is contained in list; 0 otherwise.

Definition at line 136 of file vtkCellTypes.h.

int vtkCellTypes::InsertNextType ( unsigned char  type  )  [inline]

Add the type specified to the end of the list. Range checking is performed.

Definition at line 83 of file vtkCellTypes.h.

unsigned char vtkCellTypes::GetCellType ( int  cellId  )  [inline]

Return the type of cell.

Definition at line 86 of file vtkCellTypes.h.

void vtkCellTypes::Squeeze (  ) 

Reclaim any extra memory.

void vtkCellTypes::Reset (  ) 

Initialize object without releasing memory.

unsigned long vtkCellTypes::GetActualMemorySize (  ) 

Return the memory in kilobytes consumed by this cell type 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 vtkCellTypes::DeepCopy ( vtkCellTypes src  ) 

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

static const char* vtkCellTypes::GetClassNameFromTypeId ( int  typeId  )  [static]

Given an int (as defined in vtkCellType.h) identifier for a class return it's classname.

static int vtkCellTypes::GetTypeIdFromClassName ( const char *  classname  )  [static]

Given a data object classname, return it's int identified (as defined in vtkCellType.h)

int vtkCellTypes::IsLinear ( unsigned char  type  )  [inline, static]

This convenience method is a fast check to determine if a cell type represents a linear or nonlinear cell. This is generally much more efficient than getting the appropriate vtkCell and checking its IsLinear method.

Definition at line 151 of file vtkCellTypes.h.

Member Data Documentation

Definition at line 124 of file vtkCellTypes.h.

Definition at line 125 of file vtkCellTypes.h.

int vtkCellTypes::Size [protected]

Definition at line 126 of file vtkCellTypes.h.

int vtkCellTypes::MaxId [protected]

Definition at line 127 of file vtkCellTypes.h.

int vtkCellTypes::Extend [protected]

Definition at line 128 of file vtkCellTypes.h.

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

Generated on Wed Aug 24 11:30:38 2011 for VTK by  doxygen 1.5.6