VTK
vtkPyramid.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPyramid.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 =========================================================================*/
37 #ifndef vtkPyramid_h
38 #define vtkPyramid_h
39 
40 #include "vtkCommonDataModelModule.h" // For export macro
41 #include "vtkCell3D.h"
42 
43 class vtkLine;
44 class vtkQuad;
45 class vtkTriangle;
48 
49 class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
50 {
51 public:
52  static vtkPyramid *New();
53  vtkTypeMacro(vtkPyramid,vtkCell3D);
54  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
55 
57 
60  void GetEdgePoints(int edgeId, int* &pts) VTK_OVERRIDE;
61  void GetFacePoints(int faceId, int* &pts) VTK_OVERRIDE;
63 
65 
68  int GetCellType() VTK_OVERRIDE {return VTK_PYRAMID;}
69  int GetCellDimension() VTK_OVERRIDE {return 3;}
70  int GetNumberOfEdges() VTK_OVERRIDE {return 8;}
71  int GetNumberOfFaces() VTK_OVERRIDE {return 5;}
72  vtkCell *GetEdge(int edgeId) VTK_OVERRIDE;
73  vtkCell *GetFace(int faceId) VTK_OVERRIDE;
74  int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) VTK_OVERRIDE;
75  void Contour(double value, vtkDataArray *cellScalars,
77  vtkCellArray *lines, vtkCellArray *polys,
78  vtkPointData *inPd, vtkPointData *outPd,
79  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) VTK_OVERRIDE;
80  int EvaluatePosition(double x[3], double* closestPoint,
81  int& subId, double pcoords[3],
82  double& dist2, double *weights) VTK_OVERRIDE;
83  void EvaluateLocation(int& subId, double pcoords[3], double x[3],
84  double *weights) VTK_OVERRIDE;
85  int IntersectWithLine(double p1[3], double p2[3], double tol, double& t,
86  double x[3], double pcoords[3], int& subId) VTK_OVERRIDE;
87  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) VTK_OVERRIDE;
88  void Derivatives(int subId, double pcoords[3], double *values,
89  int dim, double *derivs) VTK_OVERRIDE;
90  double *GetParametricCoords() VTK_OVERRIDE;
92 
96  int GetParametricCenter(double pcoords[3]) VTK_OVERRIDE;
97 
101  static void InterpolationFunctions(double pcoords[3], double weights[5]);
105  static void InterpolationDerivs(double pcoords[3], double derivs[15]);
107 
111  void InterpolateFunctions(double pcoords[3], double weights[5]) VTK_OVERRIDE
112  {
113  vtkPyramid::InterpolationFunctions(pcoords,weights);
114  }
115  void InterpolateDerivs(double pcoords[3], double derivs[15]) VTK_OVERRIDE
116  {
117  vtkPyramid::InterpolationDerivs(pcoords,derivs);
118  }
120 
121  int JacobianInverse(double pcoords[3], double **inverse, double derivs[15]);
122 
124 
128  static int *GetEdgeArray(int edgeId);
129  static int *GetFaceArray(int faceId);
131 
132 protected:
134  ~vtkPyramid() VTK_OVERRIDE;
135 
136  vtkLine *Line;
137  vtkTriangle *Triangle;
138  vtkQuad *Quad;
139 
140 private:
141  vtkPyramid(const vtkPyramid&) VTK_DELETE_FUNCTION;
142  void operator=(const vtkPyramid&) VTK_DELETE_FUNCTION;
143 };
144 
145 //----------------------------------------------------------------------------
146 inline int vtkPyramid::GetParametricCenter(double pcoords[3])
147 {
148  pcoords[0] = pcoords[1] = 0.4;
149  pcoords[2] = 0.2;
150  return 0;
151 }
152 
153 #endif
154 
155 
156 
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkPyramid::GetFaceArray
static int * GetFaceArray(int faceId)
vtkPyramid::EvaluatePosition
int EvaluatePosition(double x[3], double *closestPoint, 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...
vtkPyramid::GetEdgePoints
void GetEdgePoints(int edgeId, int *&pts) override
See vtkCell3D API for description of these methods.
vtkPyramid::IntersectWithLine
int IntersectWithLine(double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
Intersect with a ray.
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:38
vtkX3D::value
@ value
Definition: vtkX3D.h:220
vtkPyramid::InterpolationFunctions
static void InterpolationFunctions(double pcoords[3], double weights[5])
vtkPyramid::GetCellType
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:68
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkPyramid::New
static vtkPyramid * New()
vtkPyramid::GetEdgeArray
static int * GetEdgeArray(int edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
vtkPyramid::GetEdge
vtkCell * GetEdge(int edgeId) override
Return the edge cell from the edgeId of the cell.
vtkPyramid::GetFace
vtkCell * GetFace(int faceId) override
Return the face cell from the faceId of the cell.
vtkPyramid::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkPyramid.h:71
vtkPyramid::InterpolateDerivs
void InterpolateDerivs(double pcoords[3], double derivs[15]) override
Definition: vtkPyramid.h:115
vtkPyramid
a 3D cell that represents a linear pyramid
Definition: vtkPyramid.h:50
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
VTK_PYRAMID
@ VTK_PYRAMID
Definition: vtkCellType.h:59
vtkPyramid::JacobianInverse
int JacobianInverse(double pcoords[3], double **inverse, double derivs[15])
vtkCell3D.h
vtkLine
cell represents a 1D line
Definition: vtkLine.h:36
vtkPyramid::vtkPyramid
vtkPyramid()
vtkPyramid::EvaluateLocation
void EvaluateLocation(int &subId, double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
vtkCell3D
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:39
vtkPyramid::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.
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:60
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
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
vtkPyramid::Derivatives
void Derivatives(int subId, double pcoords[3], double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
vtkTriangle
a cell that represents a triangle
Definition: vtkTriangle.h:42
vtkPyramid::Triangulate
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
vtkPyramid::GetCellDimension
int GetCellDimension() override
The topological dimension of the cell.
Definition: vtkPyramid.h:69
vtkPyramid::CellBoundary
int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) override
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
vtkPyramid::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkUnstructuredGrid
dataset represents arbitrary combinations of all possible cell types
Definition: vtkUnstructuredGrid.h:83
vtkPyramid::InterpolationDerivs
static void InterpolationDerivs(double pcoords[3], double derivs[15])
vtkPyramid::~vtkPyramid
~vtkPyramid() override
vtkPyramid::GetFacePoints
void GetFacePoints(int faceId, int *&pts) override
Get the list of vertices that define a face.
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkPyramid::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkPyramid.h:70
vtkQuad
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:42
vtkPyramid::GetParametricCoords
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.