VTK  9.0.20210424
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 =========================================================================*/
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 
50 class vtkCellArray;
51 class vtkCellData;
52 class vtkDataArray;
53 class vtkPointData;
55 class vtkPoints;
56 
57 class VTKCOMMONDATAMODEL_EXPORT vtkCell : public vtkObject
58 {
59 public:
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() { 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 
339  double* GetBounds() VTK_SIZEHINT(6);
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 
381  virtual double* GetParametricCoords() VTK_SIZEHINT(3 * GetNumberOfPoints());
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 
397 protected:
399  ~vtkCell() override;
400 
401  double Bounds[6];
402 
403 private:
404  vtkCell(const vtkCell&) = delete;
405  void operator=(const vtkCell&) = delete;
406 };
407 
408 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:34
vtkCell::IntersectWithLine
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.
vtkCell::GetBounds
double * GetBounds()
Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
vtkCell::DeepCopy
virtual void DeepCopy(vtkCell *c)
Copy this cell by completely copying internal data structures.
vtkCell::Contour
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.
vtkCell::ShallowCopy
virtual void ShallowCopy(vtkCell *c)
Copy this cell by reference counting the internal data structures.
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:47
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:33
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkCell::RequiresExplicitFaceRepresentation
virtual int RequiresExplicitFaceRepresentation()
Determine whether the cell requires explicit face representation, and methods for setting and getting...
Definition: vtkCell.h:126
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkCell::Points
vtkPoints * Points
Definition: vtkCell.h:394
vtkCell::GetCellDimension
virtual int GetCellDimension()=0
Return the topological dimensional of the cell (0,1,2, or 3).
vtkCell::Initialize
virtual void Initialize()
Definition: vtkCell.h:112
vtkX3D::weight
@ weight
Definition: vtkX3D.h:538
vtkCell::Initialize
void Initialize(int npts, const vtkIdType *pts, vtkPoints *p)
Initialize cell from outside with point ids and point coordinates specified.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:63
vtkX3D::center
@ center
Definition: vtkX3D.h:236
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
vtkCell::GetCellType
virtual int GetCellType()=0
Return the type of cell.
vtkCell::EvaluateLocation
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.
vtkCell::Initialize
void Initialize(int npts, vtkPoints *p)
Initialize the cell with point coordinates specified.
vtkCell::IsLinear
virtual int IsLinear()
Non-linear cells require special treatment beyond the usual cell type and connectivity list informati...
Definition: vtkCell.h:105
vtkNotUsed
const vtkUnicodeString const unsigned int vtkNotUsed(version))
Definition: vtkVariantBoostSerialization.h:72
vtkCell::~vtkCell
~vtkCell() override
vtkBoundingBox
Fast, simple class for representing and operating on 3D bounds.
Definition: vtkBoundingBox.h:36
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:48
vtkCell::Triangulate
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
vtkCell::GetPointIds
vtkIdList * GetPointIds()
Return the list of point ids defining the cell.
Definition: vtkCell.h:153
vtkCell::GetFaces
virtual vtkIdType * GetFaces()
Definition: vtkCell.h:128
vtkCell::IntersectWithCell
virtual int IntersectWithCell(vtkCell *other, double tol=0.0)
Intersects with an other cell.
vtkCell::GetBounds
void GetBounds(double bounds[6])
Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:58
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
vtkCell::GetFace
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkCell::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCell::Inflate
virtual int Inflate(double dist)
Inflates the cell.
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:181
vtkCellType.h
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:52
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:31
vtkCell::GetNumberOfEdges
virtual int GetNumberOfEdges()=0
Return the number of edges in the cell.
vtkCell::GetNumberOfFaces
virtual int GetNumberOfFaces()=0
Return the number of faces in the cell.
vtkCell::IsExplicitCell
virtual int IsExplicitCell()
Explicit cells require additional representational information beyond the usual cell type and connect...
Definition: vtkCell.h:119
vtkCell::GetNumberOfPoints
vtkIdType GetNumberOfPoints()
Return the number of points in the cell.
Definition: vtkCell.h:138
vtkBoundingBox.h
vtkObject.h
vtkCell::RequiresInitialization
virtual int RequiresInitialization()
Some cells require initialization prior to access.
Definition: vtkCell.h:111
vtkCell::CellBoundary
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...
vtkCell::InterpolateDerivs
virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition: vtkCell.h:391
vtkCell::SetFaces
virtual void SetFaces(vtkIdType *vtkNotUsed(faces))
Definition: vtkCell.h:127
vtkCell::EvaluatePosition
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...
vtkCell::PointIds
vtkIdList * PointIds
Definition: vtkCell.h:395
vtkCell::GetParametricCoords
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkCell::IntersectWithCell
virtual int IntersectWithCell(vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
Intersects with an other cell.
vtkCell::Clip
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.
vtkCell::GetEdge
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
vtkCell::GetPointId
vtkIdType GetPointId(int ptId)
For cell point i, return the actual point id.
Definition: vtkCell.h:158
vtkCell::Derivatives
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.
vtkCell::ComputeBoundingSphere
virtual double ComputeBoundingSphere(double center[3]) const
Computes the bounding sphere of the cell.
vtkCell::GetPoints
vtkPoints * GetPoints()
Get the point coordinates for the cell.
Definition: vtkCell.h:133
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkIdList.h
vtkCell::vtkCell
vtkCell()