VTK  9.1.0
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 =========================================================================*/
49 #ifndef vtkConvexPointSet_h
50 #define vtkConvexPointSet_h
51 
52 #include "vtkCell3D.h"
53 #include "vtkCommonDataModelModule.h" // For export macro
54 
56 class vtkCellArray;
57 class vtkTriangle;
58 class vtkTetra;
59 class vtkDoubleArray;
60 
61 class VTKCOMMONDATAMODEL_EXPORT vtkConvexPointSet : public vtkCell3D
62 {
63 public:
65  vtkTypeMacro(vtkConvexPointSet, vtkCell3D);
66  void PrintSelf(ostream& os, vtkIndent indent) override;
67 
71  virtual int HasFixedTopology() { return 0; }
72 
74 
78  void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
79  {
80  vtkWarningMacro(<< "vtkConvexPointSet::GetEdgePoints Not Implemented");
81  }
82  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
84  "Replaced by vtkConvexPointSet::GetEdgePoints(vtkIdType, const vtkIdType*&)")
85  void GetEdgePoints(int vtkNotUsed(edgeId), int*& vtkNotUsed(pts)) override
86  {
87  vtkErrorMacro(<< "vtkConvexPointSet::GetEdgePoints Not Implemented. "
88  "Also note that this signature is deprecated. "
89  "Please use GetEdgePoints(vtkIdType, const vtkIdType*& instead");
90  }
91  vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(pts)) override
92  {
93  vtkWarningMacro(<< "vtkConvexPointSet::GetFacePoints Not Implemented");
94  return 0;
95  }
96  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
98  "Replaced by vtkConvexPointSet::GetFacePoints(vtkIdType, const vtkIdType*&)")
99  void GetFacePoints(int vtkNotUsed(faceId), int*& vtkNotUsed(pts)) override
100  {
101  vtkErrorMacro(<< "vtkConvexPointSet::GetFacePoints Not Implemented. "
102  "Also note that this signature is deprecated. "
103  "Please use GetFacePoints(vtkIdType, const vtkIdType*& instead");
104  }
106  vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
107  {
108  vtkWarningMacro(<< "vtkConvexPointSet::GetEdgeToAdjacentFaces Not Implemented");
109  }
111  vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(faceIds)) override
112  {
113  vtkWarningMacro(<< "vtkConvexPointSet::GetFaceToAdjacentFaces Not Implemented");
114  return 0;
115  }
117  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(edgeIds)) override
118  {
119  vtkWarningMacro(<< "vtkConvexPointSet::GetPointToIncidentEdges Not Implemented");
120  return 0;
121  }
123  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(faceIds)) override
124  {
125  vtkWarningMacro(<< "vtkConvexPointSet::GetPointToIncidentFaces Not Implemented");
126  return 0;
127  }
129  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(pts)) override
130  {
131  vtkWarningMacro(<< "vtkConvexPointSet::GetPointToOneRingPoints Not Implemented");
132  return 0;
133  }
134  bool GetCentroid(double vtkNotUsed(centroid)[3]) const override
135  {
136  vtkWarningMacro(<< "vtkConvexPointSet::GetCentroid Not Implemented");
137  return false;
138  }
140 
144  double* GetParametricCoords() override;
145 
149  int GetCellType() override { return VTK_CONVEX_POINT_SET; }
150 
154  int RequiresInitialization() override { return 1; }
155  void Initialize() override;
156 
158 
168  int GetNumberOfEdges() override { return 0; }
169  vtkCell* GetEdge(int) override { return nullptr; }
170  int GetNumberOfFaces() override;
171  vtkCell* GetFace(int faceId) override;
173 
178  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
179  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
180  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
181 
187  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
188  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
189  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
190 
196  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
197  double& dist2, double weights[]) override;
198 
202  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
203 
208  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
209  double pcoords[3], int& subId) override;
210 
214  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
215 
221  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
222 
228  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
229 
233  int GetParametricCenter(double pcoords[3]) override;
234 
239  int IsPrimaryCell() override { return 0; }
240 
242 
246  void InterpolateFunctions(const double pcoords[3], double* sf) override;
247  void InterpolateDerivs(const double pcoords[3], double* derivs) override;
249 
250 protected:
252  ~vtkConvexPointSet() override;
253 
258 
262 
263 private:
264  vtkConvexPointSet(const vtkConvexPointSet&) = delete;
265  void operator=(const vtkConvexPointSet&) = delete;
266 };
267 
268 //----------------------------------------------------------------------------
269 inline int vtkConvexPointSet::GetParametricCenter(double pcoords[3])
270 {
271  pcoords[0] = pcoords[1] = pcoords[2] = 0.5;
272  return 0;
273 }
274 
275 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:143
vtkConvexPointSet::GetCentroid
bool GetCentroid(double vtkNotUsed(centroid)[3]) const override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:134
vtkConvexPointSet::Derivatives
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Computes derivatives by triangulating and from subId and pcoords, evaluating derivatives on the resul...
vtkConvexPointSet::RequiresInitialization
int RequiresInitialization() override
This cell requires that it be initialized prior to access.
Definition: vtkConvexPointSet.h:154
vtkConvexPointSet::New
static vtkConvexPointSet * New()
vtkConvexPointSet::BoundaryTris
vtkCellArray * BoundaryTris
Definition: vtkConvexPointSet.h:259
vtkConvexPointSet::CellBoundary
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
Returns the set of points forming a face of the triangulation of these points that are on the boundar...
vtkConvexPointSet::Tetra
vtkTetra * Tetra
Definition: vtkConvexPointSet.h:254
vtkConvexPointSet
a 3D cell defined by a set of convex points
Definition: vtkConvexPointSet.h:62
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:142
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkConvexPointSet::vtkConvexPointSet
vtkConvexPointSet()
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkConvexPointSet::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkConvexPointSet::GetFaceToAdjacentFaces
vtkIdType GetFaceToAdjacentFaces(vtkIdType vtkNotUsed(faceId), const vtkIdType *&vtkNotUsed(faceIds)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:110
vtkConvexPointSet::GetParametricCenter
int GetParametricCenter(double pcoords[3]) override
Return the center of the cell in parametric coordinates.
Definition: vtkConvexPointSet.h:269
vtkConvexPointSet::ParametricCoords
vtkDoubleArray * ParametricCoords
Definition: vtkConvexPointSet.h:261
vtkConvexPointSet::Contour
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
Satisfy the vtkCell API.
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
vtkCell3D.h
vtkConvexPointSet::GetPointToIncidentFaces
vtkIdType GetPointToIncidentFaces(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(faceIds)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:122
vtkConvexPointSet::TetraIds
vtkIdList * TetraIds
Definition: vtkConvexPointSet.h:255
vtkConvexPointSet::TetraScalars
vtkDoubleArray * TetraScalars
Definition: vtkConvexPointSet.h:257
vtkConvexPointSet::Clip
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
Satisfy the vtkCell API.
vtkConvexPointSet::TetraPoints
vtkPoints * TetraPoints
Definition: vtkConvexPointSet.h:256
vtkConvexPointSet::GetNumberOfFaces
int GetNumberOfFaces() override
A convex point set has no explicit cell edge or faces; however implicitly (after triangulation) it do...
vtkCell3D
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
VTK_CONVEX_POINT_SET
@ VTK_CONVEX_POINT_SET
Definition: vtkCellType.h:125
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:147
vtkConvexPointSet::InterpolateFunctions
void InterpolateFunctions(const double pcoords[3], double *sf) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
vtkConvexPointSet::Triangle
vtkTriangle * Triangle
Definition: vtkConvexPointSet.h:260
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:142
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkConvexPointSet::EvaluateLocation
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
The inverse of EvaluatePosition.
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:290
VTK_DEPRECATED_IN_9_0_0
#define VTK_DEPRECATED_IN_9_0_0(reason)
Definition: vtkDeprecation.h:126
vtkConvexPointSet::~vtkConvexPointSet
~vtkConvexPointSet() override
vtkConvexPointSet::GetEdgePoints
void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:78
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:52
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:140
vtkConvexPointSet::IsPrimaryCell
int IsPrimaryCell() override
A convex point set is triangulated prior to any operations on it so it is not a primary cell,...
Definition: vtkConvexPointSet.h:239
vtkConvexPointSet::HasFixedTopology
virtual int HasFixedTopology()
See vtkCell3D API for description of this method.
Definition: vtkConvexPointSet.h:71
vtkTriangle
a cell that represents a triangle
Definition: vtkTriangle.h:145
vtkConvexPointSet::InterpolateDerivs
void InterpolateDerivs(const double pcoords[3], double *derivs) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
vtkConvexPointSet::GetPointToIncidentEdges
vtkIdType GetPointToIncidentEdges(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(edgeIds)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:116
vtkConvexPointSet::GetEdge
vtkCell * GetEdge(int) override
A convex point set has no explicit cell edge or faces; however implicitly (after triangulation) it do...
Definition: vtkConvexPointSet.h:169
vtkConvexPointSet::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkConvexPointSet.h:149
vtkConvexPointSet::GetParametricCoords
double * GetParametricCoords() override
See vtkCell3D API for description of this method.
vtkConvexPointSet::GetFace
vtkCell * GetFace(int faceId) override
A convex point set has no explicit cell edge or faces; however implicitly (after triangulation) it do...
vtkConvexPointSet::Initialize
void Initialize() override
vtkCell::GetParametricCenter
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:145
vtkConvexPointSet::GetPointToOneRingPoints
vtkIdType GetPointToOneRingPoints(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:128
vtkUnstructuredGrid
dataset represents arbitrary combinations of all possible cell types
Definition: vtkUnstructuredGrid.h:204
vtkConvexPointSet::EvaluatePosition
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
Satisfy the vtkCell API.
vtkTetra
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:111
vtkConvexPointSet::IntersectWithLine
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
Triangulates the cells and then intersects them to determine the intersection point.
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkConvexPointSet::GetEdgeToAdjacentFaces
void GetEdgeToAdjacentFaces(vtkIdType vtkNotUsed(edgeId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:105
vtkConvexPointSet::GetFacePoints
vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkConvexPointSet.h:91
vtkConvexPointSet::GetNumberOfEdges
int GetNumberOfEdges() override
A convex point set has no explicit cell edge or faces; however implicitly (after triangulation) it do...
Definition: vtkConvexPointSet.h:168
vtkConvexPointSet::Triangulate
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Triangulate using methods of vtkOrderedTriangulator.