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
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;
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;
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 
171 
176 
181 
186 
191 
195  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
196 
197 protected:
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
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:28
object to represent cell connectivity
Definition: vtkCellArray.h:176
represent and manipulate cell attribute data
Definition: vtkCellData.h:31
abstract class to specify cell behavior
Definition: vtkCell.h:50
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
list of point or cell ids
Definition: vtkIdList.h:23
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:29
cell represents a 1D line
Definition: vtkLine.h:23
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:27
represent and manipulate point attribute data
Definition: vtkPointData.h:30
represent and manipulate 3D points
Definition: vtkPoints.h:29
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:31
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:94
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:92
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:95
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkVoxel.h:128
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:132
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:93
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:48
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)