VTK  9.1.0
vtkWedge.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkWedge.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=========================================================================*/
80#ifndef vtkWedge_h
81#define vtkWedge_h
82
83#include "vtkCell3D.h"
84#include "vtkCommonDataModelModule.h" // For export macro
85
86class vtkLine;
87class vtkTriangle;
88class vtkQuad;
91
92class VTKCOMMONDATAMODEL_EXPORT vtkWedge : public vtkCell3D
93{
94public:
95 static vtkWedge* New();
96 vtkTypeMacro(vtkWedge, vtkCell3D);
97 void PrintSelf(ostream& os, vtkIndent indent) override;
98
100
103 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
104 // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
105 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkWedge::GetEdgePoints(vtkIdType, const vtkIdType*&)")
106 void GetEdgePoints(int edgeId, int*& pts) override;
107 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
108 // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
109 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkWedge::GetFacePoints(vtkIdType, const vtkIdType*&)")
110 void GetFacePoints(int faceId, int*& pts) override;
111 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
112 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
113 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
114 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
115 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
116 bool GetCentroid(double centroid[3]) const override;
117 bool IsInsideOut() override;
119
123 static constexpr vtkIdType NumberOfPoints = 6;
124
128 static constexpr vtkIdType NumberOfEdges = 9;
129
133 static constexpr vtkIdType NumberOfFaces = 5;
134
139 static constexpr vtkIdType MaximumFaceSize = 4;
140
146 static constexpr vtkIdType MaximumValence = 3;
147
149
152 int GetCellType() override { return VTK_WEDGE; }
153 int GetCellDimension() override { return 3; }
154 int GetNumberOfEdges() override { return static_cast<int>(NumberOfEdges); }
155 int GetNumberOfFaces() override { return static_cast<int>(NumberOfFaces); }
156 vtkCell* GetEdge(int edgeId) override;
157 vtkCell* GetFace(int faceId) override;
158 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
159 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
160 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
161 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
162 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
163 double& dist2, double weights[]) override;
164 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
165 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
166 double pcoords[3], int& subId) override;
167 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
169 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
170 double* GetParametricCoords() override;
172
180 static int* GetTriangleCases(int caseId);
181
185 int GetParametricCenter(double pcoords[3]) override;
186
187 static void InterpolationFunctions(const double pcoords[3], double weights[6]);
188 static void InterpolationDerivs(const double pcoords[3], double derivs[18]);
190
194 void InterpolateFunctions(const double pcoords[3], double weights[6]) override
195 {
196 vtkWedge::InterpolationFunctions(pcoords, weights);
197 }
198 void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
199 {
200 vtkWedge::InterpolationDerivs(pcoords, derivs);
201 }
202 int JacobianInverse(const double pcoords[3], double** inverse, double derivs[18]);
204
206
215 static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(MaximumFaceSize + 1);
217
222
227
232
237
242
246 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
247
248protected:
250 ~vtkWedge() override;
251
255
256private:
257 vtkWedge(const vtkWedge&) = delete;
258 void operator=(const vtkWedge&) = delete;
259};
260
261inline int vtkWedge::GetParametricCenter(double pcoords[3])
262{
263 pcoords[0] = pcoords[1] = 0.333333;
264 pcoords[2] = 0.5;
265 return 0;
266}
267
268#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 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
a 3D cell that represents a linear wedge
Definition: vtkWedge.h:93
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.
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.
static vtkWedge * New()
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:154
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:155
~vtkWedge() override
static void InterpolationDerivs(const double pcoords[3], double derivs[18])
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
vtkLine * Line
Definition: vtkWedge.h:252
vtkCell * GetEdge(int edgeId) 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).
static void InterpolationFunctions(const double pcoords[3], double weights[6])
void InterpolateFunctions(const double pcoords[3], double weights[6]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkWedge.h:194
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:153
vtkTriangle * Triangle
Definition: vtkWedge.h:253
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
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 const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
Definition: vtkWedge.h:261
vtkQuad * Quad
Definition: vtkWedge.h:254
int JacobianInverse(const double pcoords[3], double **inverse, double derivs[18])
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
vtkCell * GetFace(int faceId) 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.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkWedge.h:198
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
@ VTK_WEDGE
Definition: vtkCellType.h:98
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)