vtkDataObjectTreeIterator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkDataObjectTreeIterator_h
#define vtkDataObjectTreeIterator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCompositeDataIterator.h"
#include "vtkSmartPointer.h" //to store data sets

VTK_ABI_NAMESPACE_BEGIN
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) override;

  void GoToFirstItem() override;

  void GoToNextItem() override;

  int IsDoneWithTraversal() override;

  vtkDataObject* GetCurrentDataObject() override;

  vtkInformation* GetCurrentMetaData() override;

  vtkTypeBool HasCurrentMetaData() override;

  unsigned int GetCurrentFlatIndex() override;


  vtkSetMacro(VisitOnlyLeaves, vtkTypeBool);
  vtkGetMacro(VisitOnlyLeaves, vtkTypeBool);
  vtkBooleanMacro(VisitOnlyLeaves, vtkTypeBool);


  vtkSetMacro(TraverseSubTree, vtkTypeBool);
  vtkGetMacro(TraverseSubTree, vtkTypeBool);
  vtkBooleanMacro(TraverseSubTree, vtkTypeBool);

protected:
  vtkDataObjectTreeIterator();
  ~vtkDataObjectTreeIterator() override;

  vtkSetMacro(CurrentFlatIndex, unsigned int);

  void InitializeInternal();

  /*
   * 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();

  vtkDataObjectTreeIndex GetCurrentIndex();

  // Needs access to GetCurrentIndex().
  friend class vtkDataObjectTree;
  friend class vtkMultiDataSetInternal;

  unsigned int CurrentFlatIndex;

  static bool IsDataObjectTree(vtkDataObject* dataObject);

private:
  vtkDataObjectTreeIterator(const vtkDataObjectTreeIterator&) = delete;
  void operator=(const vtkDataObjectTreeIterator&) = delete;

  class vtkInternals;
  vtkInternals* Internals;
  friend class vtkInternals;

  vtkTypeBool TraverseSubTree;
  vtkTypeBool VisitOnlyLeaves;

  vtkDataObjectTreeInternals* GetInternals(vtkDataObjectTree*);

  // Cannot be called when this->IsDoneWithTraversal() return 1.
  void UpdateLocation();
};

VTK_ABI_NAMESPACE_END
#endif