vtkCollectionIterator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkCollectionIterator.h,v $

  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.

=========================================================================*/
#ifndef __vtkCollectionIterator_h
#define __vtkCollectionIterator_h

#include "vtkObject.h"

class vtkCollection;
class vtkCollectionElement;

class VTK_COMMON_EXPORT vtkCollectionIterator : public vtkObject
{
public:
  vtkTypeRevisionMacro(vtkCollectionIterator,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  static vtkCollectionIterator* New();
  

  virtual void SetCollection(vtkCollection*);
  vtkGetObjectMacro(Collection, vtkCollection);
  
  void InitTraversal() { this->GoToFirstItem(); }
  
  void GoToFirstItem();
  
  void GoToNextItem();
  
  int IsDoneWithTraversal();

  vtkObject* GetCurrentObject();

#ifdef VTK_WORKAROUND_WINDOWS_MANGLE
# define GetObjectA GetObject
# define GetObjectW GetObject
#endif

  VTK_LEGACY(vtkObject* GetObject());

#ifdef VTK_WORKAROUND_WINDOWS_MANGLE
# undef GetObjectW
# undef GetObjectA
  //BTX
  VTK_LEGACY(vtkObject* GetObjectA());
  VTK_LEGACY(vtkObject* GetObjectW());
  //ETX
#endif

protected:
  vtkCollectionIterator();
  ~vtkCollectionIterator();
  
  // The collection over which we are iterating.
  vtkCollection* Collection;
  
  // The current iterator position.
  vtkCollectionElement* Element;

  vtkObject* GetObjectInternal();
private:
  vtkCollectionIterator(const vtkCollectionIterator&); // Not implemented
  void operator=(const vtkCollectionIterator&); // Not implemented
};

#endif

---