VTK  9.2.6
vtkCell.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkCell.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=========================================================================*/
36
37#ifndef vtkCell_h
38#define vtkCell_h
39
40#define VTK_CELL_SIZE 512
41#define VTK_TOL 1.e-05 // Tolerance for geometric calculation
42
43#include "vtkCommonDataModelModule.h" // For export macro
44#include "vtkObject.h"
45
46#include "vtkBoundingBox.h" // Needed for IntersectWithCell
47#include "vtkCellType.h" // Needed to define cell types
48#include "vtkIdList.h" // Needed for inline methods
49
50class vtkCellArray;
51class vtkCellData;
52class vtkDataArray;
53class vtkPointData;
55class vtkPoints;
56
57class VTKCOMMONDATAMODEL_EXPORT vtkCell : public vtkObject
58{
59public:
60 vtkTypeMacro(vtkCell, vtkObject);
61 void PrintSelf(ostream& os, vtkIndent indent) override;
62
67 void Initialize(int npts, const vtkIdType* pts, vtkPoints* p);
68
75 void Initialize(int npts, vtkPoints* p);
76
82 virtual void ShallowCopy(vtkCell* c);
83
88 virtual void DeepCopy(vtkCell* c);
89
93 virtual int GetCellType() = 0;
94
98 virtual int GetCellDimension() = 0;
99
105 virtual int IsLinear() { return 1; }
106
111 virtual int RequiresInitialization() { return 0; }
112 virtual void Initialize() {}
113
119 virtual int IsExplicitCell() { return 0; }
120
126 virtual int RequiresExplicitFaceRepresentation() { return 0; }
127 virtual void SetFaces(vtkIdType* vtkNotUsed(faces)) {}
128 virtual vtkIdType* GetFaces() { return nullptr; }
129
133 vtkPoints* GetPoints() { return this->Points; }
134
138 vtkIdType GetNumberOfPoints() const { return this->PointIds->GetNumberOfIds(); }
139
143 virtual int GetNumberOfEdges() = 0;
144
148 virtual int GetNumberOfFaces() = 0;
149
153 vtkIdList* GetPointIds() { return this->PointIds; }
154
158 vtkIdType GetPointId(int ptId) VTK_EXPECTS(0 <= ptId && ptId < GetPointIds()->GetNumberOfIds())
159 {
160 return this->PointIds->GetId(ptId);
161 }
162
166 virtual vtkCell* GetEdge(int edgeId) = 0;
167
179 virtual vtkCell* GetFace(int faceId) = 0;
180
188 virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) = 0;
189
207 virtual int EvaluatePosition(const double x[3], double closestPoint[3], int& subId,
208 double pcoords[3], double& dist2, double weights[]) = 0;
209
215 virtual void EvaluateLocation(
216 int& subId, const double pcoords[3], double x[3], double* weights) = 0;
217
231 virtual void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
232 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
233 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) = 0;
234
247 virtual void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
248 vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
249 vtkIdType cellId, vtkCellData* outCd, int insideOut) = 0;
250
264 virtual int Inflate(double dist);
265
274 virtual double ComputeBoundingSphere(double center[3]) const;
275
284 virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t,
285 double x[3], double pcoords[3], int& subId) = 0;
286
288
295 virtual int IntersectWithCell(vtkCell* other, double tol = 0.0);
296 virtual int IntersectWithCell(vtkCell* other, const vtkBoundingBox& boudingBox,
297 const vtkBoundingBox& otherBoundingBox, double tol = 0.0);
299
310 virtual int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) = 0;
311
326 virtual void Derivatives(
327 int subId, const double pcoords[3], const double* values, int dim, double* derivs) = 0;
328
333 void GetBounds(double bounds[6]);
334
340
344 double GetLength2();
345
352 virtual int GetParametricCenter(double pcoords[3]);
353
361 virtual double GetParametricDistance(const double pcoords[3]);
362
370 virtual int IsPrimaryCell() { return 1; }
371
382
388 virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double* vtkNotUsed(weight))
389 {
390 }
391 virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double* vtkNotUsed(derivs)) {}
392
393 // left public for quick computational access
396
397protected:
399 ~vtkCell() override;
400
401 double Bounds[6];
402
403private:
404 vtkCell(const vtkCell&) = delete;
405 void operator=(const vtkCell&) = delete;
406};
407
408#endif
Fast, simple class for representing and operating on 3D bounds.
object to represent cell connectivity
represent and manipulate cell attribute data
Definition vtkCellData.h:36
virtual void SetFaces(vtkIdType *vtkNotUsed(faces))
Definition vtkCell.h:127
virtual int GetNumberOfEdges()=0
Return the number of edges in the cell.
virtual void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs)=0
Compute derivatives given cell subId and parametric coordinates.
virtual int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[])=0
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
double Bounds[6]
Definition vtkCell.h:401
vtkIdType GetPointId(int ptId)
For cell point i, return the actual point id.
Definition vtkCell.h:158
virtual void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)=0
Cut (or clip) the cell based on the input cellScalars and the specified value.
double GetLength2()
Compute Length squared of cell (i.e., bounding box diagonal squared).
virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts)=0
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this leve...
Definition vtkCell.h:388
virtual int Inflate(double dist)
Inflates the cell.
vtkIdList * GetPointIds()
Return the list of point ids defining the cell.
Definition vtkCell.h:153
virtual int GetCellDimension()=0
Return the topological dimensional of the cell (0,1,2, or 3).
virtual void Contour(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)=0
Generate contouring primitives.
virtual int GetNumberOfFaces()=0
Return the number of faces in the cell.
virtual void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights)=0
Determine global coordinate (x[3]) from subId and parametric coordinates.
void GetBounds(double bounds[6])
Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
virtual void ShallowCopy(vtkCell *c)
Copy this cell by reference counting the internal data structures.
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
Intersect with a ray.
virtual double ComputeBoundingSphere(double center[3]) const
Computes the bounding sphere of the cell.
virtual int GetCellType()=0
Return the type of cell.
virtual void DeepCopy(vtkCell *c)
Copy this cell by completely copying internal data structures.
virtual int RequiresExplicitFaceRepresentation()
Determine whether the cell requires explicit face representation, and methods for setting and getting...
Definition vtkCell.h:126
virtual vtkIdType * GetFaces()
Definition vtkCell.h:128
virtual int IsPrimaryCell()
Return whether this cell type has a fixed topology or whether the topology varies depending on the da...
Definition vtkCell.h:370
virtual void Initialize()
Definition vtkCell.h:112
void Initialize(int npts, vtkPoints *p)
Initialize the cell with point coordinates specified.
virtual double GetParametricDistance(const double pcoords[3])
Return the distance of the parametric coordinate provided to the cell.
virtual int IntersectWithCell(vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
Intersects with an other cell.
vtkPoints * GetPoints()
Get the point coordinates for the cell.
Definition vtkCell.h:133
double * GetBounds()
Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
~vtkCell() override
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
virtual int RequiresInitialization()
Some cells require initialization prior to access.
Definition vtkCell.h:111
vtkPoints * Points
Definition vtkCell.h:394
virtual int IsLinear()
Non-linear cells require special treatment beyond the usual cell type and connectivity list informati...
Definition vtkCell.h:105
void Initialize(int npts, const vtkIdType *pts, vtkPoints *p)
Initialize cell from outside with point ids and point coordinates specified.
vtkIdList * PointIds
Definition vtkCell.h:395
virtual int IntersectWithCell(vtkCell *other, double tol=0.0)
Intersects with an other cell.
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
virtual double * GetParametricCoords()
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkIdType GetNumberOfPoints() const
Return the number of points in the cell.
Definition vtkCell.h:138
virtual int IsExplicitCell()
Explicit cells require additional representational information beyond the usual cell type and connect...
Definition vtkCell.h:119
virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition vtkCell.h:391
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
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
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:34
#define vtkDataArray
int vtkIdType
Definition vtkType.h:332
#define VTK_SIZEHINT(...)
#define VTK_EXPECTS(x)