ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkCellArray Class Reference

vtkCellArray - object to represent cell connectivity More...

Inheritance diagram for Kitware.VTK.vtkCellArray:
[legend]
Collaboration diagram for Kitware.VTK.vtkCellArray:
[legend]

List of all members.

Public Member Functions

 vtkCellArray (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCellArray ()
 Instantiate cell array (connectivity list).
int Allocate (int sz, int ext)
 Allocate memory and set the size to extend by.
void DeepCopy (vtkCellArray ca)
 Perform a deep copy (no reference counting) of the given cell array.
int EstimateSize (int numCells, int maxPtsPerCell)
 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.)
uint 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.
void GetCell (int loc, vtkIdList pts)
 Internal method used to retrieve a cell given an offset into the internal array.
vtkIdTypeArray GetData ()
 Return the underlying data as a data array.
int GetInsertLocation (int npts)
 Computes the current insertion location within the internal array. Used in conjunction with GetCell(int loc,...).
int GetMaxCellSize ()
 Returns the size of the largest cell. The size is the number of points defining the cell.
int GetNextCell (vtkIdList pts)
 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.
virtual int GetNumberOfCells ()
 Get the number of cells in the array.
int GetNumberOfConnectivityEntries ()
 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().)
IntPtr GetPointer ()
 Get pointer to array of cell data.
int GetSize ()
 Get the size of the allocated connectivity array.
int GetTraversalLocation ()
 Get/Set the current traversal location.
int GetTraversalLocation (int npts)
 Computes the current traversal location within the internal array. Used in conjunction with GetCell(int loc,...).
void InitTraversal ()
 A cell traversal methods that is more efficient than vtkDataSet traversal methods. InitTraversal() initializes the traversal of the list of cells.
void Initialize ()
 Free any memory and reset to an empty state.
void InsertCellPoint (int id)
int InsertNextCell (vtkCell cell)
int InsertNextCell (int npts, IntPtr pts)
int InsertNextCell (vtkIdList pts)
int InsertNextCell (int npts)
override int IsA (string type)
 Undocumented Block.
new vtkCellArray NewInstance ()
 Undocumented Block.
