VTK  9.3.1
vtkVoxel.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
19 #ifndef vtkVoxel_h
20 #define vtkVoxel_h
21 
22 #include "vtkCell3D.h"
23 #include "vtkCommonDataModelModule.h" // For export macro
24 
25 VTK_ABI_NAMESPACE_BEGIN
26 class vtkLine;
27 class vtkPixel;
29 
30 class VTKCOMMONDATAMODEL_EXPORT vtkVoxel : public vtkCell3D
31 {
32 public:
33  static vtkVoxel* New();
34  vtkTypeMacro(vtkVoxel, vtkCell3D);
35  void PrintSelf(ostream& os, vtkIndent indent) override;
36 
38 
43  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
44  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
45  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
46  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faces) override;
47  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edges) override;
48  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faces) override;
49  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
50  double* GetParametricCoords() override;
51  bool GetCentroid(double centroid[3]) const override;
52  bool IsInsideOut() override;
54 
58  double ComputeBoundingSphere(double center[3]) const override;
59 
63  static constexpr vtkIdType NumberOfPoints = 8;
64 
68  static constexpr vtkIdType NumberOfEdges = 12;
69 
73  static constexpr vtkIdType NumberOfFaces = 6;
74 
79  static constexpr vtkIdType MaximumFaceSize = 4;
80 
86  static constexpr vtkIdType MaximumValence = 3;
87 
89 
92  int GetCellType() override { return VTK_VOXEL; }
93  int GetCellDimension() override { return 3; }
94  int GetNumberOfEdges() override { return 12; }
95  int GetNumberOfFaces() override { return 6; }
96  vtkCell* GetEdge(int edgeId) override;
97  vtkCell* GetFace(int faceId) override;
98  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
99  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
100  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
101  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
102  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
103  double& dist2, double weights[]) override;
104  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
105  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
106  double pcoords[3], int& subId) override;
107  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
108  void Derivatives(
109  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
111 
120  int Inflate(double dist) override;
121 
122  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
124 
128  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
129  {
130  vtkVoxel::InterpolationFunctions(pcoords, weights);
131  }
132  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
133  {
134  vtkVoxel::InterpolationDerivs(pcoords, derivs);
135  }
137 
143  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
144 
152  static int* GetTriangleCases(int caseId);
153 
155 
163  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
164  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
166 
170  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
171 
175  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);
176 
180  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
181 
185  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
186 
190  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
191 
195  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
196 
197 protected:
198  vtkVoxel();
199  ~vtkVoxel() override;
200 
201 private:
202  vtkVoxel(const vtkVoxel&) = delete;
203  void operator=(const vtkVoxel&) = delete;
204 
205  vtkLine* Line;
206  vtkPixel* Pixel;
207 };
208 
209 VTK_ABI_NAMESPACE_END
210 #endif
virtual vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds)=0
Get the ids of the adjacent faces to face of id faceId.
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
Generate contouring primitives.
represent and manipulate point attribute data
Definition: vtkPointData.h:29
static void InterpolationFunctions(const double pcoords[3], double weights[8])
Compute the interpolation functions.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:92
represent and manipulate cell attribute data
Definition: vtkCellData.h:30
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:26
Abstract class in support of both point location and point insertion.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:315
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:93
virtual double ComputeBoundingSphere(double center[3]) const
Computes the bounding sphere of the cell.
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:27
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...
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
virtual void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts)=0
Get the pair of vertices that define an edge.
cell represents a 1D line
Definition: vtkLine.h:22
abstract class to specify cell behavior
Definition: vtkCell.h:49
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.
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:30
a simple class to control print indentation
Definition: vtkIndent.h:28
virtual void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&faceIds)=0
Get the ids of the two adjacent faces to edge of id edgeId.
list of point or cell ids
Definition: vtkIdList.h:22
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:44
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkVoxel.h:132
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:94
virtual vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts)=0
Get the ids of a one-ring surrounding point of id pointId.
#define VTK_SIZEHINT(...)
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkVoxel.h:128
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
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...
object to represent cell connectivity
Definition: vtkCellArray.h:175
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of 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.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:95
static void InterpolationDerivs(const double pcoords[3], double derivs[24])
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this 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 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds)=0
Get the ids of the incident faces point of id pointId.
virtual bool IsInsideOut()
Returns true if the normals of the vtkCell3D point inside the cell.
int Inflate(double dist) override
Inflates the cell.
represent and manipulate 3D points
Definition: vtkPoints.h:28
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.
std::pair< boost::graph_traits< vtkGraph * >::edge_iterator, boost::graph_traits< vtkGraph * >::edge_iterator > edges(vtkGraph *g)