src/GeomAlgoAPI/GeomAlgoAPI_ShapeBuilder.h

   1 // Copyright (C) 2014-2021  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_ShapeBuilder_H_
  21 #define GeomAlgoAPI_ShapeBuilder_H_
  22
  23 #include "GeomAlgoAPI.h"
  24 #include "GeomAlgoAPI_MakeShapeList.h"
  25
  26 #include <GeomAPI_Shape.h>
  27
  28 /// \class GeomAlgoAPI_ShapeBuilder
  29 /// \ingroup DataAlgo
  30 /// \brief Allows to add or remove subshapes from a shape.
  31 class GeomAlgoAPI_ShapeBuilder: public GeomAlgoAPI_MakeShapeList
  32 {
  33  public:
  34    /// \brief Adds theShapeToAdd in theShape.
  35    /// \param[in] theShape shape to modify.
  36    /// \param[in] theShapeToAdd shape which will be added.
  37    GEOMALGOAPI_EXPORT static void add(std::shared_ptr<GeomAPI_Shape> theShape,
  38                                       const std::shared_ptr<GeomAPI_Shape> theShapeToAdd);
  39
  40    /// \brief Removes theShapeToRemove in theShape.
  41    /// \param[in] theShape shape to modify.
  42    /// \param[in] theShapeToRemove shape which will be removed.
  43    GEOMALGOAPI_EXPORT static void remove(std::shared_ptr<GeomAPI_Shape> theShape,
  44                                          const std::shared_ptr<GeomAPI_Shape> theShapeToRemove);
  45
  46    /// Creates empty builder.
  47    GEOMALGOAPI_EXPORT GeomAlgoAPI_ShapeBuilder();
  48
  49    /// \brief Store new shape as result of removing internal shapes from theShape.
  50    /// \param[in] theShape base shape.
  51    GEOMALGOAPI_EXPORT void removeInternal(const std::shared_ptr<GeomAPI_Shape> theShape);
  52
  53    /// \brief Store new shape as result of adding theShapesToAdd to theShape as internal shapes.
  54    /// \param[in] theShape base shape.
  55    /// \param[in] theShapesToAdd shapes which will be added.
  56    GEOMALGOAPI_EXPORT void addInternal(const std::shared_ptr<GeomAPI_Shape> theShape,
  57                                        const ListOfShape& theShapesToAdd);
  58 };
  59
  60 #endif