VTK  9.1.0
vtkDataObjectTreeIterator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkDataObjectTreeIterator.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
42#ifndef vtkDataObjectTreeIterator_h
43#define vtkDataObjectTreeIterator_h
44
45#include "vtkCommonDataModelModule.h" // For export macro
47#include "vtkSmartPointer.h" //to store data sets
48
52class vtkDataObject;
53class vtkInformation;
54
55class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTreeIterator : public vtkCompositeDataIterator
56{
57public:
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
65 void GoToFirstItem() override;
66
70 void GoToNextItem() override;
71
78 int IsDoneWithTraversal() override;
79
84
92
97 int HasCurrentMetaData() override;
98
104 unsigned int GetCurrentFlatIndex() override;
105
107
117 vtkSetMacro(VisitOnlyLeaves, vtkTypeBool);
118 vtkGetMacro(VisitOnlyLeaves, vtkTypeBool);
119 vtkBooleanMacro(VisitOnlyLeaves, vtkTypeBool);
121
123
128 vtkSetMacro(TraverseSubTree, vtkTypeBool);
129 vtkGetMacro(TraverseSubTree, vtkTypeBool);
130 vtkBooleanMacro(TraverseSubTree, vtkTypeBool);
132
133protected:
136
137 // Use the macro to ensure MTime is updated:
138 vtkSetMacro(CurrentFlatIndex, unsigned int);
139
140 // Takes the current location to the next dataset. This traverses the tree in
141 // preorder fashion.
142 // If the current location is a composite dataset, next is its 1st child dataset.
143 // If the current is not a composite dataset, then next is the next dataset.
144 // This method gives no guarantees whether the current dataset will be
145 // non-null or leaf.
147
152
153 // Needs access to GetCurrentIndex().
154 friend class vtkDataObjectTree;
155 friend class vtkMultiDataSetInternal;
156
157 unsigned int CurrentFlatIndex;
158
159private:
161 void operator=(const vtkDataObjectTreeIterator&) = delete;
162
163 class vtkInternals;
164 vtkInternals* Internals;
165 friend class vtkInternals;
166
167 vtkTypeBool TraverseSubTree;
168 vtkTypeBool VisitOnlyLeaves;
169
175
176 // Cannot be called when this->IsDoneWithTraversal() return 1.
177 void UpdateLocation();
178};
179
180#endif
superclass for composite data iterators
superclass for composite data iterators
vtkDataObject * GetCurrentDataObject() override
Returns the current item.
int IsDoneWithTraversal() override
Test whether the iterator is finished with the traversal.
vtkInformation * GetCurrentMetaData() override
Returns the meta-data associated with the current item.
int HasCurrentMetaData() override
Returns if the a meta-data information object is present for the current item.
void GoToFirstItem() override
Move the iterator to the beginning of the collection.
~vtkDataObjectTreeIterator() override
void GoToNextItem() override
Move the iterator to the next item in the collection.
vtkDataObjectTreeIndex GetCurrentIndex()
Returns the index for the current data object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
unsigned int GetCurrentFlatIndex() override
Flat index is an index obtained by traversing the tree in preorder.
static vtkDataObjectTreeIterator * New()
provides implementation for most abstract methods in the superclass vtkCompositeDataSet
general representation of visualization data
a simple class to control print indentation
Definition: vtkIndent.h:113
Store vtkAlgorithm input/output information.
int vtkTypeBool
Definition: vtkABI.h:69