/usr/include/vtk-7.1/vtkDataObjectTreeIterator.h is in libvtk7-dev 7.1.1+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | /*=========================================================================
Program: Visualization Toolkit
Module: vtkDataObjectTreeIterator.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 vtkDataObjectTreeIterator
* @brief superclass for composite data iterators
*
* vtkDataObjectTreeIterator provides an interface for accessing datasets
* in a collection (vtkDataObjectTreeIterator).
*/
#ifndef vtkDataObjectTreeIterator_h
#define vtkDataObjectTreeIterator_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCompositeDataIterator.h"
#include "vtkSmartPointer.h" //to store data sets
class vtkDataObjectTree;
class vtkDataObjectTreeInternals;
class vtkDataObjectTreeIndex;
class vtkDataObject;
class vtkInformation;
class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTreeIterator : public vtkCompositeDataIterator
{
public:
static vtkDataObjectTreeIterator* New();
vtkTypeMacro(vtkDataObjectTreeIterator, vtkCompositeDataIterator);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Move the iterator to the beginning of the collection.
*/
void GoToFirstItem() VTK_OVERRIDE;
/**
* Move the iterator to the next item in the collection.
*/
void GoToNextItem() VTK_OVERRIDE;
/**
* Test whether the iterator is finished with the traversal.
* Returns 1 for yes, and 0 for no.
* It is safe to call any of the GetCurrent...() methods only when
* IsDoneWithTraversal() returns 0.
*/
int IsDoneWithTraversal() VTK_OVERRIDE;
/**
* Returns the current item. Valid only when IsDoneWithTraversal() returns 0.
*/
vtkDataObject* GetCurrentDataObject() VTK_OVERRIDE;
/**
* Returns the meta-data associated with the current item.
* Note that, depending on iterator implementation, the returned information
* is not necessarily stored on the current object. So modifying the information
* is forbidden.
*/
vtkInformation* GetCurrentMetaData() VTK_OVERRIDE;
/**
* Returns if the a meta-data information object is present for the current
* item. Return 1 on success, 0 otherwise.
*/
int HasCurrentMetaData() VTK_OVERRIDE;
/**
* Flat index is an index obtained by traversing the tree in preorder.
* This can be used to uniquely identify nodes in the tree.
* Not valid if IsDoneWithTraversal() returns true.
*/
unsigned int GetCurrentFlatIndex() VTK_OVERRIDE;
//@{
/**
* If VisitOnlyLeaves is true, the iterator will only visit nodes
* (sub-datasets) that are not composite. If it encounters a composite
* data set, it will automatically traverse that composite dataset until
* it finds non-composite datasets. With this options, it is possible to
* visit all non-composite datasets in tree of composite datasets
* (composite of composite of composite for example :-) ) If
* VisitOnlyLeaves is false, GetCurrentDataObject() may return
* vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.
*/
vtkSetMacro(VisitOnlyLeaves, int);
vtkGetMacro(VisitOnlyLeaves, int);
vtkBooleanMacro(VisitOnlyLeaves, int);
//@}
//@{
/**
* If TraverseSubTree is set to true, the iterator will visit the entire tree
* structure, otherwise it only visits the first level children. Set to 1 by
* default.
*/
vtkSetMacro(TraverseSubTree, int);
vtkGetMacro(TraverseSubTree, int);
vtkBooleanMacro(TraverseSubTree, int);
//@}
protected:
vtkDataObjectTreeIterator();
~vtkDataObjectTreeIterator() VTK_OVERRIDE;
// Takes the current location to the next dataset. This traverses the tree in
// preorder fashion.
// If the current location is a composite dataset, next is its 1st child dataset.
// If the current is not a composite dataset, then next is the next dataset.
// This method gives no guarantees whether the current dataset will be
// non-null or leaf.
void NextInternal();
/**
* Returns the index for the current data object.
*/
vtkDataObjectTreeIndex GetCurrentIndex();
// Needs access to GetCurrentIndex().
friend class vtkDataObjectTree;
friend class vtkMultiDataSetInternal;
unsigned int CurrentFlatIndex;
private:
vtkDataObjectTreeIterator(const vtkDataObjectTreeIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkDataObjectTreeIterator&) VTK_DELETE_FUNCTION;
class vtkInternals;
vtkInternals* Internals;
friend class vtkInternals;
int TraverseSubTree;
int VisitOnlyLeaves;
/**
* Helper method used by vtkInternals to get access to the internals of
* vtkDataObjectTree.
*/
vtkDataObjectTreeInternals* GetInternals(vtkDataObjectTree*);
// Cannot be called when this->IsDoneWithTraversal() return 1.
void UpdateLocation();
};
#endif
|