Documentation for vtkVoidArray

vtkVoidArray - dynamic, self-adjusting array of void* pointers

Super Class: vtkDataArray

Description:

vtkVoidArray is an array of pointers to void. It provides methods for insertion and retrieval of these pointers values, and will automatically resize itself to hold new data.

 

Methods:

void vtkVoidArray ()
void vtkVoidArray ()
static vtkVoidArray *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
int Allocate (const int ,const int )
void Initialize ()
vtkDataArray *MakeObject ()
int GetDataType ()
void SetNumberOfTuples (const int )
float *GetTuple (const int )
void GetTuple (const int ,float *)
void SetTuple (const int ,const float *)
void InsertTuple (const int ,const float *)
int InsertNextTuple (const float *)
void Squeeze ()
void *GetValue (const int )
void SetNumberOfValues (const int )
void SetValue (const int ,void *)
void InsertValue (const int ,void *)
int InsertNextValue (void *)
void GetPointer (const int )
void *GetVoidPointer (const int )
void WritePointer (const int ,const int )
void DeepCopy (vtkDataArray *)
void DeepCopy (vtkDataArray &)
void Resize (const int )

 

Detailed Method Descriptions:

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

int Allocate (const int ,const int )

Release storage and reset array to initial state.

void Initialize ()

Create a similar type object

vtkDataArray *MakeObject ()

Get the data type.

int GetDataType ()

Set the number of n-tuples in the array.

void SetNumberOfTuples (const int )

Get a pointer to a tuple at the ith location.

float *GetTuple (const int )

Copy the tuple value into a user-provided array.

void GetTuple (const int ,float *)

Set the tuple value at the ith location in the array.

void SetTuple (const int ,const float *)

Insert (memory allocation performed) the tuple into the ith location in the array.

void InsertTuple (const int ,const float *)

Insert (memory allocation performed) the tuple onto the end of the array.

int InsertNextTuple (const float *)

Resize object to just fit data requirement. Reclaims extra memory.

void Squeeze ()

Get the data at a particular index.

void *GetValue (const int )

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.

void SetNumberOfValues (const int )

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.

void SetValue (const int ,void *)

Insert data at a specified position in the array.

void InsertValue (const int ,void *)

Insert data at the end of the array. Return its location in the array.

int InsertNextValue (void *)

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.

void GetPointer (const int )
void *GetVoidPointer (const int )

Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.

void WritePointer (const int ,const int )

Deep copy of another void array.

void DeepCopy (vtkDataArray *)