Documentation for vtkIdList

vtkIdList - list of point or cell ids

Super Class: vtkObject

Description:

vtkIdList is used to represent and pass data id's between objects. vtkIdList may represent any type of integer id, but usually represents point and cell ids.

 

Methods:

void vtkIdList (const int ,const int )
void vtkIdList ()
int Allocate (const int ,const int )
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkIdList *New ()
int GetNumberOfIds ()
int GetId (const int )
void SetNumberOfIds (const int )
void SetId (const int ,const int )
void InsertId (const int ,const int )
int InsertNextId (const int )
int InsertUniqueId (const int )
int *GetPointer (const int )
int *WritePointer (const int ,const int )
void Reset ()
void Squeeze ()
void ShallowCopy (vtkIdList *)
void DeepCopy (vtkIdList *)
void DeleteId (int )
void IntersectWith (vtkIdList &)
int IsId (int )
void DeepCopy (vtkIdList &)
void ShallowCopy (vtkIdList &)

 

Detailed Method Descriptions:

Return the number of id's in the list.

int GetNumberOfIds ()

Return the id at location i.

int GetId (const int )

Specify the number of ids 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 SetNumberOfIds (const int )

Set the id at location i. Doesn't do range checking so it's a bit faster than InsertId. Make sure you use SetNumberOfIds() to allocate memory prior to using SetId().

void SetId (const int ,const int )

Set the id at location i. Does range checking and allocates memory as necessary.

void InsertId (const int ,const int )

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

int InsertNextId (const int )

If id is not already in list, insert it and return location in list. Otherwise return just location in list.

int InsertUniqueId (const int )

Get a pointer to a particular data index.

int *GetPointer (const int )

Get a pointer to 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.

int *WritePointer (const int ,const int )

Reset to an empty state but do not free any memory.

void Reset ()

Free any unused memory.

void Squeeze ()

Copy an id list by reference counting internal array.

void ShallowCopy (vtkIdList *)

Copy an id list by explicitly copying the internal array.

void DeepCopy (vtkIdList *)

Delete specified id from list. Will replace all occurences of id in list.

void DeleteId (int )

Intersect this list with another vtkIdList. Updates current list according to result of intersection operation.

void IntersectWith (vtkIdList &)

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

int IsId (int )

For legacy compatibility. Do not use.

void DeepCopy (vtkIdList &)