VTK  9.1.0
vtkImageIterator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageIterator.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
35#ifndef vtkImageIterator_h
36#define vtkImageIterator_h
37
38#include "vtkCommonDataModelModule.h" // For export macro
39#include "vtkSystemIncludes.h"
40class vtkImageData;
41
42template <class DType>
43class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator
44{
45public:
46 typedef DType* SpanIterator;
47
53
58
62 void Initialize(vtkImageData* id, int* ext);
63
67 void NextSpan();
68
72 SpanIterator BeginSpan() { return this->Pointer; }
73
77 SpanIterator EndSpan() { return this->SpanEndPointer; }
78
82 vtkTypeBool IsAtEnd() { return (this->Pointer >= this->EndPointer); }
83
84protected:
85 DType* Pointer;
88 DType* EndPointer;
89 vtkIdType Increments[3];
90 vtkIdType ContinuousIncrements[3];
91};
92
93#ifndef vtkImageIterator_cxx
94#ifdef _MSC_VER
95#pragma warning(push)
96// The following is needed when the vtkImageIterator is declared
97// dllexport and is used from another class in vtkCommonCore
98#pragma warning(disable : 4910) // extern and dllexport incompatible
99#endif
100vtkExternTemplateMacro(extern template class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator);
101#ifdef _MSC_VER
102#pragma warning(pop)
103#endif
104#endif
105
106#endif
107// VTK-HeaderTest-Exclude: vtkImageIterator.h
topologically and geometrically regular array of data
Definition: vtkImageData.h:57
a simple image iterator
void Initialize(vtkImageData *id, int *ext)
Initialize the image iterator for a given image data, and given extent.
vtkImageIterator(vtkImageData *id, int *ext)
Create an image iterator for a given image data and a given extent.
vtkImageIterator()
Default empty constructor, useful only when creating an array of iterators You need to call Initializ...
SpanIterator BeginSpan()
Return an iterator (pointer) for the span.
void NextSpan()
Move the iterator to the next span.
SpanIterator EndSpan()
Return an iterator (pointer) for the end of the span.
vtkTypeBool IsAtEnd()
Test if the end of the extent has been reached.
int vtkTypeBool
Definition: vtkABI.h:69
vtkExternTemplateMacro(extern template class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator)
int vtkIdType
Definition: vtkType.h:332