GeomAlgoAPI_ShapeTools.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef GeomAlgoAPI_ShapeTools_H_
#define GeomAlgoAPI_ShapeTools_H_
 
#include "GeomAlgoAPI.h"
 
#include <GeomAPI_Shape.h>
#include <GeomAPI_Vertex.h>
#include <GeomAPI_Pnt.h>
#include <map>
#include <set>
#ifdef WIN32
#include<array>
#endif
 
class GeomAPI_Ax1;
class GeomAPI_Edge;
class GeomAPI_Dir;
class GeomAPI_Face;
class GeomAPI_PlanarEdges;
class GeomAPI_Pln;
class GeomAPI_Pnt;
class GeomAPI_Wire;
class GeomDataAPI_Point2D;
class ModelAPI_Object;
 
class GeomAlgoAPI_ShapeTools
{
public:
  GEOMALGOAPI_EXPORT static double length(const std::shared_ptr<GeomAPI_Shape> theShape);
 
  GEOMALGOAPI_EXPORT static double volume(const std::shared_ptr<GeomAPI_Shape> theShape);
 
  GEOMALGOAPI_EXPORT static double area(const std::shared_ptr<GeomAPI_Shape> theShape);
 
  GEOMALGOAPI_EXPORT static bool isContinuousFaces(const GeomShapePtr& theFace1,
                                                   const GeomShapePtr& theFace2,
                                                   const GeomPointPtr& thePoint,
                                                   const double & theAngle,
                                                   std::string& theError);
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pnt>
    centreOfMass(const std::shared_ptr<GeomAPI_Shape> theShape);
 
  GEOMALGOAPI_EXPORT static double radius(const std::shared_ptr<GeomAPI_Face>& theCylinder);
 
  GEOMALGOAPI_EXPORT static double minimalDistance(const GeomShapePtr& theShape1,
                                                   const GeomShapePtr& theShape2);
  GEOMALGOAPI_EXPORT static double minimalDistance(const GeomShapePtr& theShape1,
                                                   const GeomShapePtr& theShape2,
                                                   std::array<double, 3> & fromShape1To2);
 
  GEOMALGOAPI_EXPORT static double shapeProximity(const GeomShapePtr& theShape1,
                                                  const GeomShapePtr& theShape2);
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> combineShapes(
    const std::shared_ptr<GeomAPI_Shape> theCompound,
    const GeomAPI_Shape::ShapeType theType, ListOfShape& theResults);
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape>
    groupSharedTopology(const std::shared_ptr<GeomAPI_Shape> theCompound);
 
  GEOMALGOAPI_EXPORT static bool hasSharedTopology(const ListOfShape& theShapes,
                                                   const GeomAPI_Shape::ShapeType theShapeType);
 
  GEOMALGOAPI_EXPORT static
    std::list<std::shared_ptr<GeomAPI_Pnt> > getBoundingBox(const ListOfShape& theShapes,
                                                            const double theEnlarge = 0.0);
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Face> fitPlaneToBox(
    const std::shared_ptr<GeomAPI_Shape> thePlane,
    const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints);
 
  GEOMALGOAPI_EXPORT static void findBounds(const std::shared_ptr<GeomAPI_Shape> theShape,
                                            std::shared_ptr<GeomAPI_Vertex>& theV1,
                                            std::shared_ptr<GeomAPI_Vertex>& theV2);
 
  GEOMALGOAPI_EXPORT static void makeFacesWithHoles(const std::shared_ptr<GeomAPI_Pnt> theOrigin,
                                                const std::shared_ptr<GeomAPI_Dir> theDirection,
                                                const ListOfShape& theWires,
                                                ListOfShape& theFaces);
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Pln> findPlane(const ListOfShape& theShapes);
 
  GEOMALGOAPI_EXPORT static bool isSubShapeInsideShape(
    const std::shared_ptr<GeomAPI_Shape> theSubShape,
    const std::shared_ptr<GeomAPI_Shape> theBaseShape);
 
  GEOMALGOAPI_EXPORT static bool isShapeValid(const std::shared_ptr<GeomAPI_Shape> theShape);
 
  GEOMALGOAPI_EXPORT static
    std::shared_ptr<GeomAPI_Shape> getFaceOuterWire(const std::shared_ptr<GeomAPI_Shape> theFace);
 
  GEOMALGOAPI_EXPORT static bool isTangent(const std::shared_ptr<GeomAPI_Edge> theEdge1,
                                           const std::shared_ptr<GeomAPI_Edge> theEdge2,
                                           const std::shared_ptr<GeomAPI_Vertex> theTgPoint);
 
  GEOMALGOAPI_EXPORT static bool isParallel(const std::shared_ptr<GeomAPI_Edge> theEdge,
                                            const std::shared_ptr<GeomAPI_Face> theFace);
 
  GEOMALGOAPI_EXPORT static std::list<std::shared_ptr<GeomAPI_Vertex> > intersect(
    const std::shared_ptr<GeomAPI_Edge> theEdge, const std::shared_ptr<GeomAPI_Face> theFace);
 
  typedef std::map<std::shared_ptr<GeomAPI_Pnt>,
                   std::pair<std::list<std::shared_ptr<GeomDataAPI_Point2D> >,
                             std::list<std::shared_ptr<ModelAPI_Object> > > > PointToRefsMap;
  GEOMALGOAPI_EXPORT static void splitShape(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
                                      const PointToRefsMap& thePointsInfo,
                                      std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
 
  GEOMALGOAPI_EXPORT static void splitShape_p(const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
                                      const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
                                      std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> findShape(
                                    const std::list<std::shared_ptr<GeomAPI_Pnt> >& thePoints,
                                    const std::set<std::shared_ptr<GeomAPI_Shape> >& theShapes);
 
#ifdef FEATURE_MULTIROTATION_TWO_DIRECTIONS
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Dir> buildDirFromAxisAndShape(
                                    const std::shared_ptr<GeomAPI_Shape> theBaseShape,
                                    const std::shared_ptr<GeomAPI_Ax1> theAxis);
#endif
 
  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Edge> wireToEdge(
      const std::shared_ptr<GeomAPI_Wire>& theWire);
 
  GEOMALGOAPI_EXPORT static ListOfShape getLowLevelSubShapes(const GeomShapePtr& theShape);
 
  GEOMALGOAPI_EXPORT static void computeThroughAll(const ListOfShape& theObjects,
                                                   const ListOfShape& theBaseShapes,
                                                   const std::shared_ptr<GeomAPI_Dir> theDir,
                                                   double& theToSize, double& theFromSize);
 
  GEOMALGOAPI_EXPORT static ListOfShape getSharedFaces(const GeomShapePtr& theShape);
};
 
#endif