VTK  9.0.1
vtkPolyhedron.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPolyhedron.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 =========================================================================*/
35 #ifndef vtkPolyhedron_h
36 #define vtkPolyhedron_h
37 
38 #include "vtkCell3D.h"
39 #include "vtkCommonDataModelModule.h" // For export macro
40 
41 class vtkIdTypeArray;
42 class vtkCellArray;
43 class vtkTriangle;
44 class vtkQuad;
45 class vtkTetra;
46 class vtkPolygon;
47 class vtkLine;
48 class vtkPointIdMap;
49 class vtkIdToIdVectorMapType;
50 class vtkIdToIdMapType;
51 class vtkEdgeTable;
52 class vtkPolyData;
53 class vtkCellLocator;
54 class vtkGenericCell;
55 class vtkPointLocator;
56 
57 class VTKCOMMONDATAMODEL_EXPORT vtkPolyhedron : public vtkCell3D
58 {
59 public:
61 
64  static vtkPolyhedron* New();
65  vtkTypeMacro(vtkPolyhedron, vtkCell3D);
66  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
70 
74  void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
75  {
76  vtkWarningMacro(<< "vtkPolyhedron::GetEdgePoints Not Implemented");
77  }
78  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
79  VTK_LEGACY(void GetEdgePoints(int vtkNotUsed(edgeId), int*& vtkNotUsed(pts)) override {
80  vtkWarningMacro(<< "vtkPolyhedron::GetEdgePoints Not Implemented. "
81  << "Also note that this signature is deprecated. "
82  << "Please use GetEdgePoints(vtkIdType, const vtkIdType*& instead");
83  });
84  vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(pts)) override
85  {
86  vtkWarningMacro(<< "vtkPolyhedron::GetFacePoints Not Implemented");
87  return 0;
88  }
89  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
90  VTK_LEGACY(void GetFacePoints(int vtkNotUsed(faceId), int*& vtkNotUsed(pts)) override {
91  vtkWarningMacro(<< "vtkPolyhedron::GetFacePoints Not Implemented. "
92  << "Also note that this signature is deprecated. "
93  << "Please use GetFacePoints(vtkIdType, const vtkIdType*& instead");
94  });
96  vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
97  {
98  vtkWarningMacro(<< "vtkPolyhedron::GetEdgeToAdjacentFaces Not Implemented");
99  }
101  vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(faceIds)) override
102  {
103  vtkWarningMacro(<< "vtkPolyhedron::GetFaceToAdjacentFaces Not Implemented");
104  return 0;
105  }
107  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(edgeIds)) override
108  {
109  vtkWarningMacro(<< "vtkPolyhedron::GetPointToIncidentEdges Not Implemented");
110  return 0;
111  }
113  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(faceIds)) override
114  {
115  vtkWarningMacro(<< "vtkPolyhedron::GetPointToIncidentFaces Not Implemented");
116  return 0;
117  }
119  vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(pts)) override
120  {
121  vtkWarningMacro(<< "vtkPolyhedron::GetPointToOneRingPoints Not Implemented");
122  return 0;
123  }
124  bool GetCentroid(double vtkNotUsed(centroid)[3]) const override
125  {
126  vtkWarningMacro(<< "vtkPolyhedron::GetCentroid Not Implemented");
127  return 0;
128  }
130 
134  double* GetParametricCoords() override;
135 
139  int GetCellType() override { return VTK_POLYHEDRON; }
140 
144  int RequiresInitialization() override { return 1; }
145  void Initialize() override;
146 
148 
152  int GetNumberOfEdges() override;
153  vtkCell* GetEdge(int) override;
154  int GetNumberOfFaces() override;
155  vtkCell* GetFace(int faceId) override;
157 
163  void Contour(double value, vtkDataArray* scalars, vtkIncrementalPointLocator* locator,
164  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
165  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
166 
176  void Clip(double value, vtkDataArray* scalars, vtkIncrementalPointLocator* locator,
177  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
178  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
179 
187  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
188  double& dist2, double weights[]) override;
189 
194  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
195 
202  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
203  double pcoords[3], int& subId) override;
204 
220  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
221 
229  void Derivatives(
230  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
231 
236  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
237 
242  int GetParametricCenter(double pcoords[3]) override;
243 
247  int IsPrimaryCell() override { return 1; }
248 
250 
255  void InterpolateFunctions(const double x[3], double* sf) override;
256  void InterpolateDerivs(const double x[3], double* derivs) override;
258 
260 
268  int RequiresExplicitFaceRepresentation() override { return 1; }
269  void SetFaces(vtkIdType* faces) override;
270  vtkIdType* GetFaces() override;
272 
279  int IsInside(const double x[3], double tolerance);
280 
287  bool IsConvex();
288 
292  vtkPolyData* GetPolyData();
293 
294 protected:
295  vtkPolyhedron();
296  ~vtkPolyhedron() override;
297 
298  // Internal classes for supporting operations on this cell
304  vtkIdTypeArray* GlobalFaces; // these are numbered in global id space
306 
307  // vtkCell has the data members Points (x,y,z coordinates) and PointIds
308  // (global cell ids corresponding to cell canonical numbering (0,1,2,....)).
309  // These data members are implicitly organized in canonical space, i.e., where
310  // the cell point ids are (0,1,...,npts-1). The PointIdMap maps global point id
311  // back to these canonoical point ids.
312  vtkPointIdMap* PointIdMap;
313 
314  // If edges are needed. Note that the edge numbering is in
315  // canonical space.
316  int EdgesGenerated; // true/false
317  vtkEdgeTable* EdgeTable; // keep track of all edges
318  vtkIdTypeArray* Edges; // edge pairs kept in this list, in canonical id space
319  vtkIdTypeArray* EdgeFaces; // face pairs that comprise each edge, with the
320  // same ordering as EdgeTable
321  int GenerateEdges(); // method populates the edge table and edge array
322 
323  // If faces need renumbering into canonical numbering space these members
324  // are used. When initiallly loaded, the face numbering uses global dataset
325  // ids. Once renumbered, they are converted to canonical space.
326  vtkIdTypeArray* Faces; // these are numbered in canonical id space
328  void GenerateFaces();
329 
330  // Bounds management
332  void ComputeBounds();
333  void ComputeParametricCoordinate(const double x[3], double pc[3]);
334  void ComputePositionFromParametricCoordinate(const double pc[3], double x[3]);
335 
336  // Members for supporting geometric operations
340  void ConstructPolyData();
343  void ConstructLocator();
346 
347 private:
348  vtkPolyhedron(const vtkPolyhedron&) = delete;
349  void operator=(const vtkPolyhedron&) = delete;
350 };
351 
352 //----------------------------------------------------------------------------
353 inline int vtkPolyhedron::GetParametricCenter(double pcoords[3])
354 {
355  pcoords[0] = pcoords[1] = pcoords[2] = 0.5;
356  return 0;
357 }
358 
359 #endif
vtkCellLocator * CellLocator
vtkTetra * Tetra
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.
vtkPolygon * Polygon
vtkIdType GetPointToOneRingPoints(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
bool GetCentroid(double vtkNotUsed(centroid)[3]) const override
See vtkCell3D API for description of these methods.
represent and manipulate point attribute data
Definition: vtkPointData.h:31
virtual int GetNumberOfFaces()=0
Return the number of faces in the cell.
int RequiresInitialization() override
This cell requires that it be initialized prior to access.
quickly locate points in 3-space
vtkIdTypeArray * GlobalFaces
vtkIdTypeArray * EdgeFaces
vtkQuad * Quad
vtkEdgeTable * EdgeTable
vtkTriangle * Triangle
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
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
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:35
vtkPolyData * PolyData
dynamic, self-adjusting array of vtkIdType
int vtkIdType
Definition: vtkType.h:338
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
provides thread-safe access to cells
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...
vtkIdTypeArray * Faces
keep track of edges (edge is pair of integer id&#39;s)
Definition: vtkEdgeTable.h:40
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
int IsPrimaryCell() override
A polyhedron is a full-fledged primary cell.
vtkIdType GetFaceToAdjacentFaces(vtkIdType vtkNotUsed(faceId), const vtkIdType *&vtkNotUsed(faceIds)) override
See vtkCell3D API for description of these methods.
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.
virtual void SetFaces(vtkIdType *vtkNotUsed(faces))
Definition: vtkCell.h:126
cell represents a 1D line
Definition: vtkLine.h:29
abstract class to specify cell behavior
Definition: vtkCell.h:56
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.
octree-based spatial search object to quickly locate cells
void GetEdgeToAdjacentFaces(vtkIdType vtkNotUsed(edgeId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkPolyhedron.h:95
vtkPointIdMap * PointIdMap
vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkPolyhedron.h:84
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkGenericCell * Cell
vtkLine * Line
list of point or cell ids
Definition: vtkIdList.h:30
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkPolyhedron.h:74
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:39
vtkIdType GetPointToIncidentFaces(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(faceIds)) override
See vtkCell3D API for description of these methods.
vtkIdTypeArray * Edges
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
virtual int GetNumberOfEdges()=0
Return the number of edges in 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...
vtkIdList * CellIds
object to represent cell connectivity
Definition: vtkCellArray.h:179
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
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.
a 3D cell defined by a set of polygonal faces
Definition: vtkPolyhedron.h:57
virtual vtkIdType * GetFaces()
Definition: vtkCell.h:127
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.
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.
vtkIdTypeArray * FaceLocations
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkCellArray * Polys
int GetParametricCenter(double pcoords[3]) override
Return the center of the cell in parametric coordinates.
vtkIdType GetPointToIncidentEdges(vtkIdType vtkNotUsed(pointId), const vtkIdType *&vtkNotUsed(edgeIds)) override
See vtkCell3D API for description of these methods.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
int RequiresExplicitFaceRepresentation() override
Methods supporting the definition of faces.