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=========================================================================*/
69#ifndef vtkLocator_h
70#define vtkLocator_h
71
72#include "vtkCommonDataModelModule.h" // For export macro
73#include "vtkObject.h"
74
75class vtkDataSet;
76class vtkPolyData;
77
78class VTKCOMMONDATAMODEL_EXPORT vtkLocator : public vtkObject
79{
80public:
82
85 vtkTypeMacro(vtkLocator, vtkObject);
86 void PrintSelf(ostream& os, vtkIndent indent) override;
88
90
93 virtual void SetDataSet(vtkDataSet*);
94 vtkGetObjectMacro(DataSet, vtkDataSet);
96
98
103 vtkSetClampMacro(MaxLevel, int, 0, VTK_INT_MAX);
104 vtkGetMacro(MaxLevel, int);
106
108
113 vtkGetMacro(Level, int);
115
117
123 vtkSetMacro(Automatic, vtkTypeBool);
124 vtkGetMacro(Automatic, vtkTypeBool);
125 vtkBooleanMacro(Automatic, vtkTypeBool);
127
129
133 vtkSetClampMacro(Tolerance, double, 0.0, VTK_DOUBLE_MAX);
134 vtkGetMacro(Tolerance, double);
136
141 virtual void Update();
142
146 virtual void Initialize();
147
151 virtual void BuildLocator() = 0;
152
156 virtual void FreeSearchStructure() = 0;
157
164 virtual void GenerateRepresentation(int level, vtkPolyData* pd) = 0;
165
167
170 vtkGetMacro(BuildTime, vtkMTimeType);
172
174
177 void Register(vtkObjectBase* o) override;
178 void UnRegister(vtkObjectBase* o) override;
180
181protected:
183 ~vtkLocator() override;
184
186 vtkTypeBool Automatic; // boolean controls automatic subdivision (or uses user spec.)
187 double Tolerance; // for performing merging
189 int Level;
190
191 vtkTimeStamp BuildTime; // time at which locator was built
192
194
195private:
196 vtkLocator(const vtkLocator&) = delete;
197 void operator=(const vtkLocator&) = delete;
198};
199
200#endif
abstract class to specify dataset behavior
Definition: vtkDataSet.h:66
Detect and break reference loops.
a simple class to control print indentation
Definition: vtkIndent.h:43
abstract base class for objects that accelerate spatial searches
Definition: vtkLocator.h:79
vtkTypeBool Automatic
Definition: vtkLocator.h:186
void Register(vtkObjectBase *o) override
Handle the PointSet <-> Locator loop.
vtkTimeStamp BuildTime
Definition: vtkLocator.h:191
~vtkLocator() override
virtual void Update()
Cause the locator to rebuild itself if it or its input dataset has changed.
double Tolerance
Definition: vtkLocator.h:187
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:188
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:185
abstract base class for most VTK objects
Definition: vtkObjectBase.h:79
abstract base class for most VTK objects
Definition: vtkObject.h:63
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:95
record modification and/or execution time
Definition: vtkTimeStamp.h:42
@ level
Definition: vtkX3D.h:401
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:39
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