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.vtkVariantArray Class Reference

vtkVariantArray - An array holding vtkVariants. More...

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

List of all members.

Public Member Functions

 vtkVariantArray (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkVariantArray ()
 Undocumented Block.
override int Allocate (int sz, int ext)
 Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.
override void ClearLookup ()
 Delete the associated fast lookup data structure on this array, if it exists. The lookup will be rebuilt on the next call to a lookup function.
override void DataChanged ()
 Tell the array explicitly that the data has changed. This is only necessary to call when you modify the array contents without using the array's API (i.e. you retrieve a pointer to the data and modify the array contents). You need to call this so that the fast lookup will know to rebuild itself. Otherwise, the lookup functions will give incorrect results.
virtual void DataElementChanged (int id)
 Tell the array explicitly that a single data element has changed. Like DataChanged(), then is only necessary when you modify the array contents without using the array's API.
override void DeepCopy (vtkAbstractArray da)
 Deep copy of data. Implementation left to subclasses, which should support as many type conversions as possible given the data type.
override uint GetActualMemorySize ()
 Return the memory in kilobytes consumed by this data 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.
override int GetDataType ()
 Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.
override int GetDataTypeSize ()
 Return the size of the underlying data type. For a bit, 1 is returned. For string 0 is returned. Arrays with variable length components return 0.
override int GetElementComponentSize ()
 Return the size, in bytes, of the lowest-level element of an array. For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is sizeof(vtkStdString::value_type), which winds up being sizeof(char).
int GetNumberOfValues ()
 Return the number of values in the array.
override IntPtr GetVoidPointer (int id)
 Return a void pointer. For image pipeline interface and other special pointer manipulation.
override void Initialize ()
 Release storage and reset array to initial state.
override int InsertNextTuple (int j, vtkAbstractArray source)
 Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as necessary to hold the data. Returns the location at which the data was inserted.
override void InsertTuple (int i, int j, vtkAbstractArray source)
 Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as necessary to hold the data.
override void InterpolateTuple (int i, vtkIdList ptIndices, vtkAbstractArray source, IntPtr weights)
 Set the ith tuple in this array as the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. This method assumes that the two arrays are of the same type and strcuture.
override void InterpolateTuple (int i, int id1, vtkAbstractArray source1, int id2, vtkAbstractArray source2, double t)
 Description Insert the ith tuple in this array as interpolated from the two values, p1 and p2, and an interpolation factor, t. The interpolation factor ranges from (0,1), with t=0 located at p1. This method assumes that the three arrays are of the same type. p1 is value at index id1 in source1, while, p2 is value at index id2 in source2.
override int IsA (string type)
 Undocumented Block.
override int IsNumeric ()
 Since each item can be of a different type, we say that a variant array is not numeric.
new vtkVariantArray NewInstance ()
 Undocumented Block.
override vtkArrayIterator NewIterator ()
 Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.
override int Resize (int numTuples)
 Resize the array while conserving the data. Returns 1 if resizing succeeded and 0 otherwise.
override void SetNumberOfTuples (int number)
 Set the number of tuples (a component group) in the array. Note that this may allocate space depending on the number of components.
void SetNumberOfValues (int number)
 Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.
override void SetTuple (int i, int j, vtkAbstractArray source)
 Set the tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.
override void SetVoidArray (IntPtr arr, int size, int save)
 This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the supplied array.
override void Squeeze ()
 Free any unnecessary memory. Resize object to just fit data requirement. Reclaims extra memory.

Static Public Member Functions

static new vtkVariantArray New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkVariantArray SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkVariantArray"
 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 vtkVariantArray_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkVariantArray_Allocate_01 (HandleRef pThis, int sz, int ext)
static internal void vtkVariantArray_ClearLookup_02 (HandleRef pThis)
static internal void vtkVariantArray_DataChanged_03 (HandleRef pThis)
static internal void vtkVariantArray_DataElementChanged_04 (HandleRef pThis, int id)
static internal void vtkVariantArray_DeepCopy_05 (HandleRef pThis, HandleRef da)
static internal uint vtkVariantArray_GetActualMemorySize_06 (HandleRef pThis)
static internal int vtkVariantArray_GetDataType_07 (HandleRef pThis)
static internal int vtkVariantArray_GetDataTypeSize_08 (HandleRef pThis)
static internal int vtkVariantArray_GetElementComponentSize_09 (HandleRef pThis)
static internal int vtkVariantArray_GetNumberOfValues_10 (HandleRef pThis)
static internal IntPtr vtkVariantArray_GetVoidPointer_11 (HandleRef pThis, int id)
static internal void vtkVariantArray_Initialize_12 (HandleRef pThis)
static internal int vtkVariantArray_InsertNextTuple_13 (HandleRef pThis, int j, HandleRef source)
static internal void vtkVariantArray_InsertTuple_14 (HandleRef pThis, int i, int j, HandleRef source)
static internal void vtkVariantArray_InterpolateTuple_15 (HandleRef pThis, int i, HandleRef ptIndices, HandleRef source, IntPtr weights)
static internal void vtkVariantArray_InterpolateTuple_16 (HandleRef pThis, int i, int id1, HandleRef source1, int id2, HandleRef source2, double t)
static internal int vtkVariantArray_IsA_17 (HandleRef pThis, string type)
static internal int vtkVariantArray_IsNumeric_18 (HandleRef pThis)
static internal int vtkVariantArray_IsTypeOf_19 (string type)
static internal IntPtr vtkVariantArray_NewInstance_21 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkVariantArray_NewIterator_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkVariantArray_Resize_23 (HandleRef pThis, int numTuples)
static internal IntPtr vtkVariantArray_SafeDownCast_24 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVariantArray_SetNumberOfTuples_25 (HandleRef pThis, int number)
static internal void vtkVariantArray_SetNumberOfValues_26 (HandleRef pThis, int number)
static internal void vtkVariantArray_SetTuple_27 (HandleRef pThis, int i, int j, HandleRef source)
static internal void vtkVariantArray_SetVoidArray_28 (HandleRef pThis, IntPtr arr, int size, int save)
static internal void vtkVariantArray_Squeeze_29 (HandleRef pThis)

Static Private Member Functions

static vtkVariantArray ()
 Automatically generated type registration mechanics.

Detailed Description

vtkVariantArray - An array holding vtkVariants.

Description

Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

override int Kitware.VTK.vtkVariantArray.Allocate ( int  sz,
int  ext 
) [virtual]

Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.ClearLookup ( ) [virtual]

Delete the associated fast lookup data structure on this array, if it exists. The lookup will be rebuilt on the next call to a lookup function.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.DataChanged ( ) [virtual]

Tell the array explicitly that the data has changed. This is only necessary to call when you modify the array contents without using the array's API (i.e. you retrieve a pointer to the data and modify the array contents). You need to call this so that the fast lookup will know to rebuild itself. Otherwise, the lookup functions will give incorrect results.

Reimplemented from Kitware.VTK.vtkAbstractArray.

virtual void Kitware.VTK.vtkVariantArray.DataElementChanged ( int  id) [virtual]

Tell the array explicitly that a single data element has changed. Like DataChanged(), then is only necessary when you modify the array contents without using the array's API.

override void Kitware.VTK.vtkVariantArray.DeepCopy ( vtkAbstractArray  da) [virtual]

Deep copy of data. Implementation left to subclasses, which should support as many type conversions as possible given the data type.

Reimplemented from Kitware.VTK.vtkAbstractArray.

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

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

Reimplemented from Kitware.VTK.vtkAbstractArray.

override int Kitware.VTK.vtkVariantArray.GetDataType ( ) [virtual]

Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override int Kitware.VTK.vtkVariantArray.GetDataTypeSize ( ) [virtual]

Return the size of the underlying data type. For a bit, 1 is returned. For string 0 is returned. Arrays with variable length components return 0.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Return the size, in bytes, of the lowest-level element of an array. For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is sizeof(vtkStdString::value_type), which winds up being sizeof(char).

Reimplemented from Kitware.VTK.vtkAbstractArray.

Return the number of values in the array.

override IntPtr Kitware.VTK.vtkVariantArray.GetVoidPointer ( int  id) [virtual]

Return a void pointer. For image pipeline interface and other special pointer manipulation.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.Initialize ( ) [virtual]

Release storage and reset array to initial state.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override int Kitware.VTK.vtkVariantArray.InsertNextTuple ( int  j,
vtkAbstractArray  source 
) [virtual]

Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as necessary to hold the data. Returns the location at which the data was inserted.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.InsertTuple ( int  i,
int  j,
vtkAbstractArray  source 
) [virtual]

Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as necessary to hold the data.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.InterpolateTuple ( int  i,
vtkIdList  ptIndices,
vtkAbstractArray  source,
IntPtr  weights 
) [virtual]

Set the ith tuple in this array as the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. This method assumes that the two arrays are of the same type and strcuture.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.InterpolateTuple ( int  i,
int  id1,
vtkAbstractArray  source1,
int  id2,
vtkAbstractArray  source2,
double  t 
) [virtual]

Description Insert the ith tuple in this array as interpolated from the two values, p1 and p2, and an interpolation factor, t. The interpolation factor ranges from (0,1), with t=0 located at p1. This method assumes that the three arrays are of the same type. p1 is value at index id1 in source1, while, p2 is value at index id2 in source2.

Reimplemented from Kitware.VTK.vtkAbstractArray.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override int Kitware.VTK.vtkVariantArray.IsNumeric ( ) [virtual]

Since each item can be of a different type, we say that a variant array is not numeric.

Reimplemented from Kitware.VTK.vtkAbstractArray.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Here is the call graph for this function:

override int Kitware.VTK.vtkVariantArray.Resize ( int  numTuples) [virtual]

Resize the array while conserving the data. Returns 1 if resizing succeeded and 0 otherwise.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Here is the call graph for this function:

override void Kitware.VTK.vtkVariantArray.SetNumberOfTuples ( int  number) [virtual]

Set the number of tuples (a component group) in the array. Note that this may allocate space depending on the number of components.

Reimplemented from Kitware.VTK.vtkAbstractArray.

Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.

override void Kitware.VTK.vtkVariantArray.SetTuple ( int  i,
int  j,
vtkAbstractArray  source 
) [virtual]

Set the tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.SetVoidArray ( IntPtr  arr,
int  size,
int  save 
) [virtual]

This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the supplied array.

Reimplemented from Kitware.VTK.vtkAbstractArray.

override void Kitware.VTK.vtkVariantArray.Squeeze ( ) [virtual]

Free any unnecessary memory. Resize object to just fit data requirement. Reclaims extra memory.

Reimplemented from Kitware.VTK.vtkAbstractArray.

static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_Allocate_01 ( HandleRef  pThis,
int  sz,
int  ext 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_ClearLookup_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_DataChanged_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_DataElementChanged_04 ( HandleRef  pThis,
int  id 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_DeepCopy_05 ( HandleRef  pThis,
HandleRef  da 
) [private]
static internal uint Kitware.VTK.vtkVariantArray.vtkVariantArray_GetActualMemorySize_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_GetDataType_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_GetDataTypeSize_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_GetElementComponentSize_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_GetNumberOfValues_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVariantArray.vtkVariantArray_GetVoidPointer_11 ( HandleRef  pThis,
int  id 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_Initialize_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_InsertNextTuple_13 ( HandleRef  pThis,
int  j,
HandleRef  source 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_InsertTuple_14 ( HandleRef  pThis,
int  i,
int  j,
HandleRef  source 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_InterpolateTuple_15 ( HandleRef  pThis,
int  i,
HandleRef  ptIndices,
HandleRef  source,
IntPtr  weights 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_InterpolateTuple_16 ( HandleRef  pThis,
int  i,
int  id1,
HandleRef  source1,
int  id2,
HandleRef  source2,
double  t 
) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_IsA_17 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_IsNumeric_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_IsTypeOf_19 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkVariantArray.vtkVariantArray_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVariantArray.vtkVariantArray_NewInstance_21 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVariantArray.vtkVariantArray_NewIterator_22 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkVariantArray.vtkVariantArray_Resize_23 ( HandleRef  pThis,
int  numTuples 
) [private]
static internal IntPtr Kitware.VTK.vtkVariantArray.vtkVariantArray_SafeDownCast_24 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_SetNumberOfTuples_25 ( HandleRef  pThis,
int  number 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_SetNumberOfValues_26 ( HandleRef  pThis,
int  number 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_SetTuple_27 ( HandleRef  pThis,
int  i,
int  j,
HandleRef  source 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_SetVoidArray_28 ( HandleRef  pThis,
IntPtr  arr,
int  size,
int  save 
) [private]
static internal void Kitware.VTK.vtkVariantArray.vtkVariantArray_Squeeze_29 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkVariantArray.MRClassNameKey = "15vtkVariantArray" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractArray.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractArray.


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