refs #156: Behavior of the Sketch during edition

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_SketchBuilder.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h b/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h
index 1a75da2042591eb8f9539455ca5dc0a51f45b16b..86505f82dbb8fd94299b51d443113656e7b9278d 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h
@@ -20,7 +20,7 @@
  */
 class GEOMALGOAPI_EXPORT GeomAlgoAPI_SketchBuilder
 {
-public:
+ public:
   /** \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
@@ -34,19 +34,38 @@ public:
    *  It finds the vertex with minimal coordinates along X axis (theDirX) and then 
    *  goes through the edges passing the surrounding area on the left.
    */
-  static void createFaces(const boost::shared_ptr<GeomAPI_Pnt>&                theOrigin,
-                          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 boost::shared_ptr<GeomAPI_Pnt>& theOrigin,
+                          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);
+
+  /** \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]  theDirY        y-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 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.
+   */
+  static void createFaces(const boost::shared_ptr<GeomAPI_Pnt>& theOrigin,
+                          const boost::shared_ptr<GeomAPI_Dir>& theDirX,
+                          const boost::shared_ptr<GeomAPI_Dir>& theDirY,
+                          const boost::shared_ptr<GeomAPI_Dir>& theNorm,
+                          const boost::shared_ptr<GeomAPI_Shape>& theWire,
+                          std::list<boost::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
    */
-  static void fixIntersections(std::list< boost::shared_ptr<GeomAPI_Shape> >& theFaces);
+  static void fixIntersections(std::list<boost::shared_ptr<GeomAPI_Shape> >& theFaces);
 };
 
 #endif