vtkImageIterator.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkImageIterator.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 vtkImageIterator_h
#define vtkImageIterator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkSystemIncludes.h"
class vtkImageData;

template<class DType>
class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator
{
public:
  typedef DType *SpanIterator;

  vtkImageIterator();

  vtkImageIterator(vtkImageData *id, int *ext);

  void Initialize(vtkImageData *id, int *ext);

  void NextSpan();

  SpanIterator BeginSpan()
  {
    return this->Pointer;
  }

  SpanIterator EndSpan()
  {
    return this->SpanEndPointer;
  }

  int IsAtEnd()
  {
    return (this->Pointer >= this->EndPointer);
  }

protected:
  DType *Pointer;
  DType *SpanEndPointer;
  DType *SliceEndPointer;
  DType *EndPointer;
  vtkIdType    Increments[3];
  vtkIdType    ContinuousIncrements[3];
};

#ifndef vtkImageIterator_cxx
vtkExternTemplateMacro(
  extern template class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator
)
#endif

#endif
// VTK-HeaderTest-Exclude: vtkImageIterator.h