Salome HOME
updated copyright message
[modules/shaper.git] / src / ConstructionPlugin / ConstructionPlugin_Point.h
index f983ec3270015565d858b96836e67beecd008c14..f845a54aed0b2d6409548a52988cd42330754f68 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // 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
+// 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>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef ConstructionPlugin_Point_H_
@@ -40,6 +39,21 @@ public:
   /// Returns the kind of a feature.
   CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind();
 
+  /// Default color for a point.
+  inline static const std::string& DEFAULT_COLOR()
+  {
+    static const std::string POINT_COLOR("85,85,0");
+    return POINT_COLOR;
+  }
+
+  /// Default color property name.
+  inline static const std::string& COLOR_NAME()
+  {
+    static const std::string POINT_COLOR_NAME("construction_point_color");
+    return POINT_COLOR_NAME;
+  }
+
+
   /// Point kind.
   inline static const std::string& ID()
   {
@@ -60,7 +74,7 @@ public:
     static const std::string MY_CREATION_METHOD_ID("by_xyz");
     return MY_CREATION_METHOD_ID;
   }
-  /*
+
   /// Attribute name for creation method.
   inline static const std::string& CREATION_METHOD_BY_DISTANCE_ON_EDGE()
   {
@@ -76,58 +90,64 @@ public:
   }
 
   /// Attribute name for creation method.
-  inline static const std::string& CREATION_METHOD_BY_LINES_INTERSECTION()
+  inline static const std::string& CREATION_METHOD_BY_INTERSECTION()
   {
-    static const std::string MY_CREATION_METHOD_ID("by_lines_intersection");
+    static const std::string MY_CREATION_METHOD_ID("by_intersection");
     return MY_CREATION_METHOD_ID;
   }
-  */
+
   /// Attribute name for creation method.
-  inline static const std::string& CREATION_METHOD_BY_LINE_AND_PLANE_INTERSECTION()
+  inline static const std::string& CREATION_METHOD_BY_GEOMETRICAL_PROPERTY()
   {
-    static const std::string MY_CREATION_METHOD_ID("by_line_and_plane_intersection");
+    static const std::string MY_CREATION_METHOD_ID("by_geometrical_property");
     return MY_CREATION_METHOD_ID;
   }
 
-  /// Attribute name for X coordinate.
-  inline static const std::string& X()
+  inline static const std::string& POINT3D()
+  {
+    static const std::string POINT_ATTR("point3d");
+    return POINT_ATTR;
+  }
+
+  /// Attribute name for selected edge.
+  inline static const std::string& EDGE()
   {
-    static const std::string POINT_ATTR_X("x");
-    return POINT_ATTR_X;
+    static const std::string ATTR_ID("edge");
+    return ATTR_ID;
   }
 
-  /// Attribute name for Y coordinate.
-  inline static const std::string& Y()
+  /// Attribute name for offset type on selected edge.
+  inline static const std::string& OFFSET_TYPE()
   {
-    static const std::string POINT_ATTR_Y("y");
-    return POINT_ATTR_Y;
+    static const std::string ATTR_ID("offset_type");
+    return ATTR_ID;
   }
 
-  /// Attribute name for Z coordinate.
-  inline static const std::string& Z()
+  /// Attribute name for offset type by distance.
+  inline static const std::string& OFFSET_TYPE_BY_DISTANCE()
   {
-    static const std::string POINT_ATTR_Z("z");
-    return POINT_ATTR_Z;
+    static const std::string ATTR_ID("offset_type_by_distance");
+    return ATTR_ID;
   }
 
