vtkCompositeDataIterator.h

Go to the documentation of this file.

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

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

=========================================================================*/
#ifndef vtkCompositeDataIterator_h
#define vtkCompositeDataIterator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"

class vtkCompositeDataSet;
class vtkCompositeDataSetInternals;
class vtkCompositeDataSetIndex;
class vtkDataObject;
class vtkInformation;

class VTKCOMMONDATAMODEL_EXPORT vtkCompositeDataIterator : public vtkObject
{
public:
  vtkTypeMacro(vtkCompositeDataIterator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetDataSet(vtkCompositeDataSet* ds);
  vtkGetObjectMacro(DataSet, vtkCompositeDataSet);

  virtual void InitTraversal();

  virtual void InitReverseTraversal();

  virtual void GoToFirstItem() = 0;

  virtual void GoToNextItem() =0;

  virtual int IsDoneWithTraversal() =0;

  virtual vtkDataObject* GetCurrentDataObject() = 0;

  virtual vtkInformation* GetCurrentMetaData() =0;

  virtual int HasCurrentMetaData() =0;


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

  virtual unsigned int GetCurrentFlatIndex()=0;


  vtkGetMacro(Reverse, int);

protected:
  vtkCompositeDataIterator();
  ~vtkCompositeDataIterator() override;
  vtkTypeBool SkipEmptyNodes;
  int Reverse;
  vtkCompositeDataSet* DataSet;

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

};

#endif