vtkPolyhedron.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 vtkPolyhedron_h
#define vtkPolyhedron_h

#include "vtkCell3D.h"
#include "vtkCellStatus.h"            // For enum.
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // VTK_DEPRECATED_IN_9_6_0()
#include "vtkNew.h"                   // For vtkNew

VTK_ABI_NAMESPACE_BEGIN
class vtkIdTypeArray;
class vtkCellArray;
class vtkTriangle;
class vtkQuad;
class vtkTetra;
class vtkPolygon;
class vtkLine;
class vtkEdgeTable;
class vtkPolyData;
class vtkCellLocator;
class vtkGenericCell;
class vtkPolyhedronContour;
class vtkUnstructuredGrid;

class VTKCOMMONDATAMODEL_EXPORT vtkPolyhedron : public vtkCell3D
{
public:
  using vtkPointIdMap = std::map<vtkIdType, vtkIdType>;

  using Status = vtkCellStatus;


  static vtkPolyhedron* New();
  vtkTypeMacro(vtkPolyhedron, vtkCell3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void GetEdgePoints(vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetEdgePoints Not Implemented");
  }
  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
  void GetEdgeToAdjacentFaces(
    vtkIdType vtkNotUsed(edgeId), const vtkIdType*& vtkNotUsed(pts)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetEdgeToAdjacentFaces Not Implemented");
  }
  vtkIdType GetFaceToAdjacentFaces(
    vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(faceIds)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetFaceToAdjacentFaces Not Implemented");
    return 0;
  }
  vtkIdType GetPointToIncidentEdges(
    vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(edgeIds)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetPointToIncidentEdges Not Implemented");
    return 0;
  }
  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
  vtkIdType GetPointToOneRingPoints(
    vtkIdType vtkNotUsed(pointId), const vtkIdType*& vtkNotUsed(pts)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetPointToOneRingPoints Not Implemented");
    return 0;
  }
  bool GetCentroid(double centroid[3]) const override;

  double ComputeVolume();

  int GetCellType() override { return VTK_POLYHEDRON; }

  int RequiresInitialization() override { return 1; }

  void Initialize() override;


  int GetNumberOfEdges() override;
  vtkCell* GetEdge(int) override;
  int GetNumberOfFaces() override;
  vtkCell* GetFace(int faceId) override;

  void Contour(double value, vtkDataArray* scalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
    vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;

  void Clip(double value, vtkDataArray* scalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
    vtkIdType cellId, vtkCellData* outCd, int insideOut) override;

  void ClipWithContext(double value, vtkDataArray* scalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
    vtkIdType cellId, vtkCellData* outCd, int insideOut, vtkCellArray* outFaces,
    vtkCellArray* outFaceLocs);

  void ClipWithContext(double value, vtkDataArray* scalars, vtkIncrementalPointLocator* locator,
    vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
    vtkIdType cellId, vtkCellData* outCd, int insideOut, vtkUnstructuredGrid* outUG);

  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;

  int TriangulateFaces(vtkIdList* newFaces);

  int TriangulateFaces(vtkCellArray* newFaces);

  void Derivatives(
    int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;

  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;

  int GetParametricCenter(double pcoords[3]) override;

  int IsPrimaryCell() VTK_FUTURE_CONST override { return 1; }


  void InterpolateFunctions(const double x[3], double* sf) override;
  void InterpolateDerivs(const double x[3], double* derivs) override;

  int RequiresExplicitFaceRepresentation() VTK_FUTURE_CONST override { return 1; }

  VTK_DEPRECATED_IN_9_6_0("This function is deprecated, use SetCellFaces")
  void SetFaces(vtkIdType* faces);

  VTK_DEPRECATED_IN_9_6_0("This function is deprecated, use GetCellFaces")
  vtkIdType* GetFaces();

  int SetCellFaces(vtkCellArray* faces);


  vtkCellArray* GetCellFaces();
  void GetCellFaces(vtkCellArray* faces);

  int IsInside(const double x[3], double tolerance);

  bool IsConvex();
  Status IsConvex(double planarThreshold);

  vtkPolyData* GetPolyData();

  void ShallowCopy(vtkCell* c) override;

  void DeepCopy(vtkCell* c) override;

protected:
  vtkPolyhedron();
  ~vtkPolyhedron() override;

  // Internal classes for supporting operations on this cell
  vtkNew<vtkLine> Line;
  vtkNew<vtkTriangle> Triangle;
  vtkNew<vtkQuad> Quad;
  vtkNew<vtkPolygon> Polygon;
  vtkNew<vtkTetra> Tetra;

  // Filled with the SetFaces method.
  // These faces are numbered in global id space
  vtkNew<vtkCellArray> GlobalFaces;

  // VTK_DEPRECATED_IN_9_6_0()
  // Backward compatibility
  vtkNew<vtkIdTypeArray> LegacyGlobalFaces;

  // If edges are needed. Note that the edge numbering is in canonical space.
  int EdgesGenerated = 0;           // true/false
  vtkNew<vtkEdgeTable> EdgeTable;   // keep track of all edges
  vtkNew<vtkIdTypeArray> Edges;     // edge pairs kept in this list, in canonical id space
  vtkNew<vtkIdTypeArray> EdgeFaces; // face pairs that comprise each edge, with the
                                    // same ordering as EdgeTable
  int GenerateEdges();              // method populates the edge table and edge array

  // Numerous methods needs faces to be numbered in the canonical space.
  // This method uses PointIdMap to fill the Faces member (faces described
  // with canonical IDs) from the GlobalFaces member (faces described with
  // global IDs).
  void GenerateFaces();
  vtkNew<vtkCellArray> Faces; // These are numbered in canonical id space
  int FacesGenerated = 0;     // True when Faces have been successfully constructed

  // Bounds management
  int BoundsComputed = 0;
  void ComputeBounds();
  void ComputeParametricCoordinate(const double x[3], double pc[3]);
  void ComputePositionFromParametricCoordinate(const double pc[3], double x[3]);

  // Members for supporting geometric operations
  int PolyDataConstructed = 0;
  vtkNew<vtkPolyData> PolyData;
  void ConstructPolyData();
  int LocatorConstructed = 0;
  vtkNew<vtkCellLocator> CellLocator;
  void ConstructLocator();
  vtkNew<vtkIdList> CellIds;
  vtkNew<vtkGenericCell> Cell;

private:
  vtkPolyhedron(const vtkPolyhedron&) = delete;
  void operator=(const vtkPolyhedron&) = delete;

  friend class vtkPolyhedronUtilities;
  friend class vtkPolyhedronContour;

  // vtkCell has the data members Points (x,y,z coordinates) and PointIds (global cell ids).
  // These data members are implicitly organized in canonical space, i.e., where the cell
  // point ids are (0,1,...,npts-1).
  // The PointIdMap is constructed during the call of the Initialize() method and maps global
  // point ids to the canonical point ids.
  vtkPointIdMap PointIdMap;

  void GeneratePointToIncidentFaces();

  // This variant of GenerateEdges() always regenerates edges but also populates
  // \a unevenCoedges with a map from edge ID to the signed number of mismatched coedges.
  int GenerateEdges(std::map<vtkIdType, int>& unevenCoedges);

  // Members used in GetPointToIncidentFaces
  std::vector<std::vector<vtkIdType>> PointToIncidentFaces;
};

VTK_ABI_NAMESPACE_END
#endif