VTK  9.2.6
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 =========================================================================*/
31 #ifndef vtkVoxel_h
32 #define vtkVoxel_h
33 
34 #include "vtkCell3D.h"
35 #include "vtkCommonDataModelModule.h" // For export macro
36 
37 class vtkLine;
38 class vtkPixel;
40 
41 class VTKCOMMONDATAMODEL_EXPORT vtkVoxel : public vtkCell3D
42 {
43 public:
44  static vtkVoxel* New();
45  vtkTypeMacro(vtkVoxel, vtkCell3D);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
49 
54  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
55  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
56  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
57  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faces) override;
58  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edges) override;
59  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faces) override;
60  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
61  double* GetParametricCoords() override;
62  bool GetCentroid(double centroid[3]) const override;
63  bool IsInsideOut() override;
65 
69  double ComputeBoundingSphere(double center[3]) const override;
70 
74  static constexpr vtkIdType NumberOfPoints = 8;
75 
79  static constexpr vtkIdType NumberOfEdges = 12;
80 
84  static constexpr vtkIdType NumberOfFaces = 6;
85 
90  static constexpr vtkIdType MaximumFaceSize = 4;
91 
97  static constexpr vtkIdType MaximumValence = 3;
98 
100 
103  int GetCellType() override { return VTK_VOXEL; }
104  int GetCellDimension() override { return 3; }
105  int GetNumberOfEdges() override { return 12; }
106  int GetNumberOfFaces() override { return 6; }
107  vtkCell* GetEdge(int edgeId) override;
108  vtkCell* GetFace(int faceId) override;
109  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
110  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
111  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
112  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
113  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
114  double& dist2, double weights[]) override;
115  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
116  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
117  double pcoords[3], int& subId) override;
118  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
119  void Derivatives(
120  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
122 
131  int Inflate(double dist) override;
132 
133  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
135 
139  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
140  {
141  vtkVoxel::InterpolationFunctions(pcoords, weights);
142  }
143  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
144  {
145  vtkVoxel::InterpolationDerivs(pcoords, derivs);
146  }
148 
154  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
155 
163  static int* GetTriangleCases(int caseId);
164 
166 
174  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
175  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
177 
181  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
182 
186  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);
187 
191  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
192 
196  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
197 
201  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
202 
206  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
207 
208 protected:
209  vtkVoxel();
210  ~vtkVoxel() override;
211 
212 private:
213  vtkVoxel(const vtkVoxel&) = delete;
214  void operator=(const vtkVoxel&) = delete;
215 
216  vtkLine* Line;
217  vtkPixel* Pixel;
218 };
219 
220 #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:41
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:103
represent and manipulate cell attribute data
Definition: vtkCellData.h:41
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:37
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:332
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:104
virtual double ComputeBoundingSphere(double center[3]) const
Computes the bounding sphere of the cell.
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
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:33
abstract class to specify cell behavior
Definition: vtkCell.h:60
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:41
a simple class to control print indentation
Definition: vtkIndent.h:39
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:33
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkVoxel.h:143
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:105
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:139
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:186
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:106
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:39
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)