Copyright update 2022

[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Measurement.h

diff --git a/src/FeaturesPlugin/FeaturesPlugin_Measurement.h b/src/FeaturesPlugin/FeaturesPlugin_Measurement.h
index a358155cfa9ece2d4efc2e0979e05eb601eb920c..5ef1a1c0896e6fbabfb2a8418d24f6a782cf5f89 100644 (file)
--- a/src/FeaturesPlugin/FeaturesPlugin_Measurement.h
+++ b/src/FeaturesPlugin/FeaturesPlugin_Measurement.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2018-20xx  CEA/DEN, EDF R&D
+// Copyright (C) 2018-2022  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
@@ -12,10 +12,9 @@
 //
 // 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 FeaturesPlugin_Measurement_H_
@@ -24,6 +23,9 @@
 #include "FeaturesPlugin.h"
 #include <ModelAPI_Feature.h>
 
+#include <GeomAPI_IPresentable.h>
+#include <GeomAPI_IScreenParams.h>
+
 /// \class FeaturesPlugin_Measurement
 /// \ingroup Plugins
 /// \brief Feature for calculation metrics.
@@ -33,7 +35,9 @@
 /// * distance between shapes,
 /// * radius of arc or cylindrical faces,
 /// * angle between edges.
-class FeaturesPlugin_Measurement : public ModelAPI_Feature
+class FeaturesPlugin_Measurement : public ModelAPI_Feature,
+  public GeomAPI_IPresentable,
+  public GeomAPI_IScreenParams
 {
 public:
   /// Feature kind.
@@ -84,6 +88,13 @@ public:
     return MY_MEASURE_ID;
   }
 
+  /// Attribute name for angle measurement by 3 points.
+  inline static const std::string& MEASURE_ANGLE_POINTS()
+  {
+    static const std::string MY_MEASURE_ID("AngleBy3Points");
+    return MY_MEASURE_ID;
+  }
+
 
   /// Attribute name of edge selected for length calculation.
   inline static const std::string& EDGE_FOR_LENGTH_ID()
@@ -120,13 +131,34 @@ public:
     return MY_ANGLE_FROM_EDGE_ID;
   }
 
-  /// Attribute name of second shape selected for distance calculation.
+  /// Attribute name of second shape selected for angle calculation.
   inline static const std::string& ANGLE_TO_EDGE_ID()
   {
     static const std::string MY_ANGLE_TO_EDGE_ID("angle_to");
     return MY_ANGLE_TO_EDGE_ID;
   }
 
+  /// Attribute name of first point selected for angle calculation.
+  inline static const std::string& ANGLE_POINT1_ID()
+  {
+    static const std::string MY_ANGLE_POINT1_ID("angle_point_1");
+    return MY_ANGLE_POINT1_ID;
+  }
+
+  /// Attribute name of second point (apex) selected for angle calculation.
+  inline static const std::string& ANGLE_POINT2_ID()
+  {
+    static const std::string MY_ANGLE_POINT2_ID("angle_point_2");
+    return MY_ANGLE_POINT2_ID;
+  }
+
+  /// Attribute name of third point selected for angle calculation.
+  inline static const std::string& ANGLE_POINT3_ID()
+  {
+    static const std::string MY_ANGLE_POINT3_ID("angle_point_3");
+    return MY_ANGLE_POINT3_ID;
+  }
+
   /// Attribute name for result.
   inline static const std::string& RESULT_ID()
   {
@@ -141,7 +173,7 @@ public:
     return MY_RESULT_VALUES_ID;
   }
 
-  /// Creates a new part document if needed
+  /// Performs the algorithm and stores results it in the data structure.
   FEATURESPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes
@@ -154,6 +186,23 @@ public:
   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
   virtual bool isMacro() const { return true; }
 
+  /** Returns the AIS preview
+  *   \param thePrevious - defines a presentation if it was created previously
+  */
+  FEATURESPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
+
+  /// Set current screen plane
+  /// \param theScreenPlane the screen plane
+  virtual void setScreenPlane(GeomPlanePtr theScreenPlane) {
+    myScreenPlane = theScreenPlane;
+  }
+
+  /// Set current view scale
+  /// \param theScale the view scale
+  virtual void setViewScale(double theScale) {
+    mySceenScale = theScale;
+  }
+
   /// Use plugin manager for features creation
   FeaturesPlugin_Measurement();
 
@@ -162,10 +211,38 @@ private:
   void computeLength();
   /// Compute minimal distance between pair of shapes
   void computeDistance();
-  /// Compute radius of circular edge or cylindrical face
+  /// Compute radius of circular edge, cylindrical surface or sphere.
   void computeRadius();
   /// Compute angle(s) between pair of edges if they are intersected
   void computeAngle();
+  /// Compute angle by three points
+  void computeAngleByPoints();
+
+  /// Create length dimension presentation
+  /// \param thePrevious previous version of presentation
+  AISObjectPtr lengthDimension(AISObjectPtr thePrevious);
+
+  /// Create distance dimension presentation
+  /// \param thePrevious previous version of presentation
+  AISObjectPtr distanceDimension(AISObjectPtr thePrevious);
+
+  /// Create radius dimension presentation
+  /// \param thePrevious previous version of presentation
+  AISObjectPtr radiusDimension(AISObjectPtr thePrevious);
+
+  /// Create angle dimension presentation
+  /// \param thePrevious previous version of presentation
+  AISObjectPtr angleDimension(AISObjectPtr thePrevious);
+
+  /// Create angle by points dimension presentation
+  /// \param thePrevious previous version of presentation
+  AISObjectPtr angleByPointsDimension(AISObjectPtr thePrevious);
+
+  /// Set dimension presentation parameters
+  void setupDimension(AISObjectPtr theDim);
+
+  GeomPlanePtr myScreenPlane; //< a plane of current screen
+  double mySceenScale; //< a scale of current view
 };
 
 #endif