VTK  9.0.20200604
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 
171  virtual vtkCell* GetFace(int faceId) = 0;
172 
180  virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) = 0;
181 
199  virtual int EvaluatePosition(const double x[3], double closestPoint[3], int& subId,
200  double pcoords[3], double& dist2, double weights[]) = 0;
201 
207  virtual void EvaluateLocation(
208  int& subId, const double pcoords[3], double x[3], double* weights) = 0;
209 
223  virtual void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
224  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
225  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) = 0;
226 
239  virtual void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
240  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
241  vtkIdType cellId, vtkCellData* outCd, int insideOut) = 0;
242 
248  virtual void Inflate(double dist);
249 
258  virtual double ComputeBoundingSphere(double center[3]) const;
259 
268  virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t,
269  double x[3], double pcoords[3], int& subId) = 0;
270 
272 
279  virtual int IntersectWithCell(vtkCell* other, double tol = 0.0);
280  virtual int IntersectWithCell(vtkCell* other, const vtkBoundingBox& boudingBox,
281  const vtkBoundingBox& otherBoundingBox, double tol = 0.0);
283 
294  virtual int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) = 0;
295 
310  virtual void Derivatives(
311  int subId, const double pcoords[3], const double* values, int dim, double* derivs) = 0;
312 
317  void GetBounds(double bounds[6]);
318 
323  double* GetBounds() VTK_SIZEHINT(6);
324 
328  double GetLength2();
329 
336  virtual int GetParametricCenter(double pcoords[3]);
337 
345  virtual double GetParametricDistance(const double pcoords[3]);
346 
354  virtual int IsPrimaryCell() { return 1; }
355 
365  virtual double* GetParametricCoords() VTK_SIZEHINT(3 * GetNumberOfPoints());
366 
372  virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double* vtkNotUsed(weight))
373  {
374  }
375  virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double* vtkNotUsed(derivs)) {}
376 
377  // left public for quick computational access
380 
381 protected:
382  vtkCell();
383  ~vtkCell() override;
384 
385  double Bounds[6];
386 
387 private:
388  vtkCell(const vtkCell&) = delete;
389  void operator=(const vtkCell&) = delete;
390 };
391 
392 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:44
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:32
vtkX3D::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:330
vtkCell::Points
vtkPoints * Points
Definition: vtkCell.h:378
vtkIossUtilities::GetCellType
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
vtkCell::Initialize
virtual void Initialize()
Definition: vtkCell.h:112
vtkX3D::weight
Definition: vtkX3D.h:538
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkX3D::center
Definition: vtkX3D.h:236
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
vtkCell::IsLinear
virtual int IsLinear()
Non-linear cells require special treatment beyond the usual cell type and connectivity list informati...
Definition: vtkCell.h:105
vtkBoundingBox
Fast, simple class for representing and operating on 3D bounds.
Definition: vtkBoundingBox.h:35
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
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
abstract class to specify cell behavior
Definition: vtkCell.h:57
vtkBlockSortHelper::GetBounds
void GetBounds(T a, double bds[6])
Definition: vtkBlockSortHelper.h:37
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:180
vtkCellType.h
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:51
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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::InterpolateDerivs
virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition: vtkCell.h:375
vtkCell::SetFaces
virtual void SetFaces(vtkIdType *vtkNotUsed(faces))
Definition: vtkCell.h:127
vtkCell::PointIds
vtkIdList * PointIds
Definition: vtkCell.h:379
vtkCell::GetPointId
vtkIdType GetPointId(int ptId)
For cell point i, return the actual point id.
Definition: vtkCell.h:158
vtkCell::GetPoints
vtkPoints * GetPoints()
Get the point coordinates for the cell.
Definition: vtkCell.h:133
vtkX3D::index
Definition: vtkX3D.h:252
vtkIdList.h