VTK  9.0.1
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_LEGACY(virtual void GetEdgePoints(int edgeId, int*& pts) override);
54  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
55  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
56  VTK_LEGACY(virtual void GetFacePoints(int faceId, int*& pts) override);
57  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
58  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faces) override;
59  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edges) override;
60  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faces) override;
61  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
62  double* GetParametricCoords() override;
63  bool GetCentroid(double centroid[3]) const override;
64  bool IsInsideOut() override;
66 
70  static constexpr vtkIdType NumberOfPoints = 8;
71 
75  static constexpr vtkIdType NumberOfEdges = 12;
76 
80  static constexpr vtkIdType NumberOfFaces = 6;
81 
86  static constexpr vtkIdType MaximumFaceSize = 4;
87 
93  static constexpr vtkIdType MaximumValence = 3;
94 
96 
99  int GetCellType() override { return VTK_VOXEL; }
100  int GetCellDimension() override { return 3; }
101  int GetNumberOfEdges() override { return 12; }
102  int GetNumberOfFaces() override { return 6; }
103  vtkCell* GetEdge(int edgeId) override;
104  vtkCell* GetFace(int faceId) override;
105  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
106  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
107  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
108  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
109  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
110  double& dist2, double weights[]) override;
111  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
112  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
113  double pcoords[3], int& subId) override;
114  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
115  void Derivatives(
116  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
118 
119  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
121 
125  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
126  {
127  vtkVoxel::InterpolationFunctions(pcoords, weights);
128  }
129  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
130  {
131  vtkVoxel::InterpolationDerivs(pcoords, derivs);
132  }
134 
140  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
141 
149  static int* GetTriangleCases(int caseId);
150 
152 
160  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
161  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
163 
167  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
168 
172  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);
173 
177  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
178 
182  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
183 
187  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
188 
192  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
193 
194 protected:
195  vtkVoxel();
196  ~vtkVoxel() override;
197 
198 private:
199  vtkVoxel(const vtkVoxel&) = delete;
200  void operator=(const vtkVoxel&) = delete;
201 
202  vtkLine* Line;
203  vtkPixel* Pixel;
204 };
205 
206 #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:31
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:99
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:34
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.
int vtkIdType
Definition: vtkType.h:338
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:100
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:29
abstract class to specify cell behavior
Definition: vtkCell.h:56
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:38
a simple class to control print indentation
Definition: vtkIndent.h:33
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:30
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkVoxel.h:129
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:101
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:125
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:179
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:102
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.
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
represent and manipulate 3D points
Definition: vtkPoints.h:33
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)