X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_MakeShape.h;h=acbc9c84fbf5247c7820ee6dad889bf833986089;hb=b2a662eec6a0258d51a67ee7e341541e7a710752;hp=272f9f9750f468786ba35f961d0bec8060713a32;hpb=cbde248859fb0072f6012907391ea90cfc254574;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h index 272f9f975..acbc9c84f 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h @@ -12,27 +12,26 @@ #include #include -/** \class GeomAlgoAPI_MakeShape - * \ingroup DataAlgo - * \brief Interface to the root class of all topological shapes constructions - */ +/// \class GeomAlgoAPI_MakeShape +/// \ingroup DataAlgo +/// \brief Interface to the root class of all topological shapes constructions class GeomAlgoAPI_MakeShape : public GeomAPI_Interface { public: /// Builder type enum enum BuilderType { OCCT_BRepBuilderAPI_MakeShape, - OCCT_BOPAlgo_Builder + OCCT_BOPAlgo_Builder, + UNKNOWN }; public: /// \brief Empty constructor. GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(); - /** \brief Constructor by builder and builder type. - * \param[in] theBuilder pointer to the builder. - * \param[in] theBuilderType builder type. - */ + /// \brief Constructor by builder and builder type. + /// \param[in] theBuilder pointer to the builder. + /// \param[in] theBuilderType builder type. template explicit GeomAlgoAPI_MakeShape(T* theBuilder, const BuilderType theBuilderType = OCCT_BRepBuilderAPI_MakeShape) : GeomAPI_Interface(theBuilder), myBuilderType(theBuilderType) @@ -40,10 +39,9 @@ public: initialize(); } - /** \brief Initializes internals. - * \param[in] theBuilder pointer to the builder. - * \param[in] theBuilderType builder type. - */ + /// \brief Initializes internals. + /// \param[in] theBuilder pointer to the builder. + /// \param[in] theBuilderType builder type. template void initialize(T* theBuilder, const BuilderType theBuilderType = OCCT_BRepBuilderAPI_MakeShape) { setImpl(theBuilder); @@ -57,40 +55,43 @@ public: /// \return a shape built by the shape construction algorithm. GEOMALGOAPI_EXPORT virtual const std::shared_ptr shape() const; - /** \return the list of shapes generated from the shape \a theShape. - * \param[in] theShape base shape. - * \param[out] theHistory generated shapes. - */ + /// \return true if resulting shape is valid. + GEOMALGOAPI_EXPORT bool isValid() const; + + /// \return true if resulting shape has volume. + GEOMALGOAPI_EXPORT bool hasVolume() const; + + /// \return map of sub-shapes of the result. To be used for History keeping. + GEOMALGOAPI_EXPORT std::shared_ptr mapOfSubShapes() const; + + /// \return the list of shapes generated from the shape \a theShape. + /// \param[in] theShape base shape. + /// \param[out] theHistory generated shapes. GEOMALGOAPI_EXPORT virtual void generated(const std::shared_ptr theShape, ListOfShape& theHistory); - /** \return the list of shapes modified from the shape \a theShape. - * \param[in] theShape base shape. - * \param[out] theHistory modified shapes. - */ + /// \return the list of shapes modified from the shape \a theShape. + /// \param[in] theShape base shape. + /// \param[out] theHistory modified shapes. GEOMALGOAPI_EXPORT virtual void modified(const std::shared_ptr theShape, ListOfShape& theHistory); - /** \return true if theShape was deleted. - * \param[in] theShape base shape. - */ + /// \return true if theShape was deleted. + /// \param[in] theShape base shape. GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr theShape); protected: - /** \brief Sets builder type. - * \param[in] theBuilderType new builder type. - */ - GEOMALGOAPI_EXPORT void setBuilderType(const BuilderType theBuilderType); - - /** \brief Sets status of builder. - * \param[in] theFlag new status. - */ - GEOMALGOAPI_EXPORT void setDone(const bool theFlag); - - /** \brief Sets result shape. - * \param[in] theShape new shape. - */ - GEOMALGOAPI_EXPORT void setShape(const std::shared_ptr theShape); + /// \brief Sets builder type. + /// \param[in] theBuilderType new builder type. + void setBuilderType(const BuilderType theBuilderType); + + /// \brief Sets status of builder. + /// \param[in] theFlag new status. + void setDone(const bool theFlag); + + /// \brief Sets result shape. + /// \param[in] theShape new shape. + void setShape(const std::shared_ptr theShape); private: /// \brief Initializes internals.