Salome HOME
Hide scroll bar in SALOME
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_FaceBuilder.h
index 15243f233099d9f5e41ee61dc5f608d39e15b386..4b65249299e8aa738cdb3388b674da8d89124fdd 100644 (file)
@@ -1,28 +1,55 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        GeomAlgoAPI_FaceBuilder.h
 // Created:     23 Apr 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef GeomAlgoAPI_FaceBuilder_HeaderFile
-#define GeomAlgoAPI_FaceBuilder_HeaderFile
+#ifndef GeomAlgoAPI_FaceBuilder_H_
+#define GeomAlgoAPI_FaceBuilder_H_
+
+#include "GeomAlgoAPI.h"
 
-#include <GeomAlgoAPI.h>
-#include <GeomAPI_Shape.h>
-#include <GeomAPI_Pnt.h>
-#include <GeomAPI_Dir.h>
 #include <memory>
 
-/**\class GeomAlgoAPI_FaceBuilder
- * \ingroup DataAlgo
- * \brief Allows to create face-shapes by different parameters
- */
+class GeomAPI_Dir;
+class GeomAPI_Face;
+class GeomAPI_Pln;
+class GeomAPI_Pnt;
+class GeomAPI_Vertex;
 
+/// \class GeomAlgoAPI_FaceBuilder
+/// \ingroup DataAlgo
+/// \brief Allows to create face-shapes by different parameters
 class GEOMALGOAPI_EXPORT GeomAlgoAPI_FaceBuilder
 {
-public:
+ public:
+  /// Creates square planar face by given point of the center,
+  /// normal to the plane and size of square
+  static std::shared_ptr<GeomAPI_Face> squareFace(const std::shared_ptr<GeomAPI_Pnt> theCenter,
+                                                  const std::shared_ptr<GeomAPI_Dir> theNormal,
+                                                  const double theSize);
   /// Creates square planar face by given point of the center,
   /// normal to the plane and size of square
-  static std::shared_ptr<GeomAPI_Shape> square(std::shared_ptr<GeomAPI_Pnt> theCenter,
-    std::shared_ptr<GeomAPI_Dir> theNormal, const double theSize);
+  static std::shared_ptr<GeomAPI_Face> squareFace(const std::shared_ptr<GeomAPI_Pln> thePlane,
+                                                  const double theSize);
+
+  /// Creates the planar face by given point of the center and normal to the plane.
+  static std::shared_ptr<GeomAPI_Face> planarFace(const std::shared_ptr<GeomAPI_Pnt> theCenter,
+                                                  const std::shared_ptr<GeomAPI_Dir> theNormal);
+
+  /// Creates a planar face by given plane, left lower point and size.
+  static std::shared_ptr<GeomAPI_Face> planarFace(const std::shared_ptr<GeomAPI_Pln> thePlane,
+                                                  const double theX, const double theY,
+                                                  const double theWidth, const double theHeight);
+
+  /// Creates a planar face by three vertices.
+  static std::shared_ptr<GeomAPI_Face> planarFaceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theVertex1,
+                                                                 const std::shared_ptr<GeomAPI_Vertex> theVertex2,
+                                                                 const std::shared_ptr<GeomAPI_Vertex> theVertex3);
+
+  /// Creates a planar face parallel to theFace and passing through theVertex.
+  static std::shared_ptr<GeomAPI_Face> planarFaceByFaceAndVertex(const std::shared_ptr<GeomAPI_Face> theFace,
+                                                                 const std::shared_ptr<GeomAPI_Vertex> theVertex);
 };
 
 #endif