VTK  9.3.0
vtkPointSet.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
43#ifndef vtkPointSet_h
44#define vtkPointSet_h
45
46#include "vtkCommonDataModelModule.h" // For export macro
47#include "vtkDataSet.h"
48
49#include "vtkCellTypes.h" // For GetCellType
50#include "vtkEmptyCell.h" // For GetCell
51#include "vtkGenericCell.h" // For GetCell
52#include "vtkPoints.h" // Needed for inline methods
53
54VTK_ABI_NAMESPACE_BEGIN
57
58class VTKCOMMONDATAMODEL_EXPORT vtkPointSet : public vtkDataSet
59{
60public:
64 static vtkPointSet* New();
66
68
71 vtkTypeMacro(vtkPointSet, vtkDataSet);
72 void PrintSelf(ostream& os, vtkIndent indent) override;
74
78 int GetDataObjectType() override { return VTK_POINT_SET; }
79
81
90 vtkSetMacro(Editable, bool);
91 vtkGetMacro(Editable, bool);
92 vtkBooleanMacro(Editable, bool);
94
98 void Initialize() override;
99
103 void CopyStructure(vtkDataSet* pd) override;
104
106
109 vtkIdType GetNumberOfPoints() override;
110 void GetPoint(vtkIdType ptId, double x[3]) override { this->Points->GetPoint(ptId, x); }
111 vtkIdType FindPoint(double x[3]) override;
112 vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, z); }
113 vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
114 double pcoords[3], double* weights) override;
115 vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
116 double tol2, int& subId, double pcoords[3], double* weights) override;
118
120
123 vtkIdType GetNumberOfCells() override { return 0; }
124 int GetMaxCellSize() override { return 0; }
126
127 using Superclass::GetCell;
133
135
139 void GetCellPoints(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
140 void GetPointCells(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
142
146 void GetCell(vtkIdType, vtkGenericCell* cell) override { cell->SetCellTypeToEmptyCell(); }
147
152 int GetCellType(vtkIdType) override { return VTK_EMPTY_CELL; }
153
158 vtkIdType GetCellSize(vtkIdType) override { return 1; }
159
166 double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override { return this->Points->GetPoint(ptId); }
167
172
174
179 void BuildLocator() { this->BuildPointLocator(); }
181
187
189
196 vtkGetObjectMacro(PointLocator, vtkAbstractPointLocator);
198
200
205 vtkGetObjectMacro(CellLocator, vtkAbstractCellLocator);
207
212
216 void ComputeBounds() override;
217
221 void Squeeze() override;
222
224
227 virtual void SetPoints(vtkPoints*);
228 vtkGetObjectMacro(Points, vtkPoints);
230
239 unsigned long GetActualMemorySize() override;
240
242
245 void ShallowCopy(vtkDataObject* src) override;
246 void DeepCopy(vtkDataObject* src) override;
248
250
253 bool UsesGarbageCollector() const override { return true; }
255
257
263
264protected:
266 ~vtkPointSet() override;
267
272
274
275private:
276 void Cleanup();
277 vtkEmptyCell* EmptyCell;
278
279 vtkPointSet(const vtkPointSet&) = delete;
280 void operator=(const vtkPointSet&) = delete;
281};
282
284{
285 if (this->Points)
286 {
287 return this->Points->GetNumberOfPoints();
288 }
289 else
290 {
291 return 0;
292 }
293}
294
295VTK_ABI_NAMESPACE_END
296#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:50
general representation of visualization data
abstract class to specify dataset behavior
Definition vtkDataSet.h:53
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:233
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:23
void Reset()
Reset to an empty state but retain previously allocated memory.
Definition vtkIdList.h:134
a simple class to control print indentation
Definition vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
concrete class for storing a set of points
Definition vtkPointSet.h:59
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 .
int GetDataObjectType() override
Standard vtkDataSet API methods.
Definition vtkPointSet.h:78
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:29
vtkIdType GetNumberOfPoints() const
Return number of points in array.
Definition vtkPoints.h:121
@ VTK_EMPTY_CELL
Definition vtkCellType.h:37
int vtkIdType
Definition vtkType.h:315
#define VTK_POINT_SET
Definition vtkType.h:74
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270
#define VTK_SIZEHINT(...)