Salome HOME
Issue #2578: EDF 2018-2 Removal of faces.
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_SketchBuilder.h
index eb1587a54df4bf335ae415c3a7311800be741ce0..9fcaec2c3c839a7767190a2bde7a42abbc0fc1fe 100644 (file)
@@ -1,16 +1,33 @@
-// File:        GeomAlgoAPI_SketchBuilder.h
-// Created:     02 Jun 2014
-// Author:      Artem ZHIDKOV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
-#ifndef GeomAlgoAPI_SketchBuilder_HeaderFile
-#define GeomAlgoAPI_SketchBuilder_HeaderFile
+#ifndef GeomAlgoAPI_SketchBuilder_H_
+#define GeomAlgoAPI_SketchBuilder_H_
 
 #include <GeomAlgoAPI.h>
 
-#include <boost/shared_ptr.hpp>
+#include <memory>
 #include <list>
 
 #include <GeomAPI_Dir.h>
+#include <GeomAPI_Pnt.h>
 #include <GeomAPI_Shape.h>
 
 /** \class GeomAlgoAPI_SketchBuilder
  */
 class GEOMALGOAPI_EXPORT GeomAlgoAPI_SketchBuilder
 {
-public:
-  /** \brief Creates list of faces and unclosed wires on basis of the features of the sketch
+ public:
+  /** \brief Creates list of faces based on the features of the sketch
+   *  \param[in]  theOrigin      origin point of the sketch
    *  \param[in]  theDirX        x-direction of the sketch
-   *  \param[in]  theDirY        y-direction of the sketch
    *  \param[in]  theNorm        normal of the sketch
    *  \param[in]  theFeatures    initial features of the sketch
    *  \param[out] theResultFaces faces based on closed wires
-   *  \param[out] theResultWires unclosed wires of the sketch
    *
-   *  The algorithm searches all loops of edges surrounding lesser squares.
-   *  It finds the vertex with minimal coordinates along X axis (theDirX) and then 
-   *  goes through the edges passing the surrounding area on the left.
+   *  The algorithm searches all loops of edges surrounding lesser areas.
    */
-  static void createFaces(const boost::shared_ptr<GeomAPI_Dir>&                theDirX,
-                          const boost::shared_ptr<GeomAPI_Dir>&                theDirY,
-                          const boost::shared_ptr<GeomAPI_Dir>&                theNorm,
-                          const std::list< boost::shared_ptr<GeomAPI_Shape> >& theFeatures,
-                                std::list< boost::shared_ptr<GeomAPI_Shape> >& theResultFaces,
-                                std::list< boost::shared_ptr<GeomAPI_Shape> >& theResultWires);
+  static void createFaces(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
+                          const std::shared_ptr<GeomAPI_Dir>& theDirX,
+                          const std::shared_ptr<GeomAPI_Dir>& theNorm,
+                          const std::list<std::shared_ptr<GeomAPI_Shape> >& theFeatures,
+                          std::list<std::shared_ptr<GeomAPI_Shape> >& theResultFaces);
 
-  /** \brief Searches intersections between the faces in the list 
-   *         and make holes in the faces to avoid intersections
-   *  \param[in,out] theFaces list of faces to proccess
+  /** \brief Creates list of faces and unclosed wires on basis of the features of the sketch
+   *  \param[in]  theOrigin      origin point of the sketch
+   *  \param[in]  theDirX        x-direction of the sketch
+   *  \param[in]  theNorm        normal of the sketch
+   *  \param[in]  theWire        a wire which contains all edges
+   *  \param[out] theResultFaces faces based on closed wires
+   *
+   *  The algorithm searches all loops of edges surrounding lesser areas.
    */
-  static void fixIntersections(std::list< boost::shared_ptr<GeomAPI_Shape> >& theFaces);
+  static void createFaces(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
+                          const std::shared_ptr<GeomAPI_Dir>& theDirX,
+                          const std::shared_ptr<GeomAPI_Dir>& theNorm,
+                          const std::shared_ptr<GeomAPI_Shape>& theWire,
+                          std::list<std::shared_ptr<GeomAPI_Shape> >& theResultFaces);
 };
 
 #endif