Salome HOME
Merge remote-tracking branch 'origin/EDF_2019'
[modules/shaper.git] / src / SketcherPrs / SketcherPrs_Tools.h
index aad79acc0f448eecd4f2a7cfe13c9ad205de9be7..5a719646c22e8c46447befffb461f15fbf6ab329 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        SketcherPrs_Tools.h
-// Created:     10 March 2015
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2019  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
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// 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
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef SketcherPrs_Tools_H
 #define SketcherPrs_Tools_H
@@ -14,6 +27,8 @@
 #include <ModelAPI_Object.h>
 #include <ModelAPI_Attribute.h>
 #include <ModelAPI_Feature.h>
+#include <ModelAPI_CompositeFeature.h>
+#include <ModelAPI_Result.h>
 #include <string>
 
 #include <Events_Loop.h>
@@ -89,6 +104,13 @@ namespace SketcherPrs_Tools {
     ANGLE_BACKWARD ///< Angle from the second line to the first line
   };
 
+  /// Type of dimension location
+  enum LocationType{
+    LOCATION_RIGHT,   ///< Position is marked by right arrow placed on the left
+    LOCATION_AUTOMATIC,  ///< Position is marked by two arrow placed on the both sides
+    LOCATION_LEFT ///< Position is marked by left arrow placed on the left
+  };
+
   /// Event ID about expression visual state has been changed, the symbol with a digit
   /// or parameter text is shown
 
@@ -134,6 +156,11 @@ namespace SketcherPrs_Tools {
                                                const std::string& theAttribute,
                                                const std::shared_ptr<GeomAPI_Ax3>& thePlane);
 
+  /// Collect all sketch points which are not connected with other entities.
+  /// \param theSketch sketch feature
+  /// \return list of results of SketchPlugin_Point features
+  SKETCHERPRS_EXPORT std::list<ResultPtr> getFreePoints(const CompositeFeaturePtr& theSketch);
+
   /// Returns value of dimension arrows size
   SKETCHERPRS_EXPORT double getArrowSize();
 
@@ -144,6 +171,9 @@ namespace SketcherPrs_Tools {
   /// Returns default value of dimension arrows size
   SKETCHERPRS_EXPORT int getDefaultArrowSize();
 
+  /// Returns value of dimension arrows size set in preferences
+  SKETCHERPRS_EXPORT int getConfigArrowSize();
+
   /// Set value of dimension text height
   /// \param theHeight a height value
   SKETCHERPRS_EXPORT void setTextHeight(double theHeight);
@@ -154,6 +184,9 @@ namespace SketcherPrs_Tools {
   /// Returns default value of dimension text height
   SKETCHERPRS_EXPORT double getDefaultTextHeight();
 
+  /// Returns value of dimension text height set in preferences
+  SKETCHERPRS_EXPORT double getConfigTextHeight();
+
   /// Get flayout distance of the dimension constraint
   /// \param theConstraint a dimension constraint object
   SKETCHERPRS_EXPORT double getFlyoutDistance(const ModelAPI_Feature* theConstraint);
@@ -173,6 +206,10 @@ namespace SketcherPrs_Tools {
   /// \param theError a debug error information
   SKETCHERPRS_EXPORT void sendEmptyPresentationError(ModelAPI_Feature* theFeature,
                                                      const std::string theError);
+
+  SKETCHERPRS_EXPORT void setPixelRatio(int theRatio);
+
+  SKETCHERPRS_EXPORT int pixelRatio();
 };
 
 #endif