VTK  9.3.0
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
28 #ifndef vtkVoxel_h
29 #define vtkVoxel_h
30 
31 #include "vtkCell3D.h"
32 #include "vtkCommonDataModelModule.h" // For export macro
33 
34 VTK_ABI_NAMESPACE_BEGIN
35 class vtkLine;
36 class vtkPixel;
38 
39 class VTKCOMMONDATAMODEL_EXPORT vtkVoxel : public vtkCell3D
40 {
41 public:
42  static vtkVoxel* New();
43  vtkTypeMacro(vtkVoxel, vtkCell3D);
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
47 
52  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
53  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
54  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
55  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faces) override;
57  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faces) override;
58  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
59  double* GetParametricCoords() override;
60  bool GetCentroid(double centroid[3]) const override;
61  bool IsInsideOut() override;
63 
67  double ComputeBoundingSphere(double center[3]) const override;
68 
72  static constexpr vtkIdType NumberOfPoints = 8;
73 
77  static constexpr vtkIdType NumberOfEdges = 12;
78 
82  static constexpr vtkIdType NumberOfFaces = 6;
83 
88  static constexpr vtkIdType MaximumFaceSize = 4;
89 
95  static constexpr vtkIdType MaximumValence = 3;
96 
98 
101  int GetCellType() override { return VTK_VOXEL; }
102  int GetCellDimension() override { return 3; }
103  int GetNumberOfEdges() override { return 12; }
104  int GetNumberOfFaces() override { return 6; }
105  vtkCell* GetEdge(int edgeId) override;
106  vtkCell* GetFace(int faceId) override;
107  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
108  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
109  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
110  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
111  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
112  double& dist2, double weights[]) override;
113  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
114  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
115  double pcoords[3], int& subId) override;
116  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
118  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
120 
129  int Inflate(double dist) override;
130 
131  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
133 
137  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
138  {
139  vtkVoxel::InterpolationFunctions(pcoords, weights);
140  }
141  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
142  {
143  vtkVoxel::InterpolationDerivs(pcoords, derivs);
144  }
146 
152  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
153 
161  static int* GetTriangleCases(int caseId);
162 
164 
172  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
173  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
175 
180 
185 
190 
195 
200 
204  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
205 
206 protected:
208  ~vtkVoxel() override;
209 
210 private:
211  vtkVoxel(const vtkVoxel&) = delete;
212  void operator=(const vtkVoxel&) = delete;
213 
214  vtkLine* Line;
215  vtkPixel* Pixel;
216 };
217 
218 VTK_ABI_NAMESPACE_END
219 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:28
object to represent cell connectivity
Definition: vtkCellArray.h:185
represent and manipulate cell attribute data
Definition: vtkCellData.h:40
abstract class to specify cell behavior
Definition: vtkCell.h:59
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
list of point or cell ids
Definition: vtkIdList.h:32
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:38
cell represents a 1D line
Definition: vtkLine.h:32
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:36
represent and manipulate point attribute data
Definition: vtkPointData.h:39
represent and manipulate 3D points
Definition: vtkPoints.h:38
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:40
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
See the vtkCell API for descriptions of these methods.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faces) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
int Inflate(double dist) override
Inflates voxel by moving every faces by dist.
static void InterpolationFunctions(const double pcoords[3], double weights[8])
Compute the interpolation functions.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:103
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:101
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faces) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
double ComputeBoundingSphere(double center[3]) const override
Computes exact bounding sphere of this voxel.
static vtkVoxel * New()
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:104
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkVoxel.h:137
static void InterpolationDerivs(const double pcoords[3], double derivs[24])
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
double * GetParametricCoords() override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
bool IsInsideOut() override
See vtkCell3D API for description of these methods.
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkVoxel.h:141
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description of these methods.
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
~vtkVoxel() override
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
See the vtkCell API for descriptions of these methods.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edges) override
See vtkCell3D API for description of these methods.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:102
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
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
See the vtkCell API for descriptions of these methods.
@ points
Definition: vtkX3D.h:446
@ value
Definition: vtkX3D.h:220
@ center
Definition: vtkX3D.h:230
@ index
Definition: vtkX3D.h:246
std::pair< boost::graph_traits< vtkGraph * >::edge_iterator, boost::graph_traits< vtkGraph * >::edge_iterator > edges(vtkGraph *g)
@ VTK_VOXEL
Definition: vtkCellType.h:57
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)