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=========================================================================*/
40#ifndef vtkCell_h
41#define vtkCell_h
42
43#define VTK_CELL_SIZE 512
44#define VTK_TOL 1.e-05 // Tolerance for geometric calculation
45
46#include "vtkCommonDataModelModule.h" // For export macro
47#include "vtkObject.h"
48
49#include "vtkBoundingBox.h" // Needed for IntersectWithCell
50#include "vtkCellType.h" // Needed to define cell types
51#include "vtkIdList.h" // Needed for inline methods
52
53class vtkCellArray;
54class vtkCellData;
55class vtkDataArray;
56class vtkPointData;
58class vtkPoints;
59
60class VTKCOMMONDATAMODEL_EXPORT vtkCell : public vtkObject
61{
62public:
63 vtkTypeMacro(vtkCell, vtkObject);
64 void PrintSelf(ostream& os, vtkIndent indent) override;
65
70 void Initialize(int npts, const vtkIdType* pts, vtkPoints* p);
71
78 void Initialize(int npts, vtkPoints* p);
79
85 virtual void ShallowCopy(vtkCell* c);
86
91 virtual void DeepCopy(vtkCell* c);
92
96 virtual int GetCellType() = 0;
97
101 virtual int GetCellDimension() = 0;
102
108 virtual int IsLinear() { return 1; }
109
114 virtual int RequiresInitialization() { return 0; }
115 virtual void Initialize() {}
116
122 virtual int IsExplicitCell() { return 0; }
123
129 virtual int RequiresExplicitFaceRepresentation() { return 0; }
130 virtual void SetFaces(vtkIdType* vtkNotUsed(faces)) {}
131 virtual vtkIdType* GetFaces() { return nullptr; }
132
136 vtkPoints* GetPoints() { return this->Points; }
137
141 vtkIdType GetNumberOfPoints() const { return this->PointIds->GetNumberOfIds(); }
142
146 virtual int GetNumberOfEdges() = 0;
147
151 virtual int GetNumberOfFaces() = 0;
152
156 vtkIdList* GetPointIds() { return this->PointIds; }
157
161 vtkIdType GetPointId(int ptId) VTK_EXPECTS(0 <= ptId && ptId < GetPointIds()->GetNumberOfIds())
162 {
163 return this->PointIds->GetId(ptId);
164 }
165
169 virtual vtkCell* GetEdge(int edgeId) = 0;
170
182 virtual vtkCell* GetFace(int faceId) = 0;
183
191 virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) = 0;
192
210 virtual int EvaluatePosition(const double x[3], double closestPoint[3], int& subId,
211 double pcoords[3], double& dist2, double weights[]) = 0;
212
218 virtual void EvaluateLocation(
219 int& subId, const double pcoords[3], double x[3], double* weights) = 0;
220
234 virtual void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
235 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
236 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) = 0;
237
250 virtual void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
251 vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
252 vtkIdType cellId, vtkCellData* outCd, int insideOut) = 0;
253
267 virtual int Inflate(double dist);
268
277 virtual double ComputeBoundingSphere(double center[3]) const;
278
287 virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t,
288 double x[3], double pcoords[3], int& subId) = 0;
289
291
298 virtual int IntersectWithCell(vtkCell* other, double tol = 0.0);
299 virtual int IntersectWithCell(vtkCell* other, const vtkBoundingBox& boudingBox,
300 const vtkBoundingBox& otherBoundingBox, double tol = 0.0);
302
313 virtual int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) = 0;
314
329 virtual void Derivatives(
330 int subId, const double pcoords[3], const double* values, int dim, double* derivs) = 0;
331
336 void GetBounds(double bounds[6]);
337
343
347 double GetLength2();
348
355 virtual int GetParametricCenter(double pcoords[3]);
356
364 virtual double GetParametricDistance(const double pcoords[3]);
365
373 virtual int IsPrimaryCell() { return 1; }
374
384 virtual double* GetParametricCoords() VTK_SIZEHINT(3 * GetNumberOfPoints());
385
391 virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double* vtkNotUsed(weight))
392 {
393 }
394 virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double* vtkNotUsed(derivs)) {}
395
396 // left public for quick computational access
399
400protected:
402 ~vtkCell() override;
403
404 double Bounds[6];
405
406private:
407 vtkCell(const vtkCell&) = delete;
408 void operator=(const vtkCell&) = delete;
409};
410
411#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:42
abstract class to specify cell behavior
Definition vtkCell.h:61
virtual void SetFaces(vtkIdType *vtkNotUsed(faces))
Definition vtkCell.h:130
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...
vtkIdType GetPointId(int ptId)
For cell point i, return the actual point id.
Definition vtkCell.h:161
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.
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 int Inflate(double dist)
Inflates the cell.
vtkIdList * GetPointIds()
Return the list of point ids defining the cell.
Definition vtkCell.h:156
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:129
virtual vtkIdType * GetFaces()
Definition vtkCell.h:131
virtual void Initialize()
Definition vtkCell.h:115
void Initialize(int npts, vtkPoints *p)
Initialize the cell with point coordinates specified.
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:136
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:114
vtkPoints * Points
Definition vtkCell.h:397
virtual int IsLinear()
Non-linear cells require special treatment beyond the usual cell type and connectivity list informati...
Definition vtkCell.h:108
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:398
virtual int IntersectWithCell(vtkCell *other, double tol=0.0)
Intersects with an other cell.
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:141
virtual int IsExplicitCell()
Explicit cells require additional representational information beyond the usual cell type and connect...
Definition vtkCell.h:122
virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition vtkCell.h:394
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
abstract superclass for arrays of numeric data
list of point or cell ids
Definition vtkIdList.h:34
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:40
abstract base class for most VTK objects
Definition vtkObject.h:63
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:40
int vtkIdType
Definition vtkType.h:332
#define VTK_SIZEHINT(...)
#define VTK_EXPECTS(x)