vtkPolyhedron.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkPolyhedron.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkPolyhedron_h
#define vtkPolyhedron_h
 
#include "vtkCell3D.h"
#include "vtkCommonDataModelModule.h" // For export macro
 
class vtkIdTypeArray;
class vtkCellArray;
class vtkTriangle;
class vtkQuad;
class vtkTetra;
class vtkPolygon;
class vtkLine;
class vtkPointIdMap;
class vtkIdToIdVectorMapType;
class vtkIdToIdMapType;
class vtkEdgeTable;
class vtkPolyData;
class vtkCellLocator;
class vtkGenericCell;
class vtkPointLocator;
 
class VTKCOMMONDATAMODEL_EXPORT vtkPolyhedron : public vtkCell3D
{
public:
 
  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");
  }
  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
  VTK_DEPRECATED_IN_9_0_0("Replaced by vtkPolyhedron::GetEdgePoints(vtkIdType, const vtkIdType*&)")
  void GetEdgePoints(int vtkNotUsed(edgeId), int*& vtkNotUsed(pts)) override
  {
    vtkErrorMacro(<< "vtkPolyhedron::GetEdgePoints Not Implemented. "
                     "Also note that this signature is deprecated. "
                     "Please use GetEdgePoints(vtkIdType, const vtkIdType*& instead");
  };
  vtkIdType GetFacePoints(vtkIdType vtkNotUsed(faceId), const vtkIdType*& vtkNotUsed(pts)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetFacePoints Not Implemented");
    return 0;
  }
  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
  VTK_DEPRECATED_IN_9_0_0("Replaced by vtkPolyhedron::GetFacePoints(vtkIdType, const vtkIdType*&)")
  void GetFacePoints(int vtkNotUsed(faceId), int*& vtkNotUsed(pts)) override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetFacePoints Not Implemented. "
                       "Also note that this signature is deprecated. "
                       "Please use GetFacePoints(vtkIdType, const vtkIdType*& instead");
  };
  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 vtkNotUsed(centroid)[3]) const override
  {
    vtkWarningMacro(<< "vtkPolyhedron::GetCentroid Not Implemented");
    return false;
  }
 
  double* GetParametricCoords() override;
 
  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;
 
  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 Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
 
  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() override { return 1; }
 
 
  void InterpolateFunctions(const double x[3], double* sf) override;
  void InterpolateDerivs(const double x[3], double* derivs) override;
 
 
  int RequiresExplicitFaceRepresentation() override { return 1; }
  void SetFaces(vtkIdType* faces) override;
  vtkIdType* GetFaces() override;
 
  int IsInside(const double x[3], double tolerance);
 
  bool IsConvex();
 
  vtkPolyData* GetPolyData();
 
protected:
  vtkPolyhedron();
  ~vtkPolyhedron() override;
 
  // Internal classes for supporting operations on this cell
  vtkLine* Line;
  vtkTriangle* Triangle;
  vtkQuad* Quad;
  vtkPolygon* Polygon;
  vtkTetra* Tetra;
  vtkIdTypeArray* GlobalFaces; // these are numbered in global id space
  vtkIdTypeArray* FaceLocations;
 
  // vtkCell has the data members Points (x,y,z coordinates) and PointIds
  // (global cell ids corresponding to cell canonical numbering (0,1,2,....)).
  // These data members are implicitly organized in canonical space, i.e., where
  // the cell point ids are (0,1,...,npts-1). The PointIdMap maps global point id
  // back to these canonoical point ids.
  vtkPointIdMap* PointIdMap;
 
  // If edges are needed. Note that the edge numbering is in
  // canonical space.
  int EdgesGenerated;        // true/false
  vtkEdgeTable* EdgeTable;   // keep track of all edges
  vtkIdTypeArray* Edges;     // edge pairs kept in this list, in canonical id space
  vtkIdTypeArray* EdgeFaces; // face pairs that comprise each edge, with the
                             // same ordering as EdgeTable
  int GenerateEdges();       // method populates the edge table and edge array
 
  // If faces need renumbering into canonical numbering space these members
  // are used. When initiallly loaded, the face numbering uses global dataset
  // ids. Once renumbered, they are converted to canonical space.
  vtkIdTypeArray* Faces; // these are numbered in canonical id space
  int FacesGenerated;
  void GenerateFaces();
 
  // Bounds management
  int BoundsComputed;
  void ComputeBounds();
  void ComputeParametricCoordinate(const double x[3], double pc[3]);
  void ComputePositionFromParametricCoordinate(const double pc[3], double x[3]);
 
  void GeneratePointToIncidentFacesAndValenceAtPoint();
 
  // Members for supporting geometric operations
  int PolyDataConstructed;
  vtkPolyData* PolyData;
  vtkCellArray* Polys;
  void ConstructPolyData();
  int LocatorConstructed;
  vtkCellLocator* CellLocator;
  void ConstructLocator();
  vtkIdList* CellIds;
  vtkGenericCell* Cell;
 
  // Members used in GetPointToIncidentFaces
  vtkIdType** PointToIncidentFaces;
  vtkIdType* ValenceAtPoint;
 
private:
  vtkPolyhedron(const vtkPolyhedron&) = delete;
  void operator=(const vtkPolyhedron&) = delete;
};
 
//----------------------------------------------------------------------------
inline int vtkPolyhedron::GetParametricCenter(double pcoords[3])
{
  pcoords[0] = pcoords[1] = pcoords[2] = 0.5;
  return 0;
}
 
#endif