void ReplaceCell (int loc, int npts, IntPtr pts)
void Reset ()
void ReverseCell (int loc)
void SetCells (int ncells, vtkIdTypeArray 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.
virtual void SetNumberOfCells (int _arg)
 Set the number of cells in the array. DO NOT do any kind of allocation, advanced use only.
void SetTraversalLocation (int loc)
 Get/Set the current traversal location.
void Squeeze ()
 Reclaim any extra memory.
void UpdateCellCount (int npts)
IntPtr WritePointer (int ncells, int size)

Static Public Member Functions

static new vtkCellArray New ()
 Instantiate cell array (connectivity list).
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkCellArray SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCellArray"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "12vtkCellArray"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkCellArray_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCellArray_Allocate_01 (HandleRef pThis, int sz, int ext)
static internal void vtkCellArray_DeepCopy_02 (HandleRef pThis, HandleRef ca)
static internal int vtkCellArray_EstimateSize_03 (HandleRef pThis, int numCells, int maxPtsPerCell)
static internal uint vtkCellArray_GetActualMemorySize_04 (HandleRef pThis)
static internal void vtkCellArray_GetCell_05 (HandleRef pThis, int loc, HandleRef pts)
static internal IntPtr vtkCellArray_GetData_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCellArray_GetInsertLocation_07 (HandleRef pThis, int npts)
static internal int vtkCellArray_GetMaxCellSize_08 (HandleRef pThis)
static internal int vtkCellArray_GetNextCell_09 (HandleRef pThis, HandleRef pts)
static internal int vtkCellArray_GetNumberOfCells_10 (HandleRef pThis)
static internal int vtkCellArray_GetNumberOfConnectivityEntries_11 (HandleRef pThis)
static internal IntPtr vtkCellArray_GetPointer_12 (HandleRef pThis)
static internal int vtkCellArray_GetSize_13 (HandleRef pThis)
static internal int vtkCellArray_GetTraversalLocation_14 (HandleRef pThis)
static internal int vtkCellArray_GetTraversalLocation_15 (HandleRef pThis, int npts)
static internal void vtkCellArray_InitTraversal_16 (HandleRef pThis)
static internal void vtkCellArray_Initialize_17 (HandleRef pThis)
static internal void vtkCellArray_InsertCellPoint_18 (HandleRef pThis, int id)
static internal int vtkCellArray_InsertNextCell_19 (HandleRef pThis, HandleRef cell)
static internal int vtkCellArray_InsertNextCell_20 (HandleRef pThis, int npts, IntPtr pts)
static internal int vtkCellArray_InsertNextCell_21 (HandleRef pThis, HandleRef pts)
static internal int vtkCellArray_InsertNextCell_22 (HandleRef pThis, int npts)
static internal int vtkCellArray_IsA_23 (HandleRef pThis, string type)
static internal int vtkCellArray_IsTypeOf_24 (string type)
static internal IntPtr vtkCellArray_NewInstance_26 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCellArray_ReplaceCell_27 (HandleRef pThis, int loc, int npts, IntPtr pts)
static internal void vtkCellArray_Reset_28 (HandleRef pThis)
static internal void vtkCellArray_ReverseCell_29 (HandleRef pThis, int loc)
static internal IntPtr vtkCellArray_SafeDownCast_30 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCellArray_SetCells_31 (HandleRef pThis, int ncells, HandleRef cells)
static internal void vtkCellArray_SetNumberOfCells_32 (HandleRef pThis, int _arg)
static internal void vtkCellArray_SetTraversalLocation_33 (HandleRef pThis, int loc)
static internal void vtkCellArray_Squeeze_34 (HandleRef pThis)
static internal void vtkCellArray_UpdateCellCount_35 (HandleRef pThis, int npts)
static internal IntPtr vtkCellArray_WritePointer_36 (HandleRef pThis, int ncells, int size)

Static Private Member Functions

static vtkCellArray ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCellArray - object to represent cell connectivity

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

vtkCellTypes vtkCellLinks


Constructor & Destructor Documentation

static Kitware.VTK.vtkCellArray.vtkCellArray ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkCellArray.vtkCellArray ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Instantiate cell array (connectivity list).


Member Function Documentation

int Kitware.VTK.vtkCellArray.Allocate ( int  sz,
int  ext 
)

Allocate memory and set the size to extend by.

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

override void Kitware.VTK.vtkCellArray.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

int Kitware.VTK.vtkCellArray.EstimateSize ( int  numCells,
int  maxPtsPerCell 
)

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

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.

void Kitware.VTK.vtkCellArray.GetCell ( int  loc,
vtkIdList  pts 
)

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

Return the underlying data as a data array.

Here is the call graph for this function:

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

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

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.

virtual int Kitware.VTK.vtkCellArray.GetNumberOfCells ( ) [virtual]

Get the number of cells in the array.

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

Get pointer to array of cell data.

Get the size of the allocated connectivity array.

Get/Set the current traversal location.

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

Free any memory and reset to an empty state.

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

----------------------------------------------------------------------------

----------------------------------------------------------------------------

int Kitware.VTK.vtkCellArray.InsertNextCell ( int  npts,
IntPtr  pts 
)

----------------------------------------------------------------------------

----------------------------------------------------------------------------

----------------------------------------------------------------------------

override int Kitware.VTK.vtkCellArray.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkCellArray.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new vtkCellArray Kitware.VTK.vtkCellArray.New ( ) [static]

Instantiate cell array (connectivity list).

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

void Kitware.VTK.vtkCellArray.ReplaceCell ( int  loc,
int  npts,
IntPtr  pts 
)

----------------------------------------------------------------------------

----------------------------------------------------------------------------

----------------------------------------------------------------------------

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

void Kitware.VTK.vtkCellArray.SetCells ( int  ncells,
vtkIdTypeArray  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.

virtual void Kitware.VTK.vtkCellArray.SetNumberOfCells ( int  _arg) [virtual]

Set the number of cells in the array. DO NOT do any kind of allocation, advanced use only.

Get/Set the current traversal location.

Reclaim any extra memory.

----------------------------------------------------------------------------

static internal int Kitware.VTK.vtkCellArray.vtkCellArray_Allocate_01 ( HandleRef  pThis,
int  sz,
int  ext 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_DeepCopy_02 ( HandleRef  pThis,
HandleRef  ca 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_EstimateSize_03 ( HandleRef  pThis,
int  numCells,
int  maxPtsPerCell 
) [private]
static internal uint Kitware.VTK.vtkCellArray.vtkCellArray_GetActualMemorySize_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_GetCell_05 ( HandleRef  pThis,
int  loc,
HandleRef  pts 
) [private]
static internal IntPtr Kitware.VTK.vtkCellArray.vtkCellArray_GetData_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetInsertLocation_07 ( HandleRef  pThis,
int  npts 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetMaxCellSize_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetNextCell_09 ( HandleRef  pThis,
HandleRef  pts 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetNumberOfCells_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetNumberOfConnectivityEntries_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCellArray.vtkCellArray_GetPointer_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetSize_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetTraversalLocation_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_GetTraversalLocation_15 ( HandleRef  pThis,
int  npts 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_Initialize_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_InitTraversal_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_InsertCellPoint_18 ( HandleRef  pThis,
int  id 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_InsertNextCell_19 ( HandleRef  pThis,
HandleRef  cell 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_InsertNextCell_20 ( HandleRef  pThis,
int  npts,
IntPtr  pts 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_InsertNextCell_21 ( HandleRef  pThis,
HandleRef  pts 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_InsertNextCell_22 ( HandleRef  pThis,
int  npts 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_IsA_23 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCellArray.vtkCellArray_IsTypeOf_24 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCellArray.vtkCellArray_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCellArray.vtkCellArray_NewInstance_26 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_ReplaceCell_27 ( HandleRef  pThis,
int  loc,
int  npts,
IntPtr  pts 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_Reset_28 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_ReverseCell_29 ( HandleRef  pThis,
int  loc 
) [private]
static internal IntPtr Kitware.VTK.vtkCellArray.vtkCellArray_SafeDownCast_30 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_SetCells_31 ( HandleRef  pThis,
int  ncells,
HandleRef  cells 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_SetNumberOfCells_32 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_SetTraversalLocation_33 ( HandleRef  pThis,
int  loc 
) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_Squeeze_34 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellArray.vtkCellArray_UpdateCellCount_35 ( HandleRef  pThis,
int  npts 
) [private]
static internal IntPtr Kitware.VTK.vtkCellArray.vtkCellArray_WritePointer_36 ( HandleRef  pThis,
int  ncells,
int  size 
) [private]
IntPtr Kitware.VTK.vtkCellArray.WritePointer ( int  ncells,
int  size 
)

----------------------------------------------------------------------------


Member Data Documentation

new readonly string Kitware.VTK.vtkCellArray.MRClassNameKey = "12vtkCellArray" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkCellArray.MRFullTypeName = "Kitware.VTK.vtkCellArray"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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