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

  Program:   Visualization Toolkit
  Module:    vtkHierarchicalBoxDataIterator.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.

=========================================================================*/
// .NAME vtkHierarchicalBoxDataIterator - subclass of vtkCompositeDataIterator
// with API to get current level and dataset index.
// .SECTION Description

#ifndef __vtkHierarchicalBoxDataIterator_h
#define __vtkHierarchicalBoxDataIterator_h

#include "vtkCompositeDataIterator.h"

class VTK_FILTERING_EXPORT vtkHierarchicalBoxDataIterator : public vtkCompositeDataIterator
{
public:
  static vtkHierarchicalBoxDataIterator* New();
  vtkTypeRevisionMacro(vtkHierarchicalBoxDataIterator, vtkCompositeDataIterator);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Returns the level for the current dataset.
  unsigned int GetCurrentLevel();

  // Description:
  // Returns the dataset index for the current data object. Valid only if the
  // current data is a leaf node i.e. no a composite dataset.
  unsigned int GetCurrentIndex();

//BTX
protected:
  vtkHierarchicalBoxDataIterator();
  ~vtkHierarchicalBoxDataIterator();

private:
  vtkHierarchicalBoxDataIterator(const vtkHierarchicalBoxDataIterator&); // Not implemented.
  void operator=(const vtkHierarchicalBoxDataIterator&); // Not implemented.
//ETX
};

#endif


