dox/Imaging/vtkImageStencilIterator.h

Go to the documentation of this file.

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

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

#include "vtkSystemIncludes.h"
class vtkImageData;
class vtkImageStencilData;
class vtkAlgorithm;

template<class DType>
class vtkImageStencilIterator
{
public:
  vtkImageStencilIterator();


  vtkImageStencilIterator(
    vtkImageData *image, vtkImageStencilData *stencil, int extent[6],
    vtkAlgorithm *algorithm=0, int threadId=0);


  void Initialize(
    vtkImageData *image, vtkImageStencilData *stencil, int extent[6]);


  bool IsInStencil()
    {
    return this->InStencil;
    }

  void NextSpan();


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


  DType *BeginSpan()
    {
    return this->Pointer;
    }


  DType *EndSpan()
    {
    return this->SpanEndPointer;
    }

protected:

  void SetSpanState(int idX);

  void ReportProgress();

  // Pointers
  DType     *Pointer;           // current iterator position within data
  DType     *SpanEndPointer;    // end of current span
  DType     *RowEndPointer;     // end of current row
  DType     *SliceEndPointer;   // end of current slice
  DType     *EndPointer;        // end of data

  // Increments
  vtkIdType  PixelIncrement;    // to next pixel
  vtkIdType  RowIncrement;      // to same position in next row
  vtkIdType  SliceIncrement;    // to same position in next slice
  vtkIdType  RowEndIncrement;   // from end of row to start of next row
  vtkIdType  SliceEndIncrement; // from end of slice to start of next slice

  // Stencil-related items
  bool       HasStencil;
  bool       InStencil;
  int        SpanSliceEndIncrement;
  int        SpanSliceIncrement;
  int        SpanMinX;
  int        SpanMaxX;
  int        SpanMinY;
  int        SpanMaxY;
  int        SpanMinZ;
  int        SpanMaxZ;
  int        SpanIndexX;
  int        SpanIndexY;
  int        SpanIndexZ;
  int       *SpanCountPointer;
  int      **SpanListPointer;

  // Progress-related items
  vtkAlgorithm *Algorithm;
  vtkIdType  Count;
  vtkIdType  Target;
};

#ifdef VTK_NO_EXPLICIT_TEMPLATE_INSTANTIATION
#include "vtkImageStencilIterator.txx"
#endif

#endif