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=========================================================================*/
75#ifndef vtkImageIterator_h
76#define vtkImageIterator_h
77
78#include "vtkCommonDataModelModule.h" // For export macro
79#include "vtkSystemIncludes.h"
80class vtkImageData;
81
82template <class DType>
83class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator
84{
85public:
86 typedef DType* SpanIterator;
87
93
98
102 void Initialize(vtkImageData* id, int* ext);
103
107 void NextSpan();
108
112 SpanIterator BeginSpan() { return this->Pointer; }
113
117 SpanIterator EndSpan() { return this->SpanEndPointer; }
118
122 vtkTypeBool IsAtEnd() { return (this->Pointer >= this->EndPointer); }
123
124protected:
125 DType* Pointer;
129 vtkIdType Increments[3];
130 vtkIdType ContinuousIncrements[3];
131};
132
133#ifndef vtkImageIterator_cxx
134#ifdef _MSC_VER
135#pragma warning(push)
136// The following is needed when the vtkImageIterator is declared
137// dllexport and is used from another class in vtkCommonCore
138#pragma warning(disable : 4910) // extern and dllexport incompatible
139#endif
140vtkExternTemplateMacro(extern template class VTKCOMMONDATAMODEL_EXPORT vtkImageIterator);
141#ifdef _MSC_VER
142#pragma warning(pop)
143#endif
144#endif
145
146#endif
147// VTK-HeaderTest-Exclude: vtkImageIterator.h
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
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
#define vtkExternTemplateMacro(decl)
A macro to declare extern templates for all numerical types.
Definition: vtkType.h:395
int vtkIdType
Definition: vtkType.h:332