VTK  9.1.0
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 =========================================================================*/
28 #ifndef vtkVoxel_h
29 #define vtkVoxel_h
30 
31 #include "vtkCell3D.h"
32 #include "vtkCommonDataModelModule.h" // For export macro
33 
34 class vtkLine;
35 class vtkPixel;
37 
38 class VTKCOMMONDATAMODEL_EXPORT vtkVoxel : public vtkCell3D
39 {
40 public:
41  static vtkVoxel* New();
42  vtkTypeMacro(vtkVoxel, vtkCell3D);
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
51  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
52  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
53  VTK_DEPRECATED_IN_9_0_0("Replaced by vtkVoxel::GetEdgePoints(vtkIdType, const vtkIdType*&)")
54  void GetEdgePoints(int edgeId, int*& pts) override;
55  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
56  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
57  VTK_DEPRECATED_IN_9_0_0("Replaced by vtkVoxel::GetFacePoints(vtkIdType, const vtkIdType*&)")
58  void GetFacePoints(int faceId, int*& pts) override;
59  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
60  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faces) override;
61  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edges) override;
62  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faces) override;
63  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
64  double* GetParametricCoords() override;
65  bool GetCentroid(double centroid[3]) const override;
66  bool IsInsideOut() override;
68 
72  double ComputeBoundingSphere(double center[3]) const override;
73 
77  static constexpr vtkIdType NumberOfPoints = 8;
78 
82  static constexpr vtkIdType NumberOfEdges = 12;
83 
87  static constexpr vtkIdType NumberOfFaces = 6;
88 
93  static constexpr vtkIdType MaximumFaceSize = 4;
94 
100  static constexpr vtkIdType MaximumValence = 3;
101 
103 
106  int GetCellType() override { return VTK_VOXEL; }
107  int GetCellDimension() override { return 3; }
108  int GetNumberOfEdges() override { return 12; }
109  int GetNumberOfFaces() override { return 6; }
110  vtkCell* GetEdge(int edgeId) override;
111  vtkCell* GetFace(int faceId) override;
112  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
113  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
114  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
115  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
116  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
117  double& dist2, double weights[]) override;
118  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
119  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
120  double pcoords[3], int& subId) override;
121  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
123  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
125 
134  int Inflate(double dist) override;
135 
136  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
138 
142  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
143  {
144  vtkVoxel::InterpolationFunctions(pcoords, weights);
145  }
146  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
147  {
148  vtkVoxel::InterpolationDerivs(pcoords, derivs);
149  }
151 
157  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
158 
166  static int* GetTriangleCases(int caseId);
167 
169 
177  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
178  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
180 
185 
190 
195 
200 
205 
209  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
210 
211 protected:
213  ~vtkVoxel() override;
214 
215 private:
216  vtkVoxel(const vtkVoxel&) = delete;
217  void operator=(const vtkVoxel&) = delete;
218 
219  vtkLine* Line;
220  vtkPixel* Pixel;
221 };
222 
223 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
object to represent cell connectivity
Definition: vtkCellArray.h:181
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
abstract class to specify cell behavior
Definition: vtkCell.h:58
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
list of point or cell ids
Definition: vtkIdList.h:31
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:34
cell represents a 1D line
Definition: vtkLine.h:31
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:35
represent and manipulate point attribute data
Definition: vtkPointData.h:33
represent and manipulate 3D points
Definition: vtkPoints.h:34
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:39
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.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
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:108
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.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
static vtkVoxel * New()
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:109
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkVoxel.h:142
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.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions 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:146
~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.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:107
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.
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
@ 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:57
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)