VTK  9.2.6
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=========================================================================*/
30
31#ifndef vtkPyramid_h
32#define vtkPyramid_h
33
34#include "vtkCell3D.h"
35#include "vtkCommonDataModelModule.h" // For export macro
36
37class vtkLine;
38class vtkQuad;
39class vtkTriangle;
42
43class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
44{
45public:
46 static vtkPyramid* New();
47 vtkTypeMacro(vtkPyramid, vtkCell3D);
48 void PrintSelf(ostream& os, vtkIndent indent) override;
49
51
54 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
55 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
56 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
57 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
58 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
59 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
60 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
61 bool GetCentroid(double centroid[3]) const override;
62 bool IsInsideOut() override;
64
68 static constexpr vtkIdType NumberOfPoints = 5;
69
73 static constexpr vtkIdType NumberOfEdges = 8;
74
78 static constexpr vtkIdType NumberOfFaces = 5;
79
84 static constexpr vtkIdType MaximumFaceSize = 4;
85
91 static constexpr vtkIdType MaximumValence = 4;
93
96 int GetCellType() override { return VTK_PYRAMID; }
97 int GetCellDimension() override { return 3; }
98 int GetNumberOfEdges() override { return 8; }
99 int GetNumberOfFaces() override { return 5; }
100 vtkCell* GetEdge(int edgeId) override;
101 vtkCell* GetFace(int faceId) override;
102 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
103 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
104 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
105 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
106 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
107 double& dist2, double weights[]) override;
108 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
109 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
110 double pcoords[3], int& subId) override;
111 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
113 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
114 double* GetParametricCoords() override;
116
124 static int* GetTriangleCases(int caseId);
125
129 int GetParametricCenter(double pcoords[3]) override;
130
131 static void InterpolationFunctions(const double pcoords[3], double weights[5]);
132 static void InterpolationDerivs(const double pcoords[3], double derivs[15]);
134
138 void InterpolateFunctions(const double pcoords[3], double weights[5]) override
139 {
140 vtkPyramid::InterpolationFunctions(pcoords, weights);
141 }
142 void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
143 {
144 vtkPyramid::InterpolationDerivs(pcoords, derivs);
145 }
146
147
148 int JacobianInverse(const double pcoords[3], double** inverse, double derivs[15]);
149
151
162
167
172
177
182
187
191 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
192
193protected:
195 ~vtkPyramid() override;
196
200
201private:
202 vtkPyramid(const vtkPyramid&) = delete;
203 void operator=(const vtkPyramid&) = delete;
204};
205
206//----------------------------------------------------------------------------
207inline int vtkPyramid::GetParametricCenter(double pcoords[3])
208{
209 pcoords[0] = pcoords[1] = 0.4;
210 pcoords[2] = 0.2;
211 return 0;
212}
213
214#endif
object to represent cell connectivity
represent and manipulate cell attribute data
Definition vtkCellData.h:36
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition vtkIdList.h:31
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:34
cell represents a 1D line
Definition vtkLine.h:31
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:34
int GetParametricCenter(double pcoords[3]) override
Return the center of the pyramid in parametric coordinates.
Definition vtkPyramid.h:207
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:199
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
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.
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkTriangle * Triangle
Definition vtkPyramid.h:198
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.
bool IsInsideOut() override
See vtkCell3D API for description 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.
static constexpr vtkIdType NumberOfPoints
static constexpr handle on the number of points.
Definition vtkPyramid.h:68
static constexpr vtkIdType NumberOfEdges
static contexpr handle on the number of faces.
Definition vtkPyramid.h:73
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
~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:142
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition vtkPyramid.h:98
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:197
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
static constexpr vtkIdType NumberOfFaces
static contexpr handle on the number of edges.
Definition vtkPyramid.h:78
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:97
static constexpr vtkIdType MaximumFaceSize
static contexpr handle on the maximum face size.
Definition vtkPyramid.h:84
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
See vtkCell3D API for description 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:99
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition vtkPyramid.h:96
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.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description 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 constexpr vtkIdType MaximumValence
static constexpr handle on the maximum valence of this cell.
Definition vtkPyramid.h:91
static void InterpolationDerivs(const double pcoords[3], double derivs[15])
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
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:138
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:36
a cell that represents a triangle
Definition vtkTriangle.h:36
dataset represents arbitrary combinations of all possible cell types
@ VTK_PYRAMID
Definition vtkCellType.h:60
#define vtkDataArray
int vtkIdType
Definition vtkType.h:332
#define VTK_SIZEHINT(...)