VTK  9.6.20260112
vtkAnnularBinIterator.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
25#ifndef vtkAnnularBinIterator_h
26#define vtkAnnularBinIterator_h
27
28#include "vtkFiltersMeshingModule.h" // For export macro
29#include "vtkLocatorInterface.h" // for array of (pt,d**2) tuples
30#include "vtkSystemIncludes.h"
31
32VTK_ABI_NAMESPACE_BEGIN
33
35class vtkDoubleArray;
36struct InternalAnnularBinIterator;
37
38// A simple dispatch mechanism to internal, templated classes.
39VTK_WRAPEXCLUDE struct VTKFILTERSMESHING_EXPORT vtkAnnularBinIteratorDispatch
40{
42 InternalAnnularBinIterator* Iterator;
43
45 : LargeIds(false)
46 , Iterator(nullptr)
47 {
48 }
51 bool Begin(vtkIdType pid, double x[3], vtkDist2TupleArray& results);
52 bool Next(double radius2, vtkDoubleArray* spheres, vtkDist2TupleArray& results);
54 void GetBin(int IJ[2]);
55 double GetMinD2();
56}; // vtkAnnularBinIteratorDispatch
57
58// VTK class proper
59class VTKFILTERSMESHING_EXPORT vtkAnnularBinIterator
60{
61public:
66
73 : Dispatch(loc)
74 {
75 }
76
82 void Initialize(vtkStaticPointLocator2D* locator) { this->Dispatch.Initialize(locator); }
83
89 bool Begin(vtkIdType ptId, double x[3], vtkDist2TupleArray& results)
90 {
91 return this->Dispatch.Begin(ptId, x, results);
92 }
93
99 bool Next(double radius2, vtkDoubleArray* circles, vtkDist2TupleArray& results)
100 {
101 return this->Dispatch.Next(radius2, circles, results);
102 }
103
107 vtkIdType GetBinId() { return this->Dispatch.GetBinId(); }
108
112 void GetBin(int IJ[2]) { this->Dispatch.GetBin(IJ); }
113
118 double GetMinD2() { return this->Dispatch.GetMinD2(); }
119
120private:
121 // Used to dispatch to the internally instantiated templated classes.
123};
124
125VTK_ABI_NAMESPACE_END
126
127#endif
128// VTK-HeaderTest-Exclude: vtkAnnularBinIterator.h
vtkAnnularBinIterator(vtkStaticPointLocator2D *loc)
Construct the iterator with a vtkStaticPointLocator2D.
void Initialize(vtkStaticPointLocator2D *locator)
Initialize an iterator with the associated vtkStaticPointLocator2D over which to iterate.
bool Next(double radius2, vtkDoubleArray *circles, vtkDist2TupleArray &results)
Move to the next bin, returning all points that are inside the circle given by x[2] (specified in Beg...
double GetMinD2()
Return the minimum distance of the current annulus of bins to the initial starting point x[2].
vtkAnnularBinIterator()=default
Construct default iterator.
void GetBin(int IJ[2])
Return the current bin/bucket index IJ of traversal.
vtkIdType GetBinId()
Return the current bin/bucket id of traversal.
bool Begin(vtkIdType ptId, double x[3], vtkDist2TupleArray &results)
Begin iterating over the bins, starting with point ptId at position x[3].
dynamic, self-adjusting array of double
quickly locate points in 2-space
vtkAnnularBinIteratorDispatch(vtkStaticPointLocator2D *loc)
InternalAnnularBinIterator * Iterator
bool Next(double radius2, vtkDoubleArray *spheres, vtkDist2TupleArray &results)
bool Begin(vtkIdType pid, double x[3], vtkDist2TupleArray &results)
void Initialize(vtkStaticPointLocator2D *locator)
Represent an array of vtkDist2Tuples.
int vtkIdType
Definition vtkType.h:368
#define VTK_WRAPEXCLUDE