X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_MakeShape.h;h=6ed4f1d859425116d4bee21990fe318df4188ed1;hb=a94fc319f2aa64b43c9a73b5ff7063923648faec;hp=efafeceee7a73b9e43e4e0da183588b9f5588152;hpb=1ba7f96679673e8b2aa558b9844461d54ba939b1;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h index efafeceee..6ed4f1d85 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h @@ -1,53 +1,149 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D +// 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 +// -// File: GeomAlgoAPI_MakeShape.h -// Created: 17 Oct 2014 -// Author: Sergey ZARITCHNY #ifndef GeomAlgoAPI_MakeShape_H_ #define GeomAlgoAPI_MakeShape_H_ -#include #include +#include #include #include +#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: - /// Constructor + /// Builder type enum + enum BuilderType { + Unknown, + OCCT_BRepBuilderAPI_MakeShape, + OCCT_BOPAlgo_Builder + }; + +public: + /// \brief Empty constructor. GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(); - /// Constructor by the already stored builder in the interface - GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder); - /// Constructor by the builder and wire. Used for pipe builder. - GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder, - const std::shared_ptr theWire, - const std::shared_ptr theBaseShape); + /// \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) + { + initialize(); + } + + /// \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); + myBuilderType = theBuilderType; + initialize(); + } + + /// \return status of builder. + GEOMALGOAPI_EXPORT bool isDone() const; + + /// \return a shape built by the shape construction algorithm. + GEOMALGOAPI_EXPORT virtual const std::shared_ptr shape() const; - /// Returns a shape built by the shape construction algorithm - GEOMALGOAPI_EXPORT const std::shared_ptr shape() const; + /// \return true if resulting shape is valid. + GEOMALGOAPI_EXPORT bool isValid() const; - /// Returns the list of shapes generated from the shape \a theShape - GEOMALGOAPI_EXPORT virtual void generated( - const std::shared_ptr theShape, ListOfShape& theHistory); + /// \return true if resulting shape has volume. + GEOMALGOAPI_EXPORT bool hasVolume() const; - /// Returns the list of shapes modified from the shape \a theShape - GEOMALGOAPI_EXPORT virtual void modified( - const std::shared_ptr theShape, ListOfShape& theHistory); + /// \return map of sub-shapes of the result. To be used for History keeping. + GEOMALGOAPI_EXPORT std::shared_ptr mapOfSubShapes() const; - /// Returns whether the shape is an edge + /// \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. Does not cleared! + GEOMALGOAPI_EXPORT virtual void modified(const std::shared_ptr theShape, + ListOfShape& theHistory); + + /// \return true if theShape was deleted. + /// \param[in] theShape base shape. GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr theShape); - protected: - /// The resulting shape - std::shared_ptr myShape; - std::shared_ptr myWire; - std::shared_ptr myBaseShape; + /// \return true if the data were correct. + GEOMALGOAPI_EXPORT virtual bool check() { return true; }; + + /// \return the list of created faces. + GEOMALGOAPI_EXPORT std::map< std::string, std::shared_ptr > getCreatedFaces() + {return myCreatedFaces;} + + /// \return the error. + GEOMALGOAPI_EXPORT std::string getError() { return myError; } + + /// \brief Prepare the naming of faces. + GEOMALGOAPI_EXPORT virtual void prepareNamingFaces(); + + /// \brief Check the validity of the produced shape. + GEOMALGOAPI_EXPORT bool checkValid(std::string theMessage); + +protected: + /// \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); + +protected: + /// Data map to keep correct orientation of sub-shapes. + std::shared_ptr myMap; + /// Error occurred during the execution of an algorithm. + std::string myError; + /// Map of created faces with their name for naming. + std::map< std::string, std::shared_ptr > myCreatedFaces; + +private: + /// \brief Initializes internals. + void initialize(); + +private: + GeomAlgoAPI_MakeShape::BuilderType myBuilderType; ///< Type of make shape builder. + bool myDone; ///< Builder status. + std::shared_ptr myShape; ///< Resulting shape. }; typedef std::list > ListOfMakeShape;