X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_ShapeTools.h;h=42f87c8626ce40d8725329917da8a7305cc5d41c;hb=74b81005e210f0269c129547d17cd3c13807a645;hp=c367d6867846bb36da2de8b2565c61a104e66e3d;hpb=de65be6c9f19bdf26ecb91fd3afd51c4d54e8d4a;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h b/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h index c367d6867..42f87c862 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h @@ -1,47 +1,184 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: GeomAlgoAPI_ShapeTools.h -// Created: 3 August 2015 -// Author: Dmitry Bobylev +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// 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 -#include +#include "GeomAlgoAPI.h" + #include +#include #include +#include + +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 - * \ingroup DataAlgo - * \brief Useful tools for working with shapes. - */ -class GEOMALGOAPI_EXPORT GeomAlgoAPI_ShapeTools +/// \class GeomAlgoAPI_ShapeTools +/// \ingroup DataAlgo +/// \brief Useful tools for working with shapes. +class GeomAlgoAPI_ShapeTools { public: /// \return the total volume of the solids of the current shape or 0.0 if it can be computed. - static double volume(std::shared_ptr theShape); - - /// \return the centre of mass of the current face. The coordinates returned for the center of mass - /// are expressed in the absolute Cartesian coordinate system. (This function works only for surfaces). - static std::shared_ptr centreOfMass(std::shared_ptr theShape); - - /** \brief Combines faces with common edges to shells, or solids to compsolids. - * \param[in] theCompound compound of shapes. - * \param[in] theType type of combine. - * \param[out] theCombinedShapes resulting shapes. - * \param[out] theFreeShapes shapes that does not have common subshapes. - */ - static void combineShapes(const std::shared_ptr theCompound, - const GeomAPI_Shape::ShapeType theType, - ListOfShape& theCombinedShapes, - ListOfShape& theFreeShapes); - - /** - * Returns infinite plane received from theFace plane - */ - static std::shared_ptr faceToInfinitePlane(const std::shared_ptr& theFace); + GEOMALGOAPI_EXPORT static double volume(const std::shared_ptr theShape); + + /// \return the total area of the faces of the current shape or 0.0 if it can be computed. + GEOMALGOAPI_EXPORT static double area(const std::shared_ptr theShape); + + /// \return the centre of mass of the current face. + /// The coordinates returned for the center of mass + /// are expressed in the absolute Cartesian coordinate system. + /// (This function works only for surfaces). + GEOMALGOAPI_EXPORT static std::shared_ptr + centreOfMass(const std::shared_ptr theShape); + + /// \brief Combines faces with common edges to shells, or solids to compsolids. + /// \param[in] theCompound compound of shapes. + /// \param[in] theType type of combine. + /// \param[out] theCombinedShapes resulting shapes. + /// \param[out] theFreeShapes shapes that does not have common subshapes. + GEOMALGOAPI_EXPORT static std::shared_ptr combineShapes( + const std::shared_ptr theCompound, + const GeomAPI_Shape::ShapeType theType, + ListOfShape& theCombinedShapes, + ListOfShape& theFreeShapes); + + /// \brief Groups shapes with shared topology to compounds. + /// \param[in] theCompound compound of shapes. + /// \return compound of compounds with shared topology. + GEOMALGOAPI_EXPORT static std::shared_ptr + groupSharedTopology(const std::shared_ptr theCompound); + + /// \brief Calculates bounding box for theShapes + /// \return list of eight points. + /// \param[in] theShapes list of shapes. + /// \param[in] theEnlarge enlarges bounding box size. + GEOMALGOAPI_EXPORT static + std::list > getBoundingBox(const ListOfShape& theShapes, + const double theEnlarge = 0.0); + + /// \return infinite plane received from theFace plane. + GEOMALGOAPI_EXPORT static std::shared_ptr + faceToInfinitePlane(const std::shared_ptr theFace); + + /// \brief Enlarges or reduces plane to fit bounding box. + /// \return plane that fits to bounding box. + /// \param[in] thePlane base plane. + /// \param[in] thePoints bounding box points (shoud be eight). + GEOMALGOAPI_EXPORT static std::shared_ptr fitPlaneToBox( + const std::shared_ptr thePlane, + const std::list >& thePoints); + + /// \brief Finds the start and end vertices of theShape. theShape can be of the following type:\n + /// Vertex: theV1 and theV2 are the same and equal to theShape;\n + /// Edge : theV1 is start and theV2 is end vertex;\n + /// Wire : theV1 is start vertex of the first edge, theV2 is end vertex of the last edge. If wire + /// contains no edges theV1 and theV2 are nullified.\n + /// If none of the above theV1 and theV2 are nullified. + GEOMALGOAPI_EXPORT static void findBounds(const std::shared_ptr theShape, + std::shared_ptr& theV1, + std::shared_ptr& theV2); + + /// \brief Creates faces with holes from wires. + /// \param[in] theWires base wires. + /// \param[out] theFaces resulting faces. + GEOMALGOAPI_EXPORT static void makeFacesWithHoles(const std::shared_ptr theOrigin, + const std::shared_ptr theDirection, + const ListOfShape& theWires, + ListOfShape& theFaces); + + /// \brief Return a plane for list of shapes if they are all planar. + /// \param[in] theShapes shapes to find plane. + /// \return plane where all shapes lie or empty ptr if they not planar. + GEOMALGOAPI_EXPORT static std::shared_ptr findPlane(const ListOfShape& theShapes); + + /// \brief Checks that vertex/edge is inside face or vertext inside wire. + /// \param[in] theSubShape shape that should be inside. + /// \param[in] theBaseShape base shape. + /// \return true if edge inside the face. + GEOMALGOAPI_EXPORT static bool isSubShapeInsideShape( + const std::shared_ptr theSubShape, + const std::shared_ptr theBaseShape); + + /// \return true if theShape is valid. + GEOMALGOAPI_EXPORT static bool isShapeValid(const std::shared_ptr theShape); + + /// \return outer wire for face. If theShape has different type returns empty pointer. + GEOMALGOAPI_EXPORT static + std::shared_ptr getFaceOuterWire(const std::shared_ptr theFace); + + /// \return true if edge is parallel to face. + GEOMALGOAPI_EXPORT static bool isParallel(const std::shared_ptr theEdge, + const std::shared_ptr theFace); + + // Computes intersection point between the edge curve and a face surface (only one point, with + // preferences to point that belongs to edge and face boundaries. + /// \returns null if there is no intersection + GEOMALGOAPI_EXPORT static std::list > intersect( + const std::shared_ptr theEdge, const std::shared_ptr theFace, + const bool thePointsOutsideFace); + + typedef std::map, + std::pair >, + std::list > > > PointToRefsMap; + /// \brief Performs the split of the shape by points. + /// \param[in] theBaseShape shape that should be splitted. + /// \param[in] thePoints container of points to split + /// \param[out] theShapes container of shapes after split + GEOMALGOAPI_EXPORT static void splitShape(const std::shared_ptr& theBaseShape, + const PointToRefsMap& thePointsInfo, + std::set >& theShapes); + + /// \brief Performs the split of the shape by points. + /// \param[in] theBaseShape shape that should be splitted. + /// \param[in] thePoints container of points to split + /// \param[out] theShapes container of shapes after split + GEOMALGOAPI_EXPORT static void splitShape_p(const std::shared_ptr& theBaseShape, + const std::list >& thePoints, + std::set >& theShapes); + + GEOMALGOAPI_EXPORT static std::shared_ptr findShape( + const std::list >& thePoints, + const std::set >& theShapes); + + /// \brief Returns a dir from a shape and an axis. + /// \param[in] theBaseShape shape whose center of mass serves as the starting point of the dir. + /// \param[in] theAxis axis that serves as a direction for the dir + /// \return dir that builds from center of mass of the base shape and the axis + GEOMALGOAPI_EXPORT static std::shared_ptr buildDirFromAxisAndShape( + const std::shared_ptr theBaseShape, + const std::shared_ptr theAxis); + + /// \brief Reapproximate a wire to build a single edge + GEOMALGOAPI_EXPORT static std::shared_ptr wireToEdge( + const std::shared_ptr& theWire); }; #endif