vtkCollectionIterator.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 vtkCollectionIterator_h
#define vtkCollectionIterator_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_7_0
#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkCollection;

class VTK_DEPRECATED_IN_9_7_0("Use vtk::Range instead.") VTKCOMMONCORE_EXPORT vtkCollectionIterator
  : public vtkObject
{
public:
  vtkTypeMacro(vtkCollectionIterator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkCollectionIterator* New();


  virtual void SetCollection(vtkCollection*);
  vtkGetObjectMacro(Collection, vtkCollection);

  void InitTraversal() { this->GoToFirstItem(); }

  void GoToFirstItem();

  void GoToNextItem();

  int IsDoneWithTraversal();

  vtkObject* GetCurrentObject();

protected:
  vtkCollectionIterator();
  ~vtkCollectionIterator() override;

  // The collection over which we are iterating.
  vtkCollection* Collection;

  vtkObject* GetObjectInternal();

private:
  // The current iterator position.
  std::vector<vtkObject*>::iterator Iterator;

  vtkCollectionIterator(const vtkCollectionIterator&) = delete;
  void operator=(const vtkCollectionIterator&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif