src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h

   1 // Copyright (C) 2014-2022  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_SketchBuilder_H_
  21 #define GeomAlgoAPI_SketchBuilder_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 #include <memory>
  27 #include <list>
  28
  29 class GeomAPI_Dir;
  30 class GeomAPI_Pln;
  31 class GeomAPI_Pnt;
  32 class GeomAPI_Shape;
  33
  34 /** \class GeomAlgoAPI_SketchBuilder
  35  *  \ingroup DataAlgo
  36  *  \brief Creates planar faces based on the list of Sketch features
  37  */
  38 class GeomAlgoAPI_SketchBuilder : public GeomAlgoAPI_MakeShape
  39 {
  40 public:
  41   /** \brief Creates list of faces based on the edges of the sketch
  42    *  \param[in]  thePlane  plane of the sketch
  43    *  \param[in]  theEdges  initial edges of the sketch
  44    *
  45    *  The algorithm searches all loops of edges surrounding lesser areas.
  46    */
  47   GEOMALGOAPI_EXPORT
  48   GeomAlgoAPI_SketchBuilder(const std::shared_ptr<GeomAPI_Pln>& thePlane,
  49                             const std::list<std::shared_ptr<GeomAPI_Shape> >& theEdges);
  50
  51   /** \brief Creates list of faces and unclosed wires on basis of the features of the sketch
  52    *  \param[in]  theOrigin      origin point of the sketch
  53    *  \param[in]  theDirX        x-direction of the sketch
  54    *  \param[in]  theNorm        normal of the sketch
  55    *  \param[in]  theWire        a wire which contains all edges
  56    *
  57    *  The algorithm searches all loops of edges surrounding lesser areas.
  58    */
  59   GEOMALGOAPI_EXPORT
  60   GeomAlgoAPI_SketchBuilder(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
  61                             const std::shared_ptr<GeomAPI_Dir>& theDirX,
  62                             const std::shared_ptr<GeomAPI_Dir>& theNorm,
  63                             const std::shared_ptr<GeomAPI_Shape>& theWire);
  64
  65   /// Return list of created faces
  66   GEOMALGOAPI_EXPORT const std::list<std::shared_ptr<GeomAPI_Shape> >& faces() const
  67   { return myResultFaces; }
  68
  69 private:
  70   void build(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
  71              const std::shared_ptr<GeomAPI_Dir>& theDirX,
  72              const std::shared_ptr<GeomAPI_Dir>& theNorm,
  73              const std::list<std::shared_ptr<GeomAPI_Shape> >& theEdges);
  74
  75 private:
  76   std::list<std::shared_ptr<GeomAPI_Shape> > myResultFaces;
  77 };
  78
  79 #endif