VTK  9.1.0
vtkLocator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLocator.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=========================================================================*/
79#ifndef vtkLocator_h
80#define vtkLocator_h
81
82#include "vtkCommonDataModelModule.h" // For export macro
83#include "vtkObject.h"
84
85class vtkDataSet;
86class vtkPolyData;
87
88class VTKCOMMONDATAMODEL_EXPORT vtkLocator : public vtkObject
89{
90public:
92
95 vtkTypeMacro(vtkLocator, vtkObject);
96 void PrintSelf(ostream& os, vtkIndent indent) override;
98
100
103 virtual void SetDataSet(vtkDataSet*);
104 vtkGetObjectMacro(DataSet, vtkDataSet);
106
108
113 vtkSetClampMacro(MaxLevel, int, 0, VTK_INT_MAX);
114 vtkGetMacro(MaxLevel, int);
116
118
123 vtkGetMacro(Level, int);
125
127
133 vtkSetMacro(Automatic, vtkTypeBool);
134 vtkGetMacro(Automatic, vtkTypeBool);
135 vtkBooleanMacro(Automatic, vtkTypeBool);
137
139
143 vtkSetClampMacro(Tolerance, double, 0.0, VTK_DOUBLE_MAX);
144 vtkGetMacro(Tolerance, double);
146
151 virtual void Update();
152
156 virtual void Initialize();
157
161 virtual void BuildLocator() = 0;
162
166 virtual void FreeSearchStructure() = 0;
167
174 virtual void GenerateRepresentation(int level, vtkPolyData* pd) = 0;
175
177
180 vtkGetMacro(BuildTime, vtkMTimeType);
182
184
187 void Register(vtkObjectBase* o) override;
188 void UnRegister(vtkObjectBase* o) override;
190
191protected:
193 ~vtkLocator() override;
194
196 vtkTypeBool Automatic; // boolean controls automatic subdivision (or uses user spec.)
197 double Tolerance; // for performing merging
199 int Level;
200
201 vtkTimeStamp BuildTime; // time at which locator was built
202
204
205private:
206 vtkLocator(const vtkLocator&) = delete;
207 void operator=(const vtkLocator&) = delete;
208};
209
210#endif
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
Detect and break reference loops.
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for objects that accelerate spatial searches
Definition: vtkLocator.h:89
vtkTypeBool Automatic
Definition: vtkLocator.h:196
void Register(vtkObjectBase *o) override
Handle the PointSet <-> Locator loop.
vtkTimeStamp BuildTime
Definition: vtkLocator.h:201
~vtkLocator() override
virtual void Update()
Cause the locator to rebuild itself if it or its input dataset has changed.
double Tolerance
Definition: vtkLocator.h:197
virtual void SetDataSet(vtkDataSet *)
Build the locator from the points/cells defining this dataset.
void UnRegister(vtkObjectBase *o) override
Handle the PointSet <-> Locator loop.
virtual void Initialize()
Initialize locator.
int MaxLevel
Definition: vtkLocator.h:198
void PrintSelf(ostream &os, vtkIndent indent) override
Standard type and print methods.
void ReportReferences(vtkGarbageCollector *) override
virtual void GenerateRepresentation(int level, vtkPolyData *pd)=0
Method to build a representation at a particular level.
virtual void BuildLocator()=0
Build the locator from the input dataset.
virtual void FreeSearchStructure()=0
Free the memory required for the spatial data structure.
vtkDataSet * DataSet
Definition: vtkLocator.h:195
abstract base class for most VTK objects
Definition: vtkObjectBase.h:70
abstract base class for most VTK objects
Definition: vtkObject.h:82
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:195
record modification and/or execution time
Definition: vtkTimeStamp.h:52
int vtkTypeBool
Definition: vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
#define VTK_DOUBLE_MAX
Definition: vtkType.h:165
#define VTK_INT_MAX
Definition: vtkType.h:155