src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h

   1 // Copyright (C) 2014-2019  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
  25 #include <memory>
  26 #include <list>
  27
  28 #include <GeomAPI_Dir.h>
  29 #include <GeomAPI_Pnt.h>
  30 #include <GeomAPI_Shape.h>
  31
  32 /** \class GeomAlgoAPI_SketchBuilder
  33  *  \ingroup DataAlgo
  34  *  \brief Creates planar faces based on the list of Sketch features
  35  */
  36 class GEOMALGOAPI_EXPORT GeomAlgoAPI_SketchBuilder
  37 {
  38  public:
  39   /** \brief Creates list of faces based on the features of the sketch
  40    *  \param[in]  theOrigin      origin point of the sketch
  41    *  \param[in]  theDirX        x-direction of the sketch
  42    *  \param[in]  theNorm        normal of the sketch
  43    *  \param[in]  theFeatures    initial features of the sketch
  44    *  \param[out] theResultFaces faces based on closed wires
  45    *
  46    *  The algorithm searches all loops of edges surrounding lesser areas.
  47    */
  48   static void createFaces(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
  49                           const std::shared_ptr<GeomAPI_Dir>& theDirX,
  50                           const std::shared_ptr<GeomAPI_Dir>& theNorm,
  51                           const std::list<std::shared_ptr<GeomAPI_Shape> >& theFeatures,
  52                           std::list<std::shared_ptr<GeomAPI_Shape> >& theResultFaces);
  53
  54   /** \brief Creates list of faces and unclosed wires on basis of the features of the sketch
  55    *  \param[in]  theOrigin      origin point of the sketch
  56    *  \param[in]  theDirX        x-direction of the sketch
  57    *  \param[in]  theNorm        normal of the sketch
  58    *  \param[in]  theWire        a wire which contains all edges
  59    *  \param[out] theResultFaces faces based on closed wires
  60    *
  61    *  The algorithm searches all loops of edges surrounding lesser areas.
  62    */
  63   static void createFaces(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
  64                           const std::shared_ptr<GeomAPI_Dir>& theDirX,
  65                           const std::shared_ptr<GeomAPI_Dir>& theNorm,
  66                           const std::shared_ptr<GeomAPI_Shape>& theWire,
  67                           std::list<std::shared_ptr<GeomAPI_Shape> >& theResultFaces);
  68 };
  69
  70 #endif