Salome HOME
Meet the coding style (line length <= 100)
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Tools.h
index b41d8b4982d46787554225e5fb53ac307b5f5e5f..aad79acc0f448eecd4f2a7cfe13c9ad205de9be7 100644 (file)
@@ -24,13 +24,15 @@ class AIS_Dimension;
 
 //#define MyTextHeight 20
 
-/// Message that document (Part, PartSet) was created
+/// 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
+    ParameterValue, ///< using symbol with the parameter value
+    ParameterText ///< using parameter text
   };
 
 public:
@@ -59,19 +61,25 @@ 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
@@ -123,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();
@@ -155,25 +163,16 @@ namespace SketcherPrs_Tools {
                                               const ModelAPI_Feature* theConstraint,
                                               const std::shared_ptr<GeomAPI_Ax3>& thePlane);
 
-  /// Display/hide sigma symbol in the dimension presentation
-  /// \param theDimension a dimension constraint
-  /// \param theToDisplay a boolean value
-  SKETCHERPRS_EXPORT void setDisplaySpecialSymbol(AIS_Dimension* theDimension,
-                                                  const bool& theToDisplay);
-
-  /// Display the parameter value instead of dimention digit
-  /// \param theDimension a dimension constraint
-  /// \param theParameter a parameter value
-  /// \param theToDisplay a boolean value
-  SKETCHERPRS_EXPORT void setDisplayParameter(AIS_Dimension* theDimension,
-                                              const std::string& theParameter,
-                                              const bool& theToDisplay);
-
   /// 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