Salome HOME
Meet the coding style (line length <= 100)
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Tools.h
index 0daf047238c24e53990af7e73df539d5d5d00094..aad79acc0f448eecd4f2a7cfe13c9ad205de9be7 100644 (file)
 #include <GeomAPI_Pnt2d.h>
 #include <GeomAPI_Ax3.h>
 #include <ModelAPI_Object.h>
+#include <ModelAPI_Attribute.h>
 #include <ModelAPI_Feature.h>
 #include <string>
 
+#include <Events_Loop.h>
+#include <Events_Message.h>
+
 class GeomDataAPI_Point2D;
+class AIS_Dimension;
 
 //#define MyTextHeight 20
 
+/// Message that style of visualization of parameter is changed.
+/// It will be shown as expression or value
+class SketcherPrs_ParameterStyleMessage : public Events_Message
+{
+public:
+  /// \enum ParameterStyle lists styles of parameter
+  enum ParameterStyle {
+    ParameterValue, ///< using symbol with the parameter value
+    ParameterText ///< using parameter text
+  };
+
+public:
+  /// Creates an empty message
+  SKETCHERPRS_EXPORT SketcherPrs_ParameterStyleMessage(const Events_ID theID,
+                                                    const void* theSender = 0)
+  : Events_Message(theID, theSender) {}
+  /// The virtual destructor
+  SKETCHERPRS_EXPORT virtual ~SketcherPrs_ParameterStyleMessage() {}
+  /// Static. Returns EventID of the message.
+  SKETCHERPRS_EXPORT static Events_ID eventId()
+  {
+    static const char * MY_EVENT_PARAMETER_STYLE_ID("ParameterStyle");
+    return Events_Loop::eventByName(MY_EVENT_PARAMETER_STYLE_ID);
+  }
+  /// Returns a document stored in the message
+  SKETCHERPRS_EXPORT ParameterStyle style() const { return myStyle; }
+  /// Sets a document to the message
+  SKETCHERPRS_EXPORT void setStyle(ParameterStyle theStyle) { myStyle = theStyle; }
+private:
+  ParameterStyle myStyle; /// style of the parameter visualization
+};
+
 namespace SketcherPrs_Tools {
 
   /// Enumeration with modes for activation of selection custom presentations
   enum SelectionModes {
     /// Start of enumeration
-    Sel_Mode_First = 100, 
-  
+    Sel_Mode_First = 100,
+
     /// Selection mode for all constraints exclude dimensions
     Sel_Constraint,
-  
+
     /// Selection mode for whole dimension
     Sel_Dimension_All,
-  
+
     /// Selection mode for line of dimension
     Sel_Dimension_Line,
 
-    /// Selection mode foe text of dimension
-    Sel_Dimension_Text
+    /// Selection mode for text of dimension
+    Sel_Dimension_Text,
+
+    /// Selectiom mode for faces selection on sketch
+    Sel_Sketch_Face,
+
+    /// Selectiom mode for wires selection on sketch
+    Sel_Sketch_Wire
+  };
+
+  /// Type of angle
+  enum AngleType{
+    ANGLE_DIRECT,   ///< Angle from the first line to the second line
+    ANGLE_COMPLEMENTARY,  ///< Additional angle to the angle from first to second line
+    ANGLE_BACKWARD ///< Angle from the second line to the first line
   };
 
+  /// Event ID about expression visual state has been changed, the symbol with a digit
+  /// or parameter text is shown
+
+  /// Returns attribute object referenced by feature
+  /// \param theFeature a feature
+  /// \param theAttrName an attribute name
+  SKETCHERPRS_EXPORT AttributePtr getAttribute(ModelAPI_Feature* theFeature,
+                                               const std::string& theAttrName);
+
   /// Returns result object referenced by feature
   /// \param theFeature a feature
   /// \param theAttrName an attribute name
@@ -72,8 +131,8 @@ namespace SketcherPrs_Tools {
   /// \param theAttribute an attribute name
   /// \param thePlane a projection plane (sketcher plane)
   SKETCHERPRS_EXPORT std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(DataPtr theData,
-                                                       const std::string& theAttribute,
-                                                       const std::shared_ptr<GeomAPI_Ax3>& thePlane);
+                                               const std::string& theAttribute,
+                                               const std::shared_ptr<GeomAPI_Ax3>& thePlane);
 
   /// Returns value of dimension arrows size
   SKETCHERPRS_EXPORT double getArrowSize();
@@ -103,6 +162,17 @@ namespace SketcherPrs_Tools {
   SKETCHERPRS_EXPORT std::shared_ptr<GeomAPI_Pnt> getAnchorPoint(
                                               const ModelAPI_Feature* theConstraint,
                                               const std::shared_ptr<GeomAPI_Ax3>& thePlane);
+
+  /// Sends event about expression visualization type is changed for dimension presentations
+  /// Sends event to redisplay all sub-features of composite feature
+  /// \param theState a new state
+  SKETCHERPRS_EXPORT void sendExpressionShownEvent(const bool& theState);
+
+  /// Throws an exception(in debug mode) and sends a signal about necessity to hide the object
+  /// \param theFeature a feature where AIS presentation is empty
+  /// \param theError a debug error information
+  SKETCHERPRS_EXPORT void sendEmptyPresentationError(ModelAPI_Feature* theFeature,
+                                                     const std::string theError);
 };
 
 #endif