X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_Boolean.h;h=1c3655d9b0fdcbbc13c4854d88064109da3079b9;hb=fe702b25ca5829b28290fe15dc8784c670dd995f;hp=9ca251863ef5a812ecc7479b340f8b5820424b52;hpb=a731f82dccbfdb67cbf8e8d617222a4d3e32018a;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h index 9ca251863..1c3655d9b 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h @@ -16,79 +16,76 @@ #include -/**\class GeomAlgoAPI_Boolean - * \ingroup DataAlgo - * \brief Allows to perform of boolean operations +/** \class GeomAlgoAPI_Boolean + * \ingroup DataAlgo + * \brief Allows to perform of boolean operations */ class GeomAlgoAPI_Boolean : public GeomAPI_Interface { +public: + enum OperationType{ + BOOL_CUT, + BOOL_FUSE, + BOOL_COMMON + }; + 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 std::shared_ptr makeCut( - std::shared_ptr theShape, - std::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 std::shared_ptr makeFuse( - std::shared_ptr theShape, - std::shared_ptr theTool); - - /**\brief Creates common boolean operation - * \param[in] theObject the main shape - * \param[in] theTool second shape - * \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 std::shared_ptr makeCommon( - std::shared_ptr theObject, - std::shared_ptr theTool); + GEOMALGOAPI_EXPORT static std::shared_ptr makeCommon(const ListOfShape& theObjects, + const ListOfShape& theTools); - enum { - BOOL_CUT, - BOOL_FUSE, - BOOL_COMMON - }; - /// Constructor - GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean (std::shared_ptr theObject, - std::shared_ptr theTool, - int theType); + /// 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 std::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(std::shared_ptr theObject, - std::shared_ptr theTool); - /// fields - double mySize; +private: + /// Fields. bool myDone; - int myOperation; - std::shared_ptr myShape; - GeomAPI_DataMapOfShapeShape myMap; - GeomAlgoAPI_MakeShape * myMkShape; + std::shared_ptr myShape; + std::shared_ptr myMap; + std::shared_ptr myMkShape; }; #endif