src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h

   1 // Copyright (C) 2014-2023  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAlgoAPI_MakeShapeList_H_
  21 #define GeomAlgoAPI_MakeShapeList_H_
  22
  23 #include <GeomAPI_Shape.h>
  24 #include <GeomAlgoAPI.h>
  25 #include <GeomAlgoAPI_MakeShape.h>
  26
  27 #include <memory>
  28
  29 /// \class GeomAlgoAPI_MakeShapeList
  30 /// \ingroup DataAlgo
  31 /// \brief List of topological shapes constructions
  32 class GeomAlgoAPI_MakeShapeList : public GeomAlgoAPI_MakeShape
  33 {
  34   enum OperationType {
  35     Generated,
  36     Modified
  37   };
  38
  39 public:
  40   /// Default constructor
  41   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShapeList();
  42
  43   /// \brief Constructor
  44   /// \param[in] theMakeShapeList list of algorithms.
  45   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShapeList(const ListOfMakeShape& theMakeShapeList);
  46
  47   /// \brief Initializes a class with new list of algorithms.
  48   /// \param[in] theMakeShapeList list of algorithms.
  49   GEOMALGOAPI_EXPORT void init(const ListOfMakeShape& theMakeShapeList);
  50
  51   /// \return the list reference
  52   GEOMALGOAPI_EXPORT const ListOfMakeShape& list() const;
  53
  54   /// \brief Adds algo to the end of list.
  55   /// \param[in] theMakeShape algo to be added.
  56   GEOMALGOAPI_EXPORT void appendAlgo(const GeomMakeShapePtr theMakeShape);
  57
  58   /// \return a shape built by the shape construction algorithms
  59   GEOMALGOAPI_EXPORT virtual const GeomShapePtr shape() const;
  60
  61   /// \return the list of shapes generated from the shape \a theShape
  62   GEOMALGOAPI_EXPORT virtual void generated(const GeomShapePtr theShape,
  63                                             ListOfShape& theHistory);
  64
  65   /// \return the list of shapes modified from the shape \a theShape
  66   GEOMALGOAPI_EXPORT virtual void modified(const GeomShapePtr theShape,
  67                                            ListOfShape& theHistory);
  68
  69   /// \return whether the shape is deleted
  70   GEOMALGOAPI_EXPORT virtual bool isDeleted(const GeomShapePtr theShape);
  71
  72 private:
  73   void result(const GeomShapePtr theShape,
  74               ListOfShape& theHistory);
  75
  76 protected:
  77   ListOfMakeShape myListOfMakeShape; ///< List of make shape algos.
  78 };
  79
  80 #endif