VTK  9.2.6
vtkPointSet.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPointSet.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=========================================================================*/
51
52#ifndef vtkPointSet_h
53#define vtkPointSet_h
54
55#include "vtkCommonDataModelModule.h" // For export macro
56#include "vtkDataSet.h"
57
58#include "vtkCellTypes.h" // For GetCellType
59#include "vtkEmptyCell.h" // For GetCell
60#include "vtkGenericCell.h" // For GetCell
61#include "vtkPoints.h" // Needed for inline methods
62
65
66class VTKCOMMONDATAMODEL_EXPORT vtkPointSet : public vtkDataSet
67{
68public:
72 static vtkPointSet* New();
74
76
79 vtkTypeMacro(vtkPointSet, vtkDataSet);
80 void PrintSelf(ostream& os, vtkIndent indent) override;
82
84
93 vtkSetMacro(Editable, bool);
94 vtkGetMacro(Editable, bool);
95 vtkBooleanMacro(Editable, bool);
97
101 void Initialize() override;
102
106 void CopyStructure(vtkDataSet* pd) override;
107
109
112 vtkIdType GetNumberOfPoints() override;
113 void GetPoint(vtkIdType ptId, double x[3]) override { this->Points->GetPoint(ptId, x); }
114 vtkIdType FindPoint(double x[3]) override;
115 vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, z); }
116 vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
117 double pcoords[3], double* weights) override;
118 vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
119 double tol2, int& subId, double pcoords[3], double* weights) override;
121
123
126 vtkIdType GetNumberOfCells() override { return 0; }
127 int GetMaxCellSize() override { return 0; }
129
130 using Superclass::GetCell;
135 vtkCell* GetCell(vtkIdType) override { return this->EmptyCell; }
136
138
142 void GetCellPoints(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
143 void GetPointCells(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
145
149 void GetCell(vtkIdType, vtkGenericCell* cell) override { cell->SetCellTypeToEmptyCell(); }
150
155 int GetCellType(vtkIdType) override { return VTK_EMPTY_CELL; }
156
161 vtkIdType GetCellSize(vtkIdType) override { return 1; }
162
169 double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override { return this->Points->GetPoint(ptId); }
170
175
177
182 void BuildLocator() { this->BuildPointLocator(); }
184
190
192
201
203
210
215
219 void ComputeBounds() override;
220
224 void Squeeze() override;
225
227
230 virtual void SetPoints(vtkPoints*);
231 vtkGetObjectMacro(Points, vtkPoints);
233
242 unsigned long GetActualMemorySize() override;
243
245
248 void ShallowCopy(vtkDataObject* src) override;
249 void DeepCopy(vtkDataObject* src) override;
251
253
256 bool UsesGarbageCollector() const override { return true; }
258
260
266
267protected:
269 ~vtkPointSet() override;
270
275
277
278private:
279 void Cleanup();
280 vtkEmptyCell* EmptyCell;
281
282 vtkPointSet(const vtkPointSet&) = delete;
283 void operator=(const vtkPointSet&) = delete;
284};
285
287{
288 if (this->Points)
289 {
290 return this->Points->GetNumberOfPoints();
291 }
292 else
293 {
294 return 0;
295 }
296}
297
298#endif
an abstract base class for locators which find cells
abstract class to quickly locate points in 3-space
Efficient cell iterator for vtkDataSet topologies.
abstract class to specify cell behavior
Definition vtkCell.h:58
virtual vtkIdType GetNumberOfPoints()=0
Determine the number of points composing the dataset.
virtual void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds)=0
Topological inquiry to get points defining cell.
vtkIdType FindPoint(double x, double y, double z)
Locate the closest point to the global coordinate x.
Definition vtkDataSet.h:226
an empty cell used as a place-holder during processing
Detect and break reference loops.
provides thread-safe access to cells
void SetCellTypeToEmptyCell()
list of point or cell ids
Definition vtkIdList.h:31
void Reset()
Reset to an empty state but retain previously allocated memory.
Definition vtkIdList.h:145
a simple class to control print indentation
Definition vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
void GetCellPoints(vtkIdType, vtkIdList *idList) override
This method resets parameter idList, as there is no cell in a vtkPointSet.
void CopyStructure(vtkDataSet *pd) override
Copy the geometric structure of an input point set object.
void Initialize() override
Reset to an empty state and free any memory.
vtkIdType FindPoint(double x, double y, double z)
See vtkDataSet for additional information.
void GetPointCells(vtkIdType, vtkIdList *idList) override
This method resets parameter idList, as there is no cell in a vtkPointSet.
virtual void SetCellLocator(vtkAbstractCellLocator *)
Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is us...
static vtkPointSet * ExtendedNew()
void BuildPointLocator()
Build the internal point locator .
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for type information and printing.
virtual void SetPoints(vtkPoints *)
Specify point array to define point coordinates.
~vtkPointSet() override
virtual void SetPointLocator(vtkAbstractPointLocator *)
Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCel...
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
bool UsesGarbageCollector() const override
Overwritten to handle the data/locator loop.
vtkIdType GetCellSize(vtkIdType) override
This method always returns 1, as all cells are point in a pure vtkPointSet.
vtkCellIterator * NewCellIterator() override
Return an iterator that traverses the cells in this data set.
void Squeeze() override
Reclaim any unused memory.
vtkIdType FindPoint(double x[3]) override
See vtkDataSet for additional information.
static vtkPointSet * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
static vtkPointSet * New()
Standard instantiation method.
vtkIdType FindCell(double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
See vtkDataSet for additional information.
vtkAbstractPointLocator * PointLocator
void BuildLocator()
Build the internal point locator .
vtkIdType FindCell(double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
See vtkDataSet for additional information.
vtkAbstractCellLocator * CellLocator
void BuildCellLocator()
Build the cell locator.
void ComputeBounds() override
Compute the (X, Y, Z) bounds of the data.
vtkPoints * Points
vtkIdType GetNumberOfCells() override
This method always returns 0, as there are no cells in a vtkPointSet.
static vtkPointSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkIdType GetNumberOfPoints() override
See vtkDataSet for additional information.
vtkMTimeType GetMTime() override
Get MTime which also considers its vtkPoints MTime.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
void GetPoint(vtkIdType ptId, double x[3]) override
See vtkDataSet for additional information.
void ReportReferences(vtkGarbageCollector *) override
void GetCell(vtkIdType, vtkGenericCell *cell) override
This method sets cell to be an empty cell.
vtkCell * GetCell(vtkIdType) override
This method always return a vtkEmptyCell, as there is no cell in a vtkPointSet.
int GetCellType(vtkIdType) override
This method always returns VTK_EMPTY_CELL, as there is no cell in a vtkPointSet.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
int GetMaxCellSize() override
This method always returns 0, as there are no cells in a vtkPointSet.
double * GetPoint(vtkIdType ptId) override
See vtkDataSet for additional information.
represent and manipulate 3D points
Definition vtkPoints.h:34
@ VTK_EMPTY_CELL
Definition vtkCellType.h:46
int vtkIdType
Definition vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)