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

vtkArray - Abstract interface for N-dimensional arrays. More...

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

List of all members.

Public Types

enum  DENSE_WrapperEnum { DENSE = 0, SPARSE = 1 }
 Undocumented Block. More...

Public Member Functions

 vtkArray (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkArray DeepCopy ()
 Returns a new array that is a deep copy of this array.
int GetDimensions ()
 Returns the number of dimensions stored in the array. Note that this is the same as calling GetExtents().GetDimensions().
virtual ulong GetNonNullSize ()
 Returns the number of non-null values stored in the array. Note that this value will equal GetSize() for dense arrays, and will be less-than-or-equal to GetSize() for sparse arrays.
ulong GetSize ()
 Returns the number of values stored in the array. Note that this is the same as calling GetExtents().GetSize(), and represents the maximum number of values that could ever be stored using the current extents. This is equal to the number of values stored in a dense array, but may be larger than the number of values stored in a sparse array.
override int IsA (string type)
 Undocumented Block.
virtual bool IsDense ()
 Returns true iff the underlying array storage is "dense", i.e. that GetSize() and GetNonNullSize() will always return the same value. If not, the array is "sparse".
new vtkArray NewInstance ()
 Undocumented Block.
void Resize (int i)
 Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
void Resize (int i, int j)
 Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
void Resize (int i, int j, int k)
 Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().

Static Public Member Functions

static vtkArray CreateArray (int StorageType, int ValueType)
 Creates a new array where StorageType is one of vtkArray::DENSE or vtkArray::SPARSE, and ValueType is one of VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_ID_TYPE, or VTK_STRING. The caller is responsible for the lifetime of the returned object.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkArray SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "8vtkArray"
 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 vtkArray_CreateArray_01 (int StorageType, int ValueType, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkArray_DeepCopy_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkArray_GetDimensions_03 (HandleRef pThis)
static internal ulong vtkArray_GetNonNullSize_04 (HandleRef pThis)
static internal ulong vtkArray_GetSize_05 (HandleRef pThis)
static internal int vtkArray_IsA_06 (HandleRef pThis, string type)
static internal byte vtkArray_IsDense_07 (HandleRef pThis)
static internal int vtkArray_IsTypeOf_08 (string type)
static internal IntPtr vtkArray_NewInstance_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkArray_Resize_10 (HandleRef pThis, int i)
static internal void vtkArray_Resize_11 (HandleRef pThis, int i, int j)
static internal void vtkArray_Resize_12 (HandleRef pThis, int i, int j, int k)
static internal IntPtr vtkArray_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)

Static Private Member Functions

static vtkArray ()
 Automatically generated type registration mechanics.

Detailed Description

vtkArray - Abstract interface for N-dimensional arrays.

Description vtkArray is the root of a hierarchy of arrays that can be used to store data with any number of dimensions. It provides an abstract interface for retrieving and setting array attributes that are independent of the type of values stored in the array - such as the number of dimensions, extents along each dimension, and number of values stored in the array.

To get and set array values, the vtkTypedArray template class derives from vtkArray and provides type-specific methods for retrieval and update.

Two concrete derivatives of vtkTypedArray are provided at the moment: vtkDenseArray and vtkSparseArray, which provide dense and sparse storage for arbitrary-dimension data, respectively. Toolkit users can create their own concrete derivatives that implement alternative storage strategies, such as compressed-sparse-row, etc. You could also create an array that provided read-only access to 'virtual' data, such as an array that returned a Fibonacci sequence, etc.

Thanks Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.

vtkTypedArray, vtkDenseArray, vtkSparseArray


Member Enumeration Documentation

Undocumented Block.

Enumerator:
DENSE 

enum member

SPARSE 

enum member


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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


Member Function Documentation

static vtkArray Kitware.VTK.vtkArray.CreateArray ( int  StorageType,
int  ValueType 
) [static]

Creates a new array where StorageType is one of vtkArray::DENSE or vtkArray::SPARSE, and ValueType is one of VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_ID_TYPE, or VTK_STRING. The caller is responsible for the lifetime of the returned object.

Here is the call graph for this function:

virtual vtkArray Kitware.VTK.vtkArray.DeepCopy ( ) [virtual]

Returns a new array that is a deep copy of this array.

Here is the call graph for this function:

override void Kitware.VTK.vtkArray.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.

Returns the number of dimensions stored in the array. Note that this is the same as calling GetExtents().GetDimensions().

virtual ulong Kitware.VTK.vtkArray.GetNonNullSize ( ) [virtual]

Returns the number of non-null values stored in the array. Note that this value will equal GetSize() for dense arrays, and will be less-than-or-equal to GetSize() for sparse arrays.

Returns the number of values stored in the array. Note that this is the same as calling GetExtents().GetSize(), and represents the maximum number of values that could ever be stored using the current extents. This is equal to the number of values stored in a dense array, but may be larger than the number of values stored in a sparse array.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

virtual bool Kitware.VTK.vtkArray.IsDense ( ) [virtual]

Returns true iff the underlying array storage is "dense", i.e. that GetSize() and GetNonNullSize() will always return the same value. If not, the array is "sparse".

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

void Kitware.VTK.vtkArray.Resize ( int  i)

Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().

The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.

void Kitware.VTK.vtkArray.Resize ( int  i,
int  j 
)

Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().

The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.

void Kitware.VTK.vtkArray.Resize ( int  i,
int  j,
int  k 
)

Resizes the array to the given extents (number of dimensions and size of each dimension). Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().

The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

static internal IntPtr Kitware.VTK.vtkArray.vtkArray_CreateArray_01 ( int  StorageType,
int  ValueType,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkArray.vtkArray_DeepCopy_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkArray.vtkArray_GetDimensions_03 ( HandleRef  pThis) [private]
static internal ulong Kitware.VTK.vtkArray.vtkArray_GetNonNullSize_04 ( HandleRef  pThis) [private]
static internal ulong Kitware.VTK.vtkArray.vtkArray_GetSize_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkArray.vtkArray_IsA_06 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkArray.vtkArray_IsDense_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkArray.vtkArray_IsTypeOf_08 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkArray.vtkArray_NewInstance_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkArray.vtkArray_Resize_10 ( HandleRef  pThis,
int  i 
) [private]
static internal void Kitware.VTK.vtkArray.vtkArray_Resize_11 ( HandleRef  pThis,
int  i,
int  j 
) [private]
static internal void Kitware.VTK.vtkArray.vtkArray_Resize_12 ( HandleRef  pThis,
int  i,
int  j,
int  k 
) [private]
static internal IntPtr Kitware.VTK.vtkArray.vtkArray_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkArray.MRClassNameKey = "8vtkArray" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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