Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_MakeShapeCustom.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef GeomAlgoAPI_MakeShapeCustom_H_
22 #define GeomAlgoAPI_MakeShapeCustom_H_
23
24 #include <GeomAlgoAPI_MakeShape.h>
25
26 #include <GeomAPI_DataMapOfShapeMapOfShapes.h>
27 #include <GeomAPI_DataMapOfShapeShape.h>
28
29 /** \class GeomAlgoAPI_MakeShapeCustom
30  *  \ingroup DataAlgo
31  *  \brief Interface to the root class of all topological shapes constructions
32  */
33 class GeomAlgoAPI_MakeShapeCustom : public GeomAlgoAPI_MakeShape
34 {
35 public:
36   /// Default constructor
37   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShapeCustom();
38
39   /// Sets result shape.
40   GEOMALGOAPI_EXPORT void setResult(const std::shared_ptr<GeomAPI_Shape> theShape);
41
42   /// Adds modified shape.
43   GEOMALGOAPI_EXPORT bool addModified(const std::shared_ptr<GeomAPI_Shape> theBase,
44                                       const std::shared_ptr<GeomAPI_Shape> theResult);
45
46   /// Adds generated shape.
47   GEOMALGOAPI_EXPORT bool addGenerated(const std::shared_ptr<GeomAPI_Shape> theBase,
48                                        const std::shared_ptr<GeomAPI_Shape> theResult);
49
50   /// Adds deleted shape.
51   GEOMALGOAPI_EXPORT bool addDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
52
53   /// \return the list of shapes generated from the shape theShape
54   GEOMALGOAPI_EXPORT void generated(const std::shared_ptr<GeomAPI_Shape> theShape,
55                                             ListOfShape& theHistory);
56
57   /// \return the list of shapes modified from the shape theShape
58   GEOMALGOAPI_EXPORT void modified(const std::shared_ptr<GeomAPI_Shape> theShape,
59                                            ListOfShape& theHistory);
60
61   /// \return whether the shape is deleted
62   GEOMALGOAPI_EXPORT bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
63
64 private:
65   GeomAPI_DataMapOfShapeMapOfShapes myGenerated;
66   GeomAPI_DataMapOfShapeMapOfShapes myModified;
67   GeomAPI_DataMapOfShapeShape       myDeleted;
68 };
69
70 #endif