vtkIdList Class Reference
#include <vtkIdList.h>
Inheritance diagram for vtkIdList:
[legend]Collaboration diagram for vtkIdList:
[legend]List of all members.
Detailed Description
list of point or cell ids
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.
- Examples:
- vtkIdList (Examples)
- Tests:
- vtkIdList (Tests)
Definition at line 34 of file vtkIdList.h.
Member Typedef Documentation
Constructor & Destructor Documentation
vtkIdList::vtkIdList |
( |
|
) |
[protected] |
|
Member Function Documentation
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject. |
void vtkIdList::Initialize |
( |
|
) |
|
|
int vtkIdList::Allocate |
( |
const int |
sz, |
|
|
const int |
strategy = 0 |
|
) |
|
|
virtual const char* vtkIdList::GetClassName |
( |
|
) |
[virtual] |
|
int vtkIdList::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
virtual int vtkIdList::IsA |
( |
const char * |
type |
) |
[virtual] |
|
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
void vtkIdList::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject. |
vtkIdType vtkIdList::GetNumberOfIds |
( |
|
) |
[inline] |
|
vtkIdType vtkIdList::GetId |
( |
const int |
i |
) |
[inline] |
|
void vtkIdList::SetNumberOfIds |
( |
const vtkIdType |
number |
) |
|
|
|
Specify the number of ids for this object to hold. Does an allocation as well as setting the number of ids. |
|
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().
Definition at line 57 of file vtkIdList.h. |
|
Set the id at location i. Does range checking and allocates memory as necessary. |
|
If id is not already in list, insert it and return location in list. Otherwise return just location in list. |
|
Get a pointer to a particular data index.
Definition at line 72 of file vtkIdList.h. |
|
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. |
void vtkIdList::Reset |
( |
|
) |
[inline] |
|
|
Reset to an empty state.
Definition at line 80 of file vtkIdList.h. |
void vtkIdList::Squeeze |
( |
|
) |
[inline] |
|
|
Free any unused memory.
Definition at line 83 of file vtkIdList.h. |
|
Copy an id list by explicitly copying the internal array. |
|
Delete specified id from list. Will remove all occurrences of id in list. |
|
Return -1 if id specified is not contained in the list; otherwise return the position in the list.
Definition at line 125 of file vtkIdList.h. |
void vtkIdList::IntersectWith |
( |
vtkIdList & |
otherIds |
) |
|
|
|
Intersect this list with another vtkIdList. Updates current list according to result of intersection operation. |
Member Data Documentation
The documentation for this class was generated from the following file: