src/GeomAlgoAPI/GeomAlgoAPI_MakeSweep.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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_MakeSweep_H_
  21 #define GeomAlgoAPI_MakeSweep_H_
  22
  23 #include <GeomAlgoAPI.h>
  24
  25 #include <GeomAlgoAPI_MakeShapeList.h>
  26
  27 /**\class GeomAlgoAPI_MakeSweep
  28  * \ingroup DataAlgo
  29  * \brief The abstract class MakeSweep is the root class of swept primitives.
  30  * Sweeps are objects you obtain by sweeping a profile along a path.
  31  * The profile can be any topology and the path is usually a curve or
  32  * a wire. The profile generates objects according to the following rules:
  33  * - Vertices generate Edges.
  34  * - Edges generate Faces.
  35  * - Wires generate Shells.
  36  * - Faces generate Solids.
  37  * - Shells generate Composite Solids.
  38  * You are not allowed to sweep Solids and Composite Solids.
  39  */
  40 class GeomAlgoAPI_MakeSweep : public GeomAlgoAPI_MakeShapeList
  41 {
  42 public:
  43   /// \returns the list of from shapes.
  44   GEOMALGOAPI_EXPORT const ListOfShape& fromShapes() const;
  45
  46   /// \return the list of to shapes.
  47   GEOMALGOAPI_EXPORT const ListOfShape& toShapes() const;
  48
  49   /// \brief Adds a shape to list of from shape.
  50   /// \param[in] theShape a shape to add.
  51   GEOMALGOAPI_EXPORT void addFromShape(const std::shared_ptr<GeomAPI_Shape> theShape);
  52
  53   /// \brief Sets from shapes
  54   /// \param[in] theListOfShapes list of from shapes.
  55   GEOMALGOAPI_EXPORT void setFromShapes(const ListOfShape& theListOfShapes);
  56
  57   /// \brief Adds a face to list of to shape.
  58   /// \param[in] theShape a face to add.
  59   GEOMALGOAPI_EXPORT void addToShape(const std::shared_ptr<GeomAPI_Shape> theShape);
  60
  61   /// \brief Sets to shapes
  62   /// \param[in] theListOfShapes list of to shapes.
  63   GEOMALGOAPI_EXPORT void setToShapes(const ListOfShape& theListOfShapes);
  64
  65 protected:
  66   /// Empty constructor.
  67   GeomAlgoAPI_MakeSweep() : GeomAlgoAPI_MakeShapeList() {};
  68
  69 private:
  70   ListOfShape myFromShapes;
  71   ListOfShape myToShapes;
  72 };
  73
  74 #endif