-  /*/// Attribute name for selected edge.
-  inline static const std::string& EDGE()
+  /// Attribute name for offset type by ratio.
+  inline static const std::string& OFFSET_TYPE_BY_RATIO()
   {
-    static const std::string ATTR_ID("edge");
+    static const std::string ATTR_ID("offset_type_by_ratio");
     return ATTR_ID;
   }
 
   /// Attribute name for distance.
-  inline static const std::string& DISTANCE_VALUE()
+  inline static const std::string& DISTANCE()
   {
-    static const std::string ATTR_ID("value");
+    static const std::string ATTR_ID("distance");
     return ATTR_ID;
   }
 
   /// Attribute name for percent flag.
-  inline static const std::string& DISTANCE_PERCENT()
+  inline static const std::string& RATIO()
   {
-    static const std::string ATTR_ID("percent");
+    static const std::string ATTR_ID("ratio");
     return ATTR_ID;
   }
 
@@ -138,34 +158,89 @@ public:
     return ATTR_ID;
   }
 
-  /// Attribute name for point.
-  inline static const std::string& POINT()
+  /// Attribute name for point to projection.
+  inline static const std::string& POINT_TO_PROJECT()
   {
-    static const std::string ATTR_ID("point");
+    static const std::string ATTR_ID("point_to_project");
     return ATTR_ID;
   }
 
-  /// Attribute name for plane.
-  inline static const std::string& PLANE()
+  /// Attribute name for projection type.
+  inline static const std::string& PROJECTION_TYPE()
   {
-    static const std::string ATTR_ID("plane");
+    static const std::string ATTR_ID("projection_type");
     return ATTR_ID;
   }
 
-  /// Attribute name for selected first line.
-  inline static const std::string& FIRST_LINE()
+  /// Attribute name for projection type on edge.
+  inline static const std::string& PROJECTION_TYPE_ON_EDGE()
+  {
+    static const std::string ATTR_ID("projection_type_on_edge");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for projection type on face.
+  inline static const std::string& PROJECTION_TYPE_ON_FACE()
+  {
+    static const std::string ATTR_ID("projection_type_on_face");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for edge for point projection.
+  inline static const std::string& EDGE_FOR_POINT_PROJECTION()
+  {
+    static const std::string ATTR_ID("edge_for_point_projection");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for face for point projection.
+  inline static const std::string& FACE_FOR_POINT_PROJECTION()
+  {
+    static const std::string ATTR_ID("face_for_point_projection");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for intersection type.
+  inline static const std::string& INTERSECTION_TYPE()
+  {
+    static const std::string ATTR_ID("intersection_type");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for intersection type by lines.
+  inline static const std::string& INTERSECTION_TYPE_BY_LINES()
+  {
+    static const std::string MY_CREATION_METHOD_ID("intersection_type_by_lines");
+    return MY_CREATION_METHOD_ID;
+  }
+
+  /// Attribute name for intersection type by line and plane.
+  inline static const std::string& INTERSECTION_TYPE_BY_LINE_AND_PLANE()
   {
-    static const std::string ATTR_ID("first_line");
+    static const std::string MY_CREATION_METHOD_ID("intersection_type_by_line_and_plane");
+    return MY_CREATION_METHOD_ID;
+  }
+
+  /// Attribute name for intersection type by planes.
+  inline static const std::string& INTERSECTION_TYPE_BY_PLANES()
+  {
+    static const std::string MY_CREATION_METHOD_ID("intersection_type_by_planes");
+    return MY_CREATION_METHOD_ID;
+  }
+
+  /// Attribute name for selected first intersection line.
+  inline static const std::string& INTERSECTION_LINE_1()
+  {
+    static const std::string ATTR_ID("intersection_line_1");
     return ATTR_ID;
   }
 
-  /// Attribute name for selected second line.
-  inline static const std::string& SECOND_LINE()
+  /// Attribute name for selected second intersection line.
+  inline static const std::string& INTERSECTION_LINE_2()
   {
-    static const std::string ATTR_ID("second_line");
+    static const std::string ATTR_ID("intersection_line_2");
     return ATTR_ID;
   }
-  */
 
   /// Attribute name for selected intersection line.
   inline static const std::string& INTERSECTION_LINE()
@@ -202,29 +277,84 @@ public:
     return ATTR_ID;
   }
 
+  /// Attribute name for selected intersection plane.
+  inline static const std::string& INTERSECTION_PLANE_1()
+  {
+    static const std::string ATTR_ID("intersection_plane_1");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for selected intersection plane.
+  inline static const std::string& INTERSECTION_PLANE_2()
+  {
+    static const std::string ATTR_ID("intersection_plane_2");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for selected intersection plane.
+  inline static const std::string& INTERSECTION_PLANE_3()
+  {
+    static const std::string ATTR_ID("intersection_plane_3");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for property type.
+  inline static const std::string& GEOMETRICAL_PROPERTY_TYPE()
+  {
+    static const std::string ATTR_ID("geometrical_property_type");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for property type by center of gravity.
+  inline static const std::string& GEOMETRICAL_PROPERTY_TYPE_BY_CENTER_OF_GRAVITY()
+  {
+    static const std::string PROPERTY_TYPE("geometrical_property_type_by_center_of_gravity");
+    return PROPERTY_TYPE;
+  }
+
+  /// Attribute name for property type by center of circle.
+  inline static const std::string& GEOMETRICAL_PROPERTY_TYPE_BY_CENTER_OF_CIRCLE()
+  {
+    static const std::string PROPERTY_TYPE("geometrical_property_type_by_center_of_circle");
+    return PROPERTY_TYPE;
+  }
+
+  /// Attribute name for selected object for center of gravity.
+  inline static const std::string& OBJECT_FOR_CENTER_OF_GRAVITY()
+  {
+    static const std::string ATTR_ID("object_for_center_of_gravity");
+    return ATTR_ID;
+  }
+
+  /// Attribute name for selected object for center of cricle.
+  inline static const std::string& OBJECT_FOR_CENTER_OF_CIRCLE()
+  {
+    static const std::string ATTR_ID("object_for_center_of_circle");
+    return ATTR_ID;
+  }
+
   /// Creates a new part document if needed.
   CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes.
   CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
 
-  /// Construction result is allways recomuted on the fly.
-  CONSTRUCTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
-
   /// Use plugin manager for features creation
   ConstructionPlugin_Point();
 
   /// Customize presentation of the feature
-  virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
-                                     std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs);
+  virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs);
 
 private:
   std::shared_ptr<GeomAPI_Vertex> createByXYZ();
-  /*std::shared_ptr<GeomAPI_Vertex> createByDistanceOnEdge();
-  std::shared_ptr<GeomAPI_Vertex> createByProjection();
-  std::shared_ptr<GeomAPI_Vertex> createByLinesIntersection();*/
+  std::shared_ptr<GeomAPI_Vertex> createByDistanceOnEdge();
+  std::shared_ptr<GeomAPI_Vertex> createByProjectionOnEdge();
+  std::shared_ptr<GeomAPI_Vertex> createByProjectionOnFace();
+  std::shared_ptr<GeomAPI_Vertex> createByLinesIntersection();
   std::list<std::shared_ptr<GeomAPI_Vertex> > createByLineAndPlaneIntersection();
-
+  std::shared_ptr<GeomAPI_Vertex> createByPlanesIntersection();
+  std::shared_ptr<GeomAPI_Vertex> createByCenterOfGravity();
+  std::shared_ptr<GeomAPI_Vertex> createByCenterOfCircle();
 };
 
 #endif