vtkPyramid.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkPyramid_h
#define vtkPyramid_h
 
#include "vtkCell3D.h"
#include "vtkCommonDataModelModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkLine;
class vtkQuad;
class vtkTriangle;
class vtkUnstructuredGrid;
class vtkIncrementalPointLocator;
 
class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
{
public:
  static vtkPyramid* New();
  vtkTypeMacro(vtkPyramid, vtkCell3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkCellTypeTraitsMembersMacro(VTK_PYRAMID);


  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
  bool GetCentroid(double centroid[3]) const override;
  bool IsInsideOut() override;


  int GetCellType() override { return Traits::CellType; }
  int GetCellDimension() override { return Traits::Dimension; }
  int GetNumberOfEdges() override { return Traits::NumberOfEdges; }
  int GetNumberOfFaces() override { return Traits::NumberOfFaces; }
  vtkCell* GetEdge(int edgeId) override;
  vtkCell* GetFace(int faceId) override;
  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
  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;
  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
    vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
    double& dist2, double weights[]) override;
  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
    double pcoords[3], int& subId) override;
  int TriangulateLocalIds(int index, vtkIdList* ptIds) override;
  void Derivatives(
    int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
  double* GetParametricCoords() override;

  VTK_DEPRECATED_IN_9_7_0("Use vtkMarchingCellsContourCases::GetPyramidCase instead.")
  static int* GetTriangleCases(int caseId);

  int GetParametricCenter(double pcoords[3]) override;
 
  static void InterpolationFunctions(const double pcoords[3], double weights[5]);
  static void InterpolationDerivs(const double pcoords[3], double derivs[15]);

  void InterpolateFunctions(const double pcoords[3], double weights[5]) override
  {
    vtkPyramid::InterpolationFunctions(pcoords, weights);
  }
  void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
  {
    vtkPyramid::InterpolationDerivs(pcoords, derivs);
  }

 
  int JacobianInverse(const double pcoords[3], double** inverse, double derivs[15]);


  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);

  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);

  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);

  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(4);

  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(4);

  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(4);

  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
 
protected:
  vtkPyramid();
  ~vtkPyramid() override = default;
 
  vtkSmartPointer<vtkLine> Line;
  vtkSmartPointer<vtkTriangle> Triangle;
  vtkSmartPointer<vtkQuad> Quad;
 
private:
  vtkPyramid(const vtkPyramid&) = delete;
  void operator=(const vtkPyramid&) = delete;
};
 
//----------------------------------------------------------------------------
inline int vtkPyramid::GetParametricCenter(double pcoords[3])
{
  pcoords[0] = pcoords[1] = 0.4;
  pcoords[2] = 0.2;
  return 0;
}
 
VTK_ABI_NAMESPACE_END
#endif