VTK  9.1.0
vtkGenericCell.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGenericCell.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 =========================================================================*/
109 #ifndef vtkGenericCell_h
110 #define vtkGenericCell_h
111 
112 #include "vtkCell.h"
113 #include "vtkCommonDataModelModule.h" // For export macro
114 
115 class VTKCOMMONDATAMODEL_EXPORT vtkGenericCell : public vtkCell
116 {
117 public:
121  static vtkGenericCell* New();
122 
123  vtkTypeMacro(vtkGenericCell, vtkCell);
124  void PrintSelf(ostream& os, vtkIndent indent) override;
125 
131 
136  void SetPointIds(vtkIdList* pointIds);
137 
139 
142  void ShallowCopy(vtkCell* c) override;
143  void DeepCopy(vtkCell* c) override;
144  int GetCellType() override;
145  int GetCellDimension() override;
146  int IsLinear() override;
147  int RequiresInitialization() override;
148  void Initialize() override;
150  void SetFaces(vtkIdType* faces) override;
151  vtkIdType* GetFaces() override;
152  int GetNumberOfEdges() override;
153  int GetNumberOfFaces() override;
154  vtkCell* GetEdge(int edgeId) override;
155  vtkCell* GetFace(int faceId) override;
156  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
157  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
158  double& dist2, double weights[]) override;
159  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
160  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
161  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
162  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
163  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
164  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
165  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
166  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
167  double pcoords[3], int& subId) override;
168  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
170  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
171  int GetParametricCenter(double pcoords[3]) override;
172  double* GetParametricCoords() override;
173  int IsPrimaryCell() override;
175 
177 
181  void InterpolateFunctions(const double pcoords[3], double* weights) override;
182  void InterpolateDerivs(const double pcoords[3], double* derivs) override;
184 
192  void SetCellType(int cellType);
193  void SetCellTypeToEmptyCell() { this->SetCellType(VTK_EMPTY_CELL); }
194  void SetCellTypeToVertex() { this->SetCellType(VTK_VERTEX); }
195  void SetCellTypeToPolyVertex() { this->SetCellType(VTK_POLY_VERTEX); }
196  void SetCellTypeToLine() { this->SetCellType(VTK_LINE); }
197  void SetCellTypeToPolyLine() { this->SetCellType(VTK_POLY_LINE); }
198  void SetCellTypeToTriangle() { this->SetCellType(VTK_TRIANGLE); }
199  void SetCellTypeToTriangleStrip() { this->SetCellType(VTK_TRIANGLE_STRIP); }
200  void SetCellTypeToPolygon() { this->SetCellType(VTK_POLYGON); }
201  void SetCellTypeToPixel() { this->SetCellType(VTK_PIXEL); }
202  void SetCellTypeToQuad() { this->SetCellType(VTK_QUAD); }
203  void SetCellTypeToTetra() { this->SetCellType(VTK_TETRA); }
204  void SetCellTypeToVoxel() { this->SetCellType(VTK_VOXEL); }
205  void SetCellTypeToHexahedron() { this->SetCellType(VTK_HEXAHEDRON); }
206  void SetCellTypeToWedge() { this->SetCellType(VTK_WEDGE); }
207  void SetCellTypeToPyramid() { this->SetCellType(VTK_PYRAMID); }
208  void SetCellTypeToPentagonalPrism() { this->SetCellType(VTK_PENTAGONAL_PRISM); }
209  void SetCellTypeToHexagonalPrism() { this->SetCellType(VTK_HEXAGONAL_PRISM); }
210  void SetCellTypeToPolyhedron() { this->SetCellType(VTK_POLYHEDRON); }
211  void SetCellTypeToConvexPointSet() { this->SetCellType(VTK_CONVEX_POINT_SET); }
212  void SetCellTypeToQuadraticEdge() { this->SetCellType(VTK_QUADRATIC_EDGE); }
213  void SetCellTypeToCubicLine() { this->SetCellType(VTK_CUBIC_LINE); }
216  void SetCellTypeToQuadraticQuad() { this->SetCellType(VTK_QUADRATIC_QUAD); }
218  void SetCellTypeToQuadraticTetra() { this->SetCellType(VTK_QUADRATIC_TETRA); }
220  void SetCellTypeToQuadraticWedge() { this->SetCellType(VTK_QUADRATIC_WEDGE); }
223  void SetCellTypeToBiQuadraticQuad() { this->SetCellType(VTK_BIQUADRATIC_QUAD); }
226  {
227  this->SetCellType(VTK_BIQUADRATIC_QUADRATIC_WEDGE);
228  }
232  {
233  this->SetCellType(VTK_BIQUADRATIC_QUADRATIC_HEXAHEDRON);
234  }
237  void SetCellTypeToLagrangeCurve() { this->SetCellType(VTK_LAGRANGE_CURVE); }
240  void SetCellTypeToLagrangeWedge() { this->SetCellType(VTK_LAGRANGE_WEDGE); }
241 
242  void SetCellTypeToBezierTriangle() { this->SetCellType(VTK_BEZIER_TRIANGLE); }
243  void SetCellTypeToBezierTetra() { this->SetCellType(VTK_BEZIER_TETRAHEDRON); }
244  void SetCellTypeToBezierCurve() { this->SetCellType(VTK_BEZIER_CURVE); }
247  void SetCellTypeToBezierWedge() { this->SetCellType(VTK_BEZIER_WEDGE); }
251  static vtkCell* InstantiateCell(int cellType);
252 
253  vtkCell* GetRepresentativeCell() { return this->Cell; }
254 
255 protected:
257  ~vtkGenericCell() override;
258 
261 
262 private:
263  vtkGenericCell(const vtkGenericCell&) = delete;
264  void operator=(const vtkGenericCell&) = delete;
265 };
266 
267 #endif
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
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
provides thread-safe access to cells
void SetCellTypeToLagrangeCurve()
void SetCellTypeToHexahedron()
void SetCellTypeToQuadraticLinearWedge()
vtkCell * GetRepresentativeCell()
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToLagrangeWedge()
void Initialize() override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToQuadraticWedge()
void SetCellTypeToQuadraticPolygon()
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToPyramid()
void SetCellTypeToQuadraticTetra()
void SetCellTypeToQuad()
void SetCellTypeToTriangleStrip()
void SetCellTypeToPixel()
int RequiresInitialization() override
See the vtkCell API for descriptions 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.
void SetCellTypeToQuadraticQuad()
void SetCellTypeToQuadraticLinearQuad()
int GetParametricCenter(double pcoords[3]) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToBezierWedge()
static vtkCell * InstantiateCell(int cellType)
Instantiate a new vtkCell based on it's cell type value.
void SetCellTypeToTetra()
~vtkGenericCell() override
static vtkGenericCell * New()
Create handle to any type of cell; by default a vtkEmptyCell.
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToLagrangeTetra()
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.
void SetCellTypeToPolyhedron()
void SetCellTypeToLine()
vtkIdType * GetFaces() override
See the vtkCell API for descriptions of these methods.
void InterpolateDerivs(const double pcoords[3], double *derivs) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
void SetCellTypeToBezierTetra()
int IsPrimaryCell() 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.
int IsLinear() override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToQuadraticHexahedron()
void SetCellTypeToVoxel()
void SetPoints(vtkPoints *points)
Set the points object to use for this cell.
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
void SetFaces(vtkIdType *faces) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToTriQuadraticHexahedron()
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.
void SetCellTypeToBiQuadraticQuadraticHexahedron()
void SetCellTypeToBiQuadraticQuad()
void SetCellTypeToCubicLine()
int RequiresExplicitFaceRepresentation() override
See the vtkCell API for descriptions of these methods.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToConvexPointSet()
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
void DeepCopy(vtkCell *c) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToVertex()
void SetCellTypeToBezierCurve()
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToLagrangeTriangle()
void SetCellTypeToWedge()
void SetCellType(int cellType)
This method is used to support the vtkDataSet::GetCell(vtkGenericCell *) method.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToTriangle()
void SetCellTypeToQuadraticPyramid()
void SetCellTypeToQuadraticEdge()
int GetCellType() override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToBiQuadraticQuadraticWedge()
void SetCellTypeToBiQuadraticTriangle()
void SetCellTypeToPolyLine()
void SetCellTypeToPentagonalPrism()
void SetCellTypeToPolygon()
void SetCellTypeToBezierQuadrilateral()
void SetCellTypeToLagrangeQuadrilateral()
void SetCellTypeToBezierTriangle()
void InterpolateFunctions(const double pcoords[3], double *weights) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
void SetCellTypeToHexagonalPrism()
void SetCellTypeToBezierHexahedron()
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
void SetCellTypeToEmptyCell()
void SetCellTypeToLagrangeHexahedron()
void SetCellTypeToPolyVertex()
void ShallowCopy(vtkCell *c) override
See the vtkCell API for descriptions of these methods.
void SetPointIds(vtkIdList *pointIds)
Set the point ids to use for this cell.
void SetCellTypeToTriQuadraticPyramid()
void SetCellTypeToQuadraticTriangle()
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
represent and manipulate point attribute data
Definition: vtkPointData.h:142
represent and manipulate 3D points
Definition: vtkPoints.h:143
@ points
Definition: vtkX3D.h:452
@ value
Definition: vtkX3D.h:226
@ index
Definition: vtkX3D.h:252
@ VTK_VOXEL
Definition: vtkCellType.h:96
@ VTK_QUADRATIC_HEXAHEDRON
Definition: vtkCellType.h:109
@ VTK_TRIANGLE_STRIP
Definition: vtkCellType.h:91
@ VTK_BIQUADRATIC_QUADRATIC_HEXAHEDRON
Definition: vtkCellType.h:118
@ VTK_NUMBER_OF_CELL_TYPES
Definition: vtkCellType.h:166
@ VTK_LAGRANGE_CURVE
Definition: vtkCellType.h:149
@ VTK_PYRAMID
Definition: vtkCellType.h:99
@ VTK_PIXEL
Definition: vtkCellType.h:93
@ VTK_QUADRATIC_WEDGE
Definition: vtkCellType.h:110
@ VTK_BEZIER_WEDGE
Definition: vtkCellType.h:163
@ VTK_BIQUADRATIC_QUAD
Definition: vtkCellType.h:112
@ VTK_LAGRANGE_QUADRILATERAL
Definition: vtkCellType.h:151
@ VTK_POLY_LINE
Definition: vtkCellType.h:89
@ VTK_TRIQUADRATIC_PYRAMID
Definition: vtkCellType.h:114
@ VTK_TRIANGLE
Definition: vtkCellType.h:90
@ VTK_BEZIER_TRIANGLE
Definition: vtkCellType.h:159
@ VTK_POLYGON
Definition: vtkCellType.h:92
@ VTK_EMPTY_CELL
Definition: vtkCellType.h:85
@ VTK_QUADRATIC_PYRAMID
Definition: vtkCellType.h:111
@ VTK_POLYHEDRON
Definition: vtkCellType.h:128
@ VTK_TRIQUADRATIC_HEXAHEDRON
Definition: vtkCellType.h:113
@ VTK_TETRA
Definition: vtkCellType.h:95
@ VTK_LINE
Definition: vtkCellType.h:88
@ VTK_CONVEX_POINT_SET
Definition: vtkCellType.h:125
@ VTK_BEZIER_HEXAHEDRON
Definition: vtkCellType.h:162
@ VTK_LAGRANGE_WEDGE
Definition: vtkCellType.h:154
@ VTK_LAGRANGE_HEXAHEDRON
Definition: vtkCellType.h:153
@ VTK_PENTAGONAL_PRISM
Definition: vtkCellType.h:100
@ VTK_QUADRATIC_QUAD
Definition: vtkCellType.h:106
@ VTK_WEDGE
Definition: vtkCellType.h:98
@ VTK_LAGRANGE_TETRAHEDRON
Definition: vtkCellType.h:152
@ VTK_BEZIER_CURVE
Definition: vtkCellType.h:158
@ VTK_HEXAGONAL_PRISM
Definition: vtkCellType.h:101
@ VTK_BEZIER_QUADRILATERAL
Definition: vtkCellType.h:160
@ VTK_QUADRATIC_LINEAR_WEDGE
Definition: vtkCellType.h:116
@ VTK_HEXAHEDRON
Definition: vtkCellType.h:97
@ VTK_CUBIC_LINE
Definition: vtkCellType.h:122
@ VTK_LAGRANGE_TRIANGLE
Definition: vtkCellType.h:150
@ VTK_QUADRATIC_POLYGON
Definition: vtkCellType.h:107
@ VTK_QUAD
Definition: vtkCellType.h:94
@ VTK_QUADRATIC_TRIANGLE
Definition: vtkCellType.h:105
@ VTK_QUADRATIC_EDGE
Definition: vtkCellType.h:104
@ VTK_QUADRATIC_TETRA
Definition: vtkCellType.h:108
@ VTK_BEZIER_TETRAHEDRON
Definition: vtkCellType.h:161
@ VTK_VERTEX
Definition: vtkCellType.h:86
@ VTK_POLY_VERTEX
Definition: vtkCellType.h:87
@ VTK_QUADRATIC_LINEAR_QUAD
Definition: vtkCellType.h:115
@ VTK_BIQUADRATIC_QUADRATIC_WEDGE
Definition: vtkCellType.h:117
@ VTK_BIQUADRATIC_TRIANGLE
Definition: vtkCellType.h:119
int vtkIdType
Definition: vtkType.h:332