VTK
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 "vtkCommonDataModelModule.h" // For export macro
39 #include "vtkCell3D.h"
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) VTK_OVERRIDE;
68 
72  void GetEdgePoints(int vtkNotUsed(edgeId), int* &vtkNotUsed(pts)) VTK_OVERRIDE {}
73  void GetFacePoints(int vtkNotUsed(faceId), int* &vtkNotUsed(pts)) VTK_OVERRIDE {}
74  double *GetParametricCoords() VTK_OVERRIDE;
75 
79  int GetCellType() VTK_OVERRIDE {return VTK_POLYHEDRON;}
80 
84  int RequiresInitialization() VTK_OVERRIDE {return 1;}
85  void Initialize() VTK_OVERRIDE;
86 
88 
92  int GetNumberOfEdges() VTK_OVERRIDE;
93  vtkCell *GetEdge(int) VTK_OVERRIDE;
94  int GetNumberOfFaces() VTK_OVERRIDE;
95  vtkCell *GetFace(int faceId) VTK_OVERRIDE;
97 
103  void Contour(double value, vtkDataArray *scalars,
104  vtkIncrementalPointLocator *locator, vtkCellArray *verts,
105  vtkCellArray *lines, vtkCellArray *polys,
106  vtkPointData *inPd, vtkPointData *outPd,
107  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) VTK_OVERRIDE;
108 
118  void Clip(double value, vtkDataArray *scalars,
119  vtkIncrementalPointLocator *locator, vtkCellArray *connectivity,
120  vtkPointData *inPd, vtkPointData *outPd,
121  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd,
122  int insideOut) VTK_OVERRIDE;
123 
131  int EvaluatePosition(double x[3], double* closestPoint,
132  int& subId, double pcoords[3],
133  double& dist2, double *weights) VTK_OVERRIDE;
134 
139  void EvaluateLocation(int& subId, double pcoords[3], double x[3],
140  double *weights) VTK_OVERRIDE;
141 
148  int IntersectWithLine(double p1[3], double p2[3], double tol, double& t,
149  double x[3], double pcoords[3], int& subId) VTK_OVERRIDE;
150 
166  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) VTK_OVERRIDE;
167 
175  void Derivatives(int subId, double pcoords[3], double *values,
176  int dim, double *derivs) VTK_OVERRIDE;
177 
182  int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) VTK_OVERRIDE;
183 
188  int GetParametricCenter(double pcoords[3]) VTK_OVERRIDE;
189 
193  int IsPrimaryCell() VTK_OVERRIDE {return 1;}
194 
196 
201  void InterpolateFunctions(double x[3], double *sf) VTK_OVERRIDE;
202  void InterpolateDerivs(double x[3], double *derivs) VTK_OVERRIDE;
204 
206 
214  int RequiresExplicitFaceRepresentation() VTK_OVERRIDE {return 1;}
215  void SetFaces(vtkIdType *faces) VTK_OVERRIDE;
216  vtkIdType *GetFaces() VTK_OVERRIDE;
218 
225  int IsInside(double x[3], double tolerance);
226 
233  bool IsConvex();
234 
238  vtkPolyData* GetPolyData();
239 
240 protected:
241  vtkPolyhedron();
242  ~vtkPolyhedron() VTK_OVERRIDE;
243 
244  // Internal classes for supporting operations on this cell
245  vtkLine *Line;
246  vtkTriangle *Triangle;
247  vtkQuad *Quad;
248  vtkPolygon *Polygon;
249  vtkTetra *Tetra;
250  vtkIdTypeArray *GlobalFaces; //these are numbered in gloabl id space
251  vtkIdTypeArray *FaceLocations;
252 
253  // vtkCell has the data members Points (x,y,z coordinates) and PointIds
254  // (global cell ids corresponding to cell canonical numbering (0,1,2,....)).
255  // These data members are implicitly organized in canonical space, i.e., where
256  // the cell point ids are (0,1,...,npts-1). The PointIdMap maps global point id
257  // back to these canonoical point ids.
258  vtkPointIdMap *PointIdMap;
259 
260  // If edges are needed. Note that the edge numbering is in
261  // canonical space.
262  int EdgesGenerated; //true/false
263  vtkEdgeTable *EdgeTable; //keep track of all edges
264  vtkIdTypeArray *Edges; //edge pairs kept in this list, in canonical id space
265  vtkIdTypeArray *EdgeFaces; // face pairs that comprise each edge, with the
266  // same ordering as EdgeTable
267  int GenerateEdges(); //method populates the edge table and edge array
268 
269  // If faces need renumbering into canonical numbering space these members
270  // are used. When initiallly loaded, the face numbering uses global dataset
271  // ids. Once renumbered, they are converted to canonical space.
272  vtkIdTypeArray *Faces; //these are numbered in canonical id space
273  int FacesGenerated;
274  void GenerateFaces();
275 
276  // Bounds management
277  int BoundsComputed;
278  void ComputeBounds();
279  void ComputeParametricCoordinate(double x[3], double pc[3]);
280  void ComputePositionFromParametricCoordinate(double pc[3], double x[3]);
281 
282  // Members for supporting geometric operations
283  int PolyDataConstructed;
284  vtkPolyData *PolyData;
285  vtkCellArray *Polys;
286  vtkIdTypeArray *PolyConnectivity;
287  void ConstructPolyData();
288  int LocatorConstructed;
289  vtkCellLocator *CellLocator;
290  void ConstructLocator();
291  vtkIdList *CellIds;
293 
294  // This is the internal implementation of contouring a polyhedron. It is used
295  // by both Clip and Contour functions.
296  int InternalContour(double value,
297  int insideOut,
299  vtkDataArray *inScalars,
300  vtkDataArray *outScalars,
301  vtkPointData *inPd,
302  vtkPointData *outPd,
303  vtkCellArray *contourPolys,
304  vtkIdToIdVectorMapType & faceToPointsMap,
305  vtkIdToIdVectorMapType & pointToFacesMap,
306  vtkIdToIdMapType & pointIdMap);
307 
308 
309  // Check if the polyhedron cell intersect with the contour/clip function.
310  // If intersect, return 0. Otherwise return 1 or -1 when the polyhedron cell
311  // is on the positive or negative side of contour/clip function respectively.
312  int IntersectWithContour(double value,
313  int insideOut,
314  vtkDataArray *inScalars);
315 
316 private:
317  vtkPolyhedron(const vtkPolyhedron&) VTK_DELETE_FUNCTION;
318  void operator=(const vtkPolyhedron&) VTK_DELETE_FUNCTION;
319 
320  class vtkInternal;
321  vtkInternal * Internal;
322 
323 };
324 
325 //----------------------------------------------------------------------------
326 inline int vtkPolyhedron::GetParametricCenter(double pcoords[3])
327 {
328  pcoords[0] = pcoords[1] = pcoords[2] = 0.5;
329  return 0;
330 }
331 
332 #endif
represent and manipulate point attribute data
Definition: vtkPointData.h:31
int RequiresInitialization() override
This cell requires that it be initialized prior to access.
Definition: vtkPolyhedron.h:84
quickly locate points in 3-space
void GetFacePoints(int vtkNotUsed(faceId), int *&vtkNotUsed(pts)) override
Definition: vtkPolyhedron.h:73
virtual void InterpolateFunctions(double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this leve...
Definition: vtkCell.h:352
virtual double * GetParametricCoords()
Return a contiguous array of parametric coordinates of the points defining this cell.
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
Abstract class in support of both point location and point insertion.
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:35
dynamic, self-adjusting array of vtkIdType
int vtkIdType
Definition: vtkType.h:345
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
provides thread-safe access to cells
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
keep track of edges (edge is pair of integer id's)
Definition: vtkEdgeTable.h:40
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:41
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
octree-based spatial search object to quickly locate cells
void GetEdgePoints(int vtkNotUsed(edgeId), int *&vtkNotUsed(pts)) override
See vtkCell3D API for description of these methods.
Definition: vtkPolyhedron.h:72
a simple class to control print indentation
Definition: vtkIndent.h:33
list of point or cell ids
Definition: vtkIdList.h:30
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:39
virtual void InterpolateDerivs(double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition: vtkCell.h:355
object to represent cell connectivity
Definition: vtkCellArray.h:44
a cell that represents a triangle
Definition: vtkTriangle.h:35
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...
represent and manipulate 3D points
Definition: vtkPoints.h:33
int RequiresExplicitFaceRepresentation() override
Methods supporting the definition of faces.