forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkCollectionIterator.h
95 lines (76 loc) · 2.68 KB
/
vtkCollectionIterator.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/*=========================================================================
Program: Visualization Toolkit
Module: vtkCollectionIterator.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkCollectionIterator
* @brief iterator through a vtkCollection.
*
* vtkCollectionIterator provides an alternative way to traverse
* through the objects in a vtkCollection. Unlike the collection's
* built in interface, this allows multiple iterators to
* simultaneously traverse the collection. If items are removed from
* the collection, only the iterators currently pointing to those
* items are invalidated. Other iterators will still continue to
* function normally.
*/
#ifndef vtkCollectionIterator_h
#define vtkCollectionIterator_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
class vtkCollection;
class vtkCollectionElement;
class VTKCOMMONCORE_EXPORT vtkCollectionIterator : public vtkObject
{
public:
vtkTypeMacro(vtkCollectionIterator,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
static vtkCollectionIterator* New();
//@{
/**
* Set/Get the collection over which to iterate.
*/
virtual void SetCollection(vtkCollection*);
vtkGetObjectMacro(Collection, vtkCollection);
//@}
/**
* Position the iterator at the first item in the collection.
*/
void InitTraversal() { this->GoToFirstItem(); }
/**
* Position the iterator at the first item in the collection.
*/
void GoToFirstItem();
/**
* Move the iterator to the next item in the collection.
*/
void GoToNextItem();
/**
* Test whether the iterator is currently positioned at a valid item.
* Returns 1 for yes, 0 for no.
*/
int IsDoneWithTraversal();
/**
* Get the item at the current iterator position. Valid only when
* IsDoneWithTraversal() returns 1.
*/
vtkObject* GetCurrentObject();
protected:
vtkCollectionIterator();
~vtkCollectionIterator() VTK_OVERRIDE;
// The collection over which we are iterating.
vtkCollection* Collection;
// The current iterator position.
vtkCollectionElement* Element;
vtkObject* GetObjectInternal();
private:
vtkCollectionIterator(const vtkCollectionIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkCollectionIterator&) VTK_DELETE_FUNCTION;
};
#endif