VTK  9.1.0
vtkPyramid.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPyramid.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=========================================================================*/
90#ifndef vtkPyramid_h
91#define vtkPyramid_h
92
93#include "vtkCell3D.h"
94#include "vtkCommonDataModelModule.h" // For export macro
95
96class vtkLine;
97class vtkQuad;
98class vtkTriangle;
101
102class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
103{
104public:
105 static vtkPyramid* New();
106 vtkTypeMacro(vtkPyramid, vtkCell3D);
107 void PrintSelf(ostream& os, vtkIndent indent) override;
108
110
113 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
114 // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
115 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkPyramid::GetEdgePoints(vtkIdType, const vtkIdType*&)")
116 void GetEdgePoints(int edgeId, int*& pts) override;
117 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
118 // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
119 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkPyramid::GetFacePoints(vtkIdType, const vtkIdType*&)")
120 void GetFacePoints(int faceId, int*& pts) override;
121 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
122 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
123 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
124 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
125 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
126 bool GetCentroid(double centroid[3]) const override;
127 bool IsInsideOut() override;
129
133 static constexpr vtkIdType NumberOfPoints = 5;
134
138 static constexpr vtkIdType NumberOfEdges = 8;
139
143 static constexpr vtkIdType NumberOfFaces = 5;
144
149 static constexpr vtkIdType MaximumFaceSize = 4;
150
156 static constexpr vtkIdType MaximumValence = 4;
158
161 int GetCellType() override { return VTK_PYRAMID; }
162 int GetCellDimension() override { return 3; }
163 int GetNumberOfEdges() override { return 8; }
164 int GetNumberOfFaces() override { return 5; }
165 vtkCell* GetEdge(int edgeId) override;
166 vtkCell* GetFace(int faceId) override;
167 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
168 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
169 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
170 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
171 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
172 double& dist2, double weights[]) override;
173 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
174 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
175 double pcoords[3], int& subId) override;
176 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
178 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
179 double* GetParametricCoords() override;
181
189 static int* GetTriangleCases(int caseId);
190
194 int GetParametricCenter(double pcoords[3]) override;
195
196 static void InterpolationFunctions(const double pcoords[3], double weights[5]);
197 static void InterpolationDerivs(const double pcoords[3], double derivs[15]);
199
203 void InterpolateFunctions(const double pcoords[3], double weights[5]) override
204 {
205 vtkPyramid::InterpolationFunctions(pcoords, weights);
206 }
207 void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
208 {
209 vtkPyramid::InterpolationDerivs(pcoords, derivs);
210 }
212
213 int JacobianInverse(const double pcoords[3], double** inverse, double derivs[15]);
214
216
227
232
237
242
247
252
256 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
257
258protected:
260 ~vtkPyramid() override;
261
265
266private:
267 vtkPyramid(const vtkPyramid&) = delete;
268 void operator=(const vtkPyramid&) = delete;
269};
270
271//----------------------------------------------------------------------------
272inline int vtkPyramid::GetParametricCenter(double pcoords[3])
273{
274 pcoords[0] = pcoords[1] = 0.4;
275 pcoords[2] = 0.2;
276 return 0;
277}
278
279#endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
object to represent cell connectivity
Definition: vtkCellArray.h:290
represent and manipulate cell attribute data
Definition: vtkCellData.h:142
abstract class to specify cell behavior
Definition: vtkCell.h:147
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
list of point or cell ids
Definition: vtkIdList.h:140
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:113
cell represents a 1D line
Definition: vtkLine.h:140
represent and manipulate point attribute data
Definition: vtkPointData.h:142
represent and manipulate 3D points
Definition: vtkPoints.h:143
a 3D cell that represents a linear pyramid
Definition: vtkPyramid.h:103
int GetParametricCenter(double pcoords[3]) override
Return the center of the pyramid in parametric coordinates.
Definition: vtkPyramid.h:272
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
static vtkPyramid * New()
vtkQuad * Quad
Definition: vtkPyramid.h:264
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
See the vtkCell API for descriptions of these methods.
vtkTriangle * Triangle
Definition: vtkPyramid.h:263
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
See the vtkCell API for descriptions of these methods.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
~vtkPyramid() override
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkPyramid.h:207
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:163
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLine * Line
Definition: vtkPyramid.h:262
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
int JacobianInverse(const double pcoords[3], double **inverse, double derivs[15])
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:162
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:164
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
See the vtkCell API for descriptions of these methods.
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
See the vtkCell API for descriptions of these methods.
static void InterpolationFunctions(const double pcoords[3], double weights[5])
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
static void InterpolationDerivs(const double pcoords[3], double derivs[15])
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
void InterpolateFunctions(const double pcoords[3], double weights[5]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkPyramid.h:203
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:95
a cell that represents a triangle
Definition: vtkTriangle.h:145
dataset represents arbitrary combinations of all possible cell types
@ VTK_PYRAMID
Definition: vtkCellType.h:99
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)