VTK  9.0.1
vtkConvexPointSet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkConvexPointSet.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 =========================================================================*/
30 #ifndef vtkConvexPointSet_h
31 #define vtkConvexPointSet_h
32 
33 #include "vtkCell3D.h"
34 #include "vtkCommonDataModelModule.h" // For export macro
35 
37 class vtkCellArray;
38 class vtkTriangle;
39 class vtkTetra;
40 class vtkDoubleArray;
41 
42 class VTKCOMMONDATAMODEL_EXPORT vtkConvexPointSet : public vtkCell3D
43 {
44 public:
45  static vtkConvexPointSet* New();
46  vtkTypeMacro(vtkConvexPointSet, vtkCell3D);
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
52  virtual int HasFixedTopology() { return 0; }
53 
55 
59  void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
60  {
61  vtkWarningMacro(<< "vtkConvexPointSet::GetEdgePoints Not Implemented");
62  }
63  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
64  VTK_LEGACY(void GetEdgePoints(int vtkNotUsed(edgeId), int*& vtkNotUsed(pts)) override {
65  vtkWarningMacro(<< "vtkConvexPointSet::GetEdgePoints Not Implemented. "
66  << "Also note that this signature is deprecated. "
67  << "Please use GetEdgePoints(vtkIdType, const vtkIdType*& instead");
68  });
69  vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(pts)) override
70  {
71  vtkWarningMacro(<< "vtkConvexPointSet::GetFacePoints Not Implemented");
72  return 0;
73  }
74  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
75  VTK_LEGACY(void GetFacePoints(int vtkNotUsed(faceId), int*& vtkNotUsed(pts)) override {
76  vtkWarningMacro(<< "vtkConvexPointSet::GetFacePoints Not Implemented. "
77  << "Also note that this signature is deprecated. "
78  << "Please use GetFacePoints(vtkIdType, const vtkIdType*& instead");
79  });
81  vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
82  {
83  vtkWarningMacro(<< "vtkConvexPointSet::GetEdgeToAdjacentFaces Not Implemented");
84  }
86  vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(faceIds)) override
87  {
88  vtkWarningMacro(<< "vtkConvexPointSet::GetFaceToAdjacentFaces Not Implemented");
89  return 0;
90  }
92  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(edgeIds)) override
93  {
94  vtkWarningMacro(<< "vtkConvexPointSet::GetPointToIncidentEdges Not Implemented");
95  return 0;
96  }
98  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(faceIds)) override
99  {
100  vtkWarningMacro(<< "vtkConvexPointSet::GetPointToIncidentFaces Not Implemented");
101  return 0;
102  }
104  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(pts)) override
105  {
106  vtkWarningMacro(<< "vtkConvexPointSet::GetPointToOneRingPoints Not Implemented");
107  return 0;
108  }
109  bool GetCentroid(double vtkNotUsed(centroid)[3]) const override
110  {
111  vtkWarningMacro(<< "vtkConvexPointSet::GetCentroid Not Implemented");
112  return 0;
113  }
115 
119  double* GetParametricCoords() override;
120 
124  int GetCellType() override { return VTK_CONVEX_POINT_SET; }
125 
129  int RequiresInitialization() override { return 1; }
130  void Initialize() override;
131 
133 
143  int GetNumberOfEdges() override { return 0; }
144  vtkCell* GetEdge(int) override { return nullptr; }
145  int GetNumberOfFaces() override;
146  vtkCell* GetFace(int faceId) override;
148 
153  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
154  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
155  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
156 
162  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
163  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
164  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
165 
171  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
172  double& dist2, double weights[]) override;
173 
177  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
178 
183  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
184  double pcoords[3], int& subId) override;
185 
189  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
190 
195  void Derivatives(
196  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
197 
203  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
204 
208  int GetParametricCenter(double pcoords[3]) override;
209 
214  int IsPrimaryCell() override { return 0; }
215 
217 
221  void InterpolateFunctions(const double pcoords[3], double* sf) override;
222  void InterpolateDerivs(const double pcoords[3], double* derivs) override;
224 
225 protected:
227  ~vtkConvexPointSet() override;
228 
233 
237 
238 private:
239  vtkConvexPointSet(const vtkConvexPointSet&) = delete;
240  void operator=(const vtkConvexPointSet&) = delete;
241 };
242 
243 //----------------------------------------------------------------------------
244 inline int vtkConvexPointSet::GetParametricCenter(double pcoords[3])
245 {
246  pcoords[0] = pcoords[1] = pcoords[2] = 0.5;
247  return 0;
248 }
249 
250 #endif
void Contour(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override
Generate contouring primitives.
vtkCellArray * BoundaryTris
void GetEdgeToAdjacentFaces(vtkIdType vtkNotUsed(edgeId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
represent and manipulate point attribute data
Definition: vtkPointData.h:31
int GetParametricCenter(double pcoords[3]) override
Return the center of the cell in parametric coordinates.
virtual int GetNumberOfFaces()=0
Return the number of faces in the cell.
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
int RequiresInitialization() override
This cell requires that it be initialized prior to access.
Abstract class in support of both point location and point insertion.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this leve...
Definition: vtkCell.h:341
vtkIdType GetPointToIncidentFaces(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(faceIds)) override
See vtkCell3D API for description of these methods.
vtkDoubleArray * ParametricCoords
int vtkIdType
Definition: vtkType.h:338
vtkIdType GetFaceToAdjacentFaces(vtkIdType vtkNotUsed(faceId), const vtkIdType *&vtkNotUsed(faceIds)) override
See vtkCell3D API for description of these methods.
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts)=0
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition: vtkCell.h:344
dynamic, self-adjusting array of double
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:41
virtual void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts)=0
Get the pair of vertices that define an edge.
abstract class to specify cell behavior
Definition: vtkCell.h:56
vtkDoubleArray * TetraScalars
virtual void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights)=0
Determine global coordinate (x[3]) from subId and parametric coordinates.
vtkTriangle * Triangle
a simple class to control print indentation
Definition: vtkIndent.h:33
list of point or cell ids
Definition: vtkIdList.h:30
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
virtual int HasFixedTopology()
See vtkCell3D API for description of this method.
a 3D cell defined by a set of convex points
int GetCellType() override
See the vtkCell API for descriptions of these methods.
int IsPrimaryCell() override
A convex point set is triangulated prior to any operations on it so it is not a primary cell...
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
virtual int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[])=0
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
object to represent cell connectivity
Definition: vtkCellArray.h:179
void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
a cell that represents a triangle
Definition: vtkTriangle.h:35
virtual void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs)=0
Compute derivatives given cell subId and parametric coordinates.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool GetCentroid(double vtkNotUsed(centroid)[3]) const override
See vtkCell3D API for description of these methods.
virtual void Initialize()
Definition: vtkCell.h:111
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
Intersect with a ray.
vtkIdType GetPointToIncidentEdges(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(edgeIds)) override
See vtkCell3D API for description of these methods.
vtkCell * GetEdge(int) override
A convex point set has no explicit cell edge or faces; however implicitly (after triangulation) it do...
int GetNumberOfEdges() override
A convex point set has no explicit cell edge or faces; however implicitly (after triangulation) it do...
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
Cut (or clip) the cell based on the input cellScalars and the specified value.
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
vtkIdType GetPointToOneRingPoints(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.