VTK
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 =========================================================================*/
34 #ifndef vtkVoxel_h
35 #define vtkVoxel_h
36 
37 #include "vtkCommonDataModelModule.h" // For export macro
38 #include "vtkCell3D.h"
39 
40 class vtkLine;
41 class vtkPixel;
43 
44 class VTKCOMMONDATAMODEL_EXPORT vtkVoxel : public vtkCell3D
45 {
46 public:
47  static vtkVoxel *New();
48  vtkTypeMacro(vtkVoxel,vtkCell3D);
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
55  void GetEdgePoints(int edgeId, int* &pts) override;
56  void GetFacePoints(int faceId, int* &pts) override;
57  double *GetParametricCoords() override;
59 
61 
64  int GetCellType() override {return VTK_VOXEL;}
65  int GetCellDimension() override {return 3;}
66  int GetNumberOfEdges() override {return 12;}
67  int GetNumberOfFaces() override {return 6;}
68  vtkCell *GetEdge(int edgeId) override;
69  vtkCell *GetFace(int faceId) override;
70  int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override;
71  void Contour(double value, vtkDataArray *cellScalars,
73  vtkCellArray *lines, vtkCellArray *polys,
74  vtkPointData *inPd, vtkPointData *outPd,
75  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override;
76  int EvaluatePosition(const double x[3], double closestPoint[3],
77  int& subId, double pcoords[3],
78  double& dist2, double weights[]) override;
79  void EvaluateLocation(int& subId, const double pcoords[3], double x[3],
80  double *weights) override;
81  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t,
82  double x[3], double pcoords[3], int& subId) override;
83  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override;
84  void Derivatives(int subId, const double pcoords[3], const double *values,
85  int dim, double *derivs) override;
87 
91  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
93 
97  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
98  {
99  vtkVoxel::InterpolationFunctions(pcoords,weights);
100  }
101  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
102  {
103  vtkVoxel::InterpolationDerivs(pcoords,derivs);
104  }
106 
112  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
113 
121  static int* GetTriangleCases(int caseId);
122 
124 
128  static int *GetEdgeArray(int edgeId) VTK_SIZEHINT(2);
129  static int *GetFaceArray(int faceId) VTK_SIZEHINT(4);
131 
132 protected:
134  ~vtkVoxel() override;
135 
136 private:
137  vtkVoxel(const vtkVoxel&) = delete;
138  void operator=(const vtkVoxel&) = delete;
139 
140  vtkLine *Line;
141  vtkPixel *Pixel;
142 };
143 
144 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkVoxel::CellBoundary
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
vtkVoxel::Triangulate
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
VTK_VOXEL
@ VTK_VOXEL
Definition: vtkCellType.h:56
vtkVoxel::IntersectWithLine
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
Intersect with a ray.
vtkVoxel::EvaluateLocation
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
vtkVoxel::InterpolationFunctions
static void InterpolationFunctions(const double pcoords[3], double weights[8])
Compute the interpolation functions.
vtkVoxel::InterpolateDerivs
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Definition: vtkVoxel.h:101
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:38
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkVoxel::GetParametricCoords
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkVoxel::GetEdgePoints
void GetEdgePoints(int edgeId, int *&pts) override
See vtkCell3D API for description of these methods.
vtkVoxel::GetFaceArray
static int * GetFaceArray(int faceId)
vtkVoxel::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkVoxel::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkVoxel.h:66
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkCell3D.h
vtkVoxel::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkVoxel.h:67
vtkLine
cell represents a 1D line
Definition: vtkLine.h:36
vtkVoxel::GetEdgeArray
static int * GetEdgeArray(int edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
vtkCell3D
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:39
vtkVoxel::GetFacePoints
void GetFacePoints(int faceId, int *&pts) override
Get the list of vertices that define a face.
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkVoxel::vtkVoxel
vtkVoxel()
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:60
vtkVoxel::GetEdge
vtkCell * GetEdge(int edgeId) override
Return the edge cell from the edgeId of the cell.
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:39
vtkVoxel::New
static vtkVoxel * New()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
vtkVoxel::EvaluatePosition
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:52
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:37
vtkVoxel::InterpolateFunctions
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkVoxel.h:97
vtkVoxel::Derivatives
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
vtkVoxel::Contour
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.
vtkPixel
a cell that represents an orthogonal quadrilateral
Definition: vtkPixel.h:41
vtkVoxel::~vtkVoxel
~vtkVoxel() override
vtkVoxel::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkVoxel.h:64
vtkVoxel::GetTriangleCases
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
vtkVoxel::InterpolationDerivs
static void InterpolationDerivs(const double pcoords[3], double derivs[24])
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkVoxel::GetCellDimension
int GetCellDimension() override
The topological dimension of the cell.
Definition: vtkVoxel.h:65
vtkVoxel::GetFace
vtkCell * GetFace(int faceId) override
Return the face cell from the faceId of the cell.
vtkVoxel
a cell that represents a 3D orthogonal parallelepiped
Definition: vtkVoxel.h:45