VTK  9.0.20200529
vtkAbstractPointLocator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAbstractPointLocator.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 =========================================================================*/
30 #ifndef vtkAbstractPointLocator_h
31 #define vtkAbstractPointLocator_h
32 
33 #include "vtkCommonDataModelModule.h" // For export macro
34 #include "vtkLocator.h"
35 
36 class vtkIdList;
37 
38 class VTKCOMMONDATAMODEL_EXPORT vtkAbstractPointLocator : public vtkLocator
39 {
40 public:
42 
46  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
50 
56  virtual vtkIdType FindClosestPoint(const double x[3]) = 0;
57  vtkIdType FindClosestPoint(double x, double y, double z);
59 
65  virtual vtkIdType FindClosestPointWithinRadius(
66  double radius, const double x[3], double& dist2) = 0;
67 
69 
77  virtual void FindClosestNPoints(int N, const double x[3], vtkIdList* result) = 0;
78  void FindClosestNPoints(int N, double x, double y, double z, vtkIdList* result);
80 
82 
88  virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) = 0;
89  void FindPointsWithinRadius(double R, double x, double y, double z, vtkIdList* result);
91 
93 
96  virtual double* GetBounds() { return this->Bounds; }
97  virtual void GetBounds(double*);
99 
101 
105  vtkGetMacro(NumberOfBuckets, vtkIdType);
107 
108 protected:
110  ~vtkAbstractPointLocator() override;
111 
112  double Bounds[6]; // bounds of points
113  vtkIdType NumberOfBuckets; // total size of locator
114 
115 private:
117  void operator=(const vtkAbstractPointLocator&) = delete;
118 };
119 
120 #endif
vtkIdType
int vtkIdType
Definition: vtkType.h:330
vtkAbstractPointLocator::GetBounds
virtual double * GetBounds()
Provide an accessor to the bounds.
Definition: vtkAbstractPointLocator.h:96
vtkLocator.h
vtkAbstractPointLocator::NumberOfBuckets
vtkIdType NumberOfBuckets
Definition: vtkAbstractPointLocator.h:113
vtkLocator
abstract base class for objects that accelerate spatial searches
Definition: vtkLocator.h:69
vtkBlockSortHelper::GetBounds
void GetBounds(T a, double bds[6])
Definition: vtkBlockSortHelper.h:37
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkLocator::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractPointLocator
abstract class to quickly locate points in 3-space
Definition: vtkAbstractPointLocator.h:38
vtkX3D::radius
Definition: vtkX3D.h:258