vtkIdList Class Reference
#include <vtkIdList.h>
Detailed Description
list of point or cell idsvtkIdList 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.
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| void | Initialize () |
| int | Allocate (const vtkIdType sz, const int strategy=0) |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| vtkIdType | GetNumberOfIds () |
| vtkIdType | GetId (const vtkIdType i) |
| void | SetNumberOfIds (const vtkIdType number) |
| void | SetId (const vtkIdType i, const vtkIdType vtkid) |
| void | InsertId (const vtkIdType i, const vtkIdType vtkid) |
| vtkIdType | InsertNextId (const vtkIdType vtkid) |
| vtkIdType | InsertUniqueId (const vtkIdType vtkid) |
| vtkIdType * | GetPointer (const vtkIdType i) |
| vtkIdType * | WritePointer (const vtkIdType i, const vtkIdType number) |
| void | Reset () |
| void | Squeeze () |
| void | DeepCopy (vtkIdList *ids) |
| void | DeleteId (vtkIdType vtkid) |
| vtkIdType | IsId (vtkIdType vtkid) |
| void | IntersectWith (vtkIdList &otherIds) |
Static Public Member Functions | |
| static vtkIdList * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkIdList * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkIdList () | |
| ~vtkIdList () | |
| vtkIdType * | Resize (const vtkIdType sz) |
Protected Attributes | |
| vtkIdType | NumberOfIds |
| vtkIdType | Size |
| vtkIdType * | Ids |
Member Typedef Documentation
| typedef vtkObject vtkIdList::Superclass |
Constructor & Destructor Documentation
| vtkIdList::vtkIdList | ( | ) | [protected] |
| vtkIdList::~vtkIdList | ( | ) | [protected] |
Member Function Documentation
| static vtkIdList* vtkIdList::New | ( | ) | [static] |
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 vtkIdType | sz, | |
| const int | strategy = 0 | |||
| ) |
| virtual const char* vtkIdList::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkIdList::IsTypeOf | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
| virtual int vtkIdList::IsA | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
| void vtkIdList::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
| vtkIdType vtkIdList::GetNumberOfIds | ( | ) | [inline] |
Return the number of id's in the list.
Definition at line 45 of file vtkIdList.h.
Return the id at location i.
Definition at line 48 of file vtkIdList.h.
| 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.
Add the id specified to the end of the list. Range checking is performed.
Definition at line 115 of file vtkIdList.h.
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.
| void vtkIdList::DeepCopy | ( | vtkIdList * | ids | ) |
Copy an id list by explicitly copying the internal array.
| void vtkIdList::DeleteId | ( | vtkIdType | vtkid | ) |
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
vtkIdType vtkIdList::NumberOfIds [protected] |
Definition at line 104 of file vtkIdList.h.
vtkIdType vtkIdList::Size [protected] |
Definition at line 105 of file vtkIdList.h.
vtkIdType* vtkIdList::Ids [protected] |
Definition at line 106 of file vtkIdList.h.
The documentation for this class was generated from the following file:
- dox/Common/vtkIdList.h
