X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_Prism.h;h=d751d41222d980e8fed05c755d3cbf47ceb4992d;hb=5b6031b015602aa07f5a6fc668c13ac3faf7a8a9;hp=e7c18fcb9af367051b048777238a8cb2b5ca03d4;hpb=c3ae28ba30027cc4a6a757ef623f40adaae96ead;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Prism.h b/src/GeomAlgoAPI/GeomAlgoAPI_Prism.h index e7c18fcb9..d751d4122 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Prism.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Prism.h @@ -7,83 +7,81 @@ #ifndef GeomAlgoAPI_Prism_H_ #define GeomAlgoAPI_Prism_H_ -#include +#include "GeomAlgoAPI.h" + +#include "GeomAlgoAPI_MakeSweep.h" + +#include #include -#include -#include + #include -/** \class GeomAlgoAPI_Prism - * \ingroup DataAlgo - * \brief Allows to create the prism based on a given face and bounding planes. - * \n Note that only planar faces are allowed as bounding faces and resulting - * extrusion will be bounded by the infinite planes taken from the faces. - */ -class GeomAlgoAPI_Prism : public GeomAPI_Interface +/// \class GeomAlgoAPI_Prism +/// \ingroup DataAlgo +/// \brief Allows to create the prism based on a given face and bounding planes. +/// \n Note that only planar faces are allowed as bounding faces and resulting +/// extrusion will be bounded by the infinite planes taken from the faces. +class GeomAlgoAPI_Prism : public GeomAlgoAPI_MakeSweep { public: - /** \brief Creates extrusion for the given shape along the normal for this shape. - * \param[in] theBaseShape face or wire to be extruded. - * \param[in] theToSize offset for "to" plane. - * \param[in] theFromSize offset for "from" plane. - */ - GEOMALGOAPI_EXPORT GeomAlgoAPI_Prism(std::shared_ptr theBaseShape, - double theToSize, - double theFromSize); - - /** \brief Creates extrusion for the given shape along the normal for this shape. - * \param[in] theBaseShape face or wire to be extruded. - * \param[in] theToShape top bounding shape. Can be empty. In this case offset will be applied to the basis. - * \param[in] theToSize offset for "to" plane. - * \param[in] theFromShape bottom bounding shape. Can be empty. In this case offset will be applied to the basis. - * \param[in] theFromSize offset for "from" plane. - */ - GEOMALGOAPI_EXPORT GeomAlgoAPI_Prism(std::shared_ptr theBaseShape, - std::shared_ptr theToShape, - double theToSize, - std::shared_ptr theFromShape, - double theFromSize); - - /// \return true if algorithm succeed. - GEOMALGOAPI_EXPORT bool isDone() const; - - /// \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 result of the Prism algorithm. - GEOMALGOAPI_EXPORT std::shared_ptr shape() const; - - /// \returns the list of from faces. - GEOMALGOAPI_EXPORT const ListOfShape& fromFaces() const; - - /// \return the list of to faces. - GEOMALGOAPI_EXPORT const ListOfShape& toFaces() 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 History processing. - GEOMALGOAPI_EXPORT std::shared_ptr makeShape() const; + /// \brief Creates extrusion for the given shape along the normal for this shape. + /// \param[in] theBaseShape planar face or wire to be extruded. + /// \param[in] theToSize offset for "to" plane. + /// \param[in] theFromSize offset for "from" plane. + GEOMALGOAPI_EXPORT GeomAlgoAPI_Prism(const GeomShapePtr theBaseShape, + const double theToSize, + const double theFromSize); + + /// \brief Creates extrusion for the given shape along the normal for this shape. + /// \param[in] theBaseShape vertex, edge, wire, face or shell. + /// \param[in] theDirection direction of extrusion. + /// Can be empty if theBaseShape is planar wire or face. + /// \param[in] theToSize offset for "to" plane. + /// \param[in] theFromSize offset for "from" plane. + GEOMALGOAPI_EXPORT GeomAlgoAPI_Prism(const GeomShapePtr theBaseShape, + const std::shared_ptr theDirection, + const double theToSize, + const double theFromSize); + + /// \brief Creates extrusion for the given shape along the normal for this shape. + /// \param[in] theBaseShape planar face or wire to be extruded. + /// \param[in] theToShape top bounding shape. Can be empty. + /// In this case offset will be applied to the basis. + /// \param[in] theToSize offset for "to" plane. + /// \param[in] theFromShape bottom bounding shape. Can be empty. + /// In this case offset will be applied to the basis. + /// \param[in] theFromSize offset for "from" plane. + GEOMALGOAPI_EXPORT GeomAlgoAPI_Prism(const GeomShapePtr theBaseShape, + const GeomShapePtr theToShape, + const double theToSize, + const GeomShapePtr theFromShape, + const double theFromSize); + + /// \brief Creates extrusion for the given shape along the normal for this shape. + /// \param[in] theBaseShape planar face or wire to be extruded. + /// \param[in] theDirection direction of extrusion. + /// Can be empty if theBaseShape is planar wire or face. + /// \param[in] theToShape top bounding shape. Can be empty. + /// In this case offset will be applied to the basis. + /// \param[in] theToSize offset for "to" plane. + /// \param[in] theFromShape bottom bounding shape. Can be empty. + /// In this case offset will be applied to the basis. + /// \param[in] theFromSize offset for "from" plane. + GEOMALGOAPI_EXPORT GeomAlgoAPI_Prism(const GeomShapePtr theBaseShape, + const std::shared_ptr theDirection, + const GeomShapePtr theToShape, + const double theToSize, + const GeomShapePtr theFromShape, + const double theFromSize); private: /// Builds resulting shape. - void build(const std::shared_ptr& theBaseShape, - const std::shared_ptr& theToShape, - double theToSize, - const std::shared_ptr& theFromShape, - double theFromSize); - -private: - /// Fields. - bool myDone; - std::shared_ptr myShape; - ListOfShape myFromFaces; - ListOfShape myToFaces; - std::shared_ptr myMap; - std::shared_ptr myMkShape; + void build(const GeomShapePtr& theBaseShape, + const std::shared_ptr theDirection, + const GeomShapePtr& theToShape, + const double theToSize, + const GeomShapePtr& theFromShape, + const double theFromSize); }; #endif