VTK  9.2.5
vtkVoxel.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkVoxel.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 =========================================================================*/
80 #ifndef vtkVoxel_h
81 #define vtkVoxel_h
82 
83 #include "vtkCell3D.h"
84 #include "vtkCommonDataModelModule.h" // For export macro
85 
86 class vtkLine;
87 class vtkPixel;
89 
90 class VTKCOMMONDATAMODEL_EXPORT vtkVoxel : public vtkCell3D
91 {
92 public:
93  static vtkVoxel* New();
94  vtkTypeMacro(vtkVoxel, vtkCell3D);
95  void PrintSelf(ostream& os, vtkIndent indent) override;
96 
98 
103  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
104  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
105  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
106  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faces) override;
108  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faces) override;
109  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
110  double* GetParametricCoords() override;
111  bool GetCentroid(double centroid[3]) const override;
112  bool IsInsideOut() override;
114 
118  double ComputeBoundingSphere(double center[3]) const override;
119 
123  static constexpr vtkIdType NumberOfPoints = 8;
124 
128  static constexpr vtkIdType NumberOfEdges = 12;
129 
133  static constexpr vtkIdType NumberOfFaces = 6;
134 
139  static constexpr vtkIdType MaximumFaceSize = 4;
140 
146  static constexpr vtkIdType MaximumValence = 3;
147 
149 
152  int GetCellType() override { return VTK_VOXEL; }
153  int GetCellDimension() override { return 3; }
154  int GetNumberOfEdges() override { return 12; }
155  int GetNumberOfFaces() override { return 6; }
156  vtkCell* GetEdge(int edgeId) override;
157  vtkCell* GetFace(int faceId) override;
158  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
159  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
160  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
161  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
162  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
163  double& dist2, double weights[]) override;
164  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
165  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
166  double pcoords[3], int& subId) override;
167  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
169  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
171 
180  int Inflate(double dist) override;
181 
182  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
184 
188  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
189  {
190  vtkVoxel::InterpolationFunctions(pcoords, weights);
191  }
192  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
193  {
194  vtkVoxel::InterpolationDerivs(pcoords, derivs);
195  }
197 
203  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
204 
212  static int* GetTriangleCases(int caseId);
213 
215 
223  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
224  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
226 
231 
236 
241 
246 
251 
255  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
256 
257 protected:
259  ~vtkVoxel() override;
260 
261 private:
262  vtkVoxel(const vtkVoxel&) = delete;
263  void operator=(const vtkVoxel&) = delete;
264 
265  vtkLine* Line;
266  vtkPixel* Pixel;
267 };
268 
269 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:39
object to represent cell connectivity
Definition: vtkCellArray.h:296
represent and manipulate cell attribute data
Definition: vtkCellData.h:151
abstract class to specify cell behavior
Definition: vtkCell.h:150
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
list of point or cell ids
Definition: vtkIdList.h:143
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:119
cell represents a 1D line
Definition: vtkLine.h:143
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:77
represent and manipulate point attribute data
Definition: vtkPointData.h:151
represent and manipulate 3D points
Definition: vtkPoints.h:149
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:91
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:154
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:152
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:155
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkVoxel.h:188
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:192
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:153
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:452
@ value
Definition: vtkX3D.h:226
@ center
Definition: vtkX3D.h:236
@ index
Definition: vtkX3D.h:252
std::pair< boost::graph_traits< vtkGraph * >::edge_iterator, boost::graph_traits< vtkGraph * >::edge_iterator > edges(vtkGraph *g)
@ VTK_VOXEL
Definition: vtkCellType.h:96
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)