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