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=========================================================================*/
55#ifndef vtkPointSet_h
56#define vtkPointSet_h
57
58#include "vtkCommonDataModelModule.h" // For export macro
59#include "vtkDataSet.h"
60
61#include "vtkCellTypes.h" // For GetCellType
62#include "vtkEmptyCell.h" // For GetCell
63#include "vtkGenericCell.h" // For GetCell
64#include "vtkPoints.h" // Needed for inline methods
65
68
69class VTKCOMMONDATAMODEL_EXPORT vtkPointSet : public vtkDataSet
70{
71public:
75 static vtkPointSet* New();
77
79
82 vtkTypeMacro(vtkPointSet, vtkDataSet);
83 void PrintSelf(ostream& os, vtkIndent indent) override;
85
87
96 vtkSetMacro(Editable, bool);
97 vtkGetMacro(Editable, bool);
98 vtkBooleanMacro(Editable, bool);
100
104 void Initialize() override;
105
109 void CopyStructure(vtkDataSet* pd) override;
110
112
115 vtkIdType GetNumberOfPoints() override;
116 void GetPoint(vtkIdType ptId, double x[3]) override { this->Points->GetPoint(ptId, x); }
117 vtkIdType FindPoint(double x[3]) override;
118 vtkIdType FindPoint(double x, double y, double z) { return this->vtkDataSet::FindPoint(x, y, z); }
119 vtkIdType FindCell(double x[3], vtkCell* cell, vtkIdType cellId, double tol2, int& subId,
120 double pcoords[3], double* weights) override;
121 vtkIdType FindCell(double x[3], vtkCell* cell, vtkGenericCell* gencell, vtkIdType cellId,
122 double tol2, int& subId, double pcoords[3], double* weights) override;
124
126
129 vtkIdType GetNumberOfCells() override { return 0; }
130 int GetMaxCellSize() override { return 0; }
132
133 using Superclass::GetCell;
138 vtkCell* GetCell(vtkIdType) override { return this->EmptyCell; }
139
141
145 void GetCellPoints(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
146 void GetPointCells(vtkIdType, vtkIdList* idList) override { idList->Reset(); }
148
152 void GetCell(vtkIdType, vtkGenericCell* cell) override { cell->SetCellTypeToEmptyCell(); }
153
158 int GetCellType(vtkIdType) override { return VTK_EMPTY_CELL; }
159
164 vtkIdType GetCellSize(vtkIdType) override { return 1; }
165
172 double* GetPoint(vtkIdType ptId) VTK_SIZEHINT(3) override { return this->Points->GetPoint(ptId); }
173
178
180
185 void BuildLocator() { this->BuildPointLocator(); }
187
193
195
202 vtkGetObjectMacro(PointLocator, vtkAbstractPointLocator);
204
206
211 vtkGetObjectMacro(CellLocator, vtkAbstractCellLocator);
213
218
222 void ComputeBounds() override;
223
227 void Squeeze() override;
228
230
233 virtual void SetPoints(vtkPoints*);
234 vtkGetObjectMacro(Points, vtkPoints);
236
245 unsigned long GetActualMemorySize() override;
246
248
251 void ShallowCopy(vtkDataObject* src) override;
252 void DeepCopy(vtkDataObject* src) override;
254
256
259 bool UsesGarbageCollector() const override { return true; }
261
263
269
270protected:
272 ~vtkPointSet() override;
273
278
280
281private:
282 void Cleanup();
283 vtkEmptyCell* EmptyCell;
284
285 vtkPointSet(const vtkPointSet&) = delete;
286 void operator=(const vtkPointSet&) = delete;
287};
288
290{
291 if (this->Points)
292 {
293 return this->Points->GetNumberOfPoints();
294 }
295 else
296 {
297 return 0;
298 }
299}
300
301#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:61
general representation of visualization data
abstract class to specify dataset behavior
Definition vtkDataSet.h:63
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:232
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:34
void Reset()
Reset to an empty state but retain previously allocated memory.
Definition vtkIdList.h:148
a simple class to control print indentation
Definition vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
concrete class for storing a set of points
Definition vtkPointSet.h:70
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:40
vtkIdType GetNumberOfPoints() const
Return number of points in array.
Definition vtkPoints.h:132
@ VTK_EMPTY_CELL
Definition vtkCellType.h:46
int vtkIdType
Definition vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)