list of point or cell ids More...
#include <vtkIdList.h>
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 35 of file vtkIdList.h.
Member Typedef Documentation
| typedef vtkObject vtkIdList::Superclass |
Reimplemented from vtkObject.
Definition at line 46 of file vtkIdList.h.
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 |
||
| ) |
Allocate a capacity for sz ids in the list and set the number of stored ids in the list to 0. strategy is not used.
| 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.
| static vtkIdList* vtkIdList::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
| virtual vtkObjectBase* vtkIdList::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
| vtkIdList* vtkIdList::NewInstance | ( | ) | const |
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 50 of file vtkIdList.h.
| vtkIdType vtkIdList::GetId | ( | const vtkIdType | i | ) | [inline] |
Return the id at location i.
Definition at line 53 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.
| void vtkIdList::SetId | ( | const vtkIdType | i, |
| const vtkIdType | vtkid | ||
| ) | [inline] |
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 62 of file vtkIdList.h.
| void vtkIdList::InsertId | ( | const vtkIdType | i, |
| const vtkIdType | vtkid | ||
| ) |
Set the id at location i. Does range checking and allocates memory as necessary.
| vtkIdType vtkIdList::InsertNextId | ( | const vtkIdType | vtkid | ) | [inline] |
Add the id specified to the end of the list. Range checking is performed.
Definition at line 126 of file vtkIdList.h.
| vtkIdType vtkIdList::InsertUniqueId | ( | const vtkIdType | vtkid | ) |
If id is not already in list, insert it and return location in list. Otherwise return just location in list.
| vtkIdType* vtkIdList::GetPointer | ( | const vtkIdType | i | ) | [inline] |
Get a pointer to a particular data index.
Definition at line 77 of file vtkIdList.h.
| vtkIdType* vtkIdList::WritePointer | ( | const vtkIdType | i, |
| const vtkIdType | number | ||
| ) |
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 85 of file vtkIdList.h.
| void vtkIdList::Squeeze | ( | ) | [inline] |
Free any unused memory.
Definition at line 88 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.
| vtkIdType vtkIdList::IsId | ( | vtkIdType | vtkid | ) | [inline] |
Return -1 if id specified is not contained in the list; otherwise return the position in the list.
Definition at line 136 of file vtkIdList.h.
| void vtkIdList::IntersectWith | ( | vtkIdList * | otherIds | ) |
Intersect this list with another vtkIdList. Updates current list according to result of intersection operation.
| void vtkIdList::IntersectWith | ( | vtkIdList & | otherIds | ) | [inline] |
Definition at line 107 of file vtkIdList.h.
| vtkIdType* vtkIdList::Resize | ( | const vtkIdType | sz | ) | [protected] |
Member Data Documentation
vtkIdType vtkIdList::NumberOfIds [protected] |
Definition at line 115 of file vtkIdList.h.
vtkIdType vtkIdList::Size [protected] |
Definition at line 116 of file vtkIdList.h.
vtkIdType* vtkIdList::Ids [protected] |
Definition at line 117 of file vtkIdList.h.
The documentation for this class was generated from the following file:
- dox/Common/Core/vtkIdList.h
