X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_Boolean.h;h=86e6dc9b80d7625354e6218af25289a0a6d2ebea;hb=de65be6c9f19bdf26ecb91fd3afd51c4d54e8d4a;hp=a46ab91a969f902f170e9e6821d1f6e13b7a89ce;hpb=5e2e5c8e92f1d022158ef717c711a8ea79e5dd13;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h index a46ab91a9..86e6dc9b8 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: GeomAlgoAPI_Boolean.h // Created: 02 Sept 2014 // Author: Vitaly Smetannikov @@ -6,85 +8,85 @@ #define GeomAlgoAPI_Boolean_H_ #include -#include #include + +#include +#include #include -#include -/**\class GeomAlgoAPI_Boolean - * \ingroup DataAlgo - * \brief Allows to perform of boolean operations +#include + +/** \class GeomAlgoAPI_Boolean + * \ingroup DataAlgo + * \brief Allows to perform of boolean operations */ class GeomAlgoAPI_Boolean : public GeomAPI_Interface { +public: + /// Type of booelan operation + enum OperationType{ + BOOL_CUT, ///< Cut objects + BOOL_FUSE, ///< Fuse objects + BOOL_COMMON ///< Take common part of objects + }; + public: - /* \brief Creates cut boolean operation - * \param[in] theShape the main shape - * \param[in] theTool toole shape for boolean - * \return a solid as result of operation + /** \brief Creates cut boolean operation. + * \param[in] theObjects the main shape. + * \param[in] theTools toole shape for boolean. + * \return a solid or compound of solids as result of operation. */ - GEOMALGOAPI_EXPORT static boost::shared_ptr makeCut( - boost::shared_ptr theShape, - boost::shared_ptr theTool); - - /* \brief Creates fuse boolean operation - * \param[in] theShape the main shape - * \param[in] theTool second shape - * \return a solid as result of operation + GEOMALGOAPI_EXPORT static std::shared_ptr makeCut(const ListOfShape& theObjects, + const ListOfShape& theTools); + + /** \brief Creates fuse boolean operation. + * \param[in] theObjects the main shape. + * \param[in] theTools second shape. + * \return a solid as result of operation. */ - GEOMALGOAPI_EXPORT static boost::shared_ptr makeFuse( - boost::shared_ptr theShape, - boost::shared_ptr theTool); - - /* \brief Creates common boolean operation - * \param[in] theObject the main shape - * \param[in] theTool second shape - * \param[in] theType type of the operation: Fuse, Cut, Common - * \return a solid as result of operation + GEOMALGOAPI_EXPORT static std::shared_ptr makeFuse(const ListOfShape& theObjects, + const ListOfShape& theTools); + + /** \brief Creates common boolean operation. + * \param[in] theObjects the main shape. + * \param[in] theTools second shape. + * \return a solid as result of operation. */ - GEOMALGOAPI_EXPORT static boost::shared_ptr makeCommon( - boost::shared_ptr theObject, - boost::shared_ptr theTool); - - enum { - BOOL_CUT, - BOOL_FUSE, - BOOL_COMMON - }; - /// Constructor - GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean (boost::shared_ptr theObject, - boost::shared_ptr theTool, - int theType); + GEOMALGOAPI_EXPORT static std::shared_ptr makeCommon(const ListOfShape& theObjects, + const ListOfShape& theTools); + + /// Constructor. + GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const ListOfShape& theObjects, + const ListOfShape& theTools, + const OperationType theOperationType); - /// Returns True if algorithm succeed + /// \return true if algorithm succeed. GEOMALGOAPI_EXPORT const bool isDone() const; - /// Returns True if resulting shape is valid + /// \return true if resulting shape is valid. GEOMALGOAPI_EXPORT const bool isValid() const; - /// Returns result of the boolean algorithm which may be a Solid or a Face - GEOMALGOAPI_EXPORT const boost::shared_ptr& shape () const; - - /// Returns map of sub-shapes of the result. To be used for History keeping - GEOMALGOAPI_EXPORT void mapOfShapes (GeomAPI_DataMapOfShapeShape& theMap) const; + /// \return result of the boolean algorithm. + GEOMALGOAPI_EXPORT const std::shared_ptr& shape() const; + + /// \return map of sub-shapes of the result. To be used for History keeping. + GEOMALGOAPI_EXPORT std::shared_ptr mapOfShapes() const; - /// Return interface for for History processing - GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape* makeShape () const; + /// \return interface for for History processing. + GEOMALGOAPI_EXPORT std::shared_ptr makeShape() const; - ///Destructor - GEOMALGOAPI_EXPORT ~GeomAlgoAPI_Boolean(); +private: + /// Builds resulting shape. + void build(const ListOfShape& theObjects, + const ListOfShape& theTools, + const OperationType theOperationType); - private: - /// builds resulting shape - void build(boost::shared_ptr theObject, - boost::shared_ptr theTool); - /// fields - double mySize; +private: + /// Fields. bool myDone; - int myOperation; - boost::shared_ptr myShape; - GeomAPI_DataMapOfShapeShape myMap; - GeomAlgoAPI_MakeShape * myMkShape; + std::shared_ptr myShape; + std::shared_ptr myMap; + std::shared_ptr myMkShape; }; #endif