Salome HOME
Update copyrights
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintDistance.h
index 8ac80c3139df4e41830ff70033cc6095d987cb24..082fb84a897927910399878373ec109bfec7a2f5 100644 (file)
@@ -1,6 +1,21 @@
-// File:    SketchPlugin_ConstraintDistance.h
-// Created: 23 May 2014
-// Author:  Artem ZHIDKOV
+// 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 SketchPlugin_ConstraintDistance_H_
 #define SketchPlugin_ConstraintDistance_H_
 #include "SketchPlugin_Sketch.h"
 #include "ModelAPI_Data.h"
 
+#include <GeomAPI_ICustomPrs.h>
+
 #include <list>
 
 class SketchPlugin_Line;
 class GeomDataAPI_Point2D;
 
-#define DISTANCE_COLOR "#ff00ff"
-
 /** \class SketchPlugin_ConstraintDistance
- *  \ingroup DataModel
+ *  \ingroup Plugins
  *  \brief Feature for creation of a new constraint which defines a distance
  *         between a point and another feature (point, line, plane or face)
  *
@@ -42,36 +57,49 @@ class SketchPlugin_ConstraintDistance : public SketchPlugin_ConstraintBase
     return MY_KIND;
   }
 
+  /// \brief Shows whether the point-line distance should keep its sign
+  inline static const std::string& SIGNED()
+  {
+    static const std::string MY_SIGNED("SignedDistance");
+    return MY_SIGNED;
+  }
+
+  /// attribute name of dimension location type
+  inline static const std::string& LOCATION_TYPE_ID()
+  {
+    static const std::string MY_LOCATION_TYPE_ID("LocationType");
+    return MY_LOCATION_TYPE_ID;
+  }
+
   /// \brief Creates a new part document if needed
   SKETCHPLUGIN_EXPORT virtual void execute();
 
   /// \brief Request for initialization of data model of the feature: adding all attributes
   SKETCHPLUGIN_EXPORT virtual void initAttributes();
 
+  /// Retuns the parameters of color definition in the resources config manager
+  SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
+                                                   std::string& theDefault);
+
   /// Returns the AIS preview
   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
 
-  /// Moves the feature
-  /// \param theDeltaX the delta for X coordinate is moved
-  /// \param theDeltaY the delta for Y coordinate is moved
-  SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
-
-  /// Returns the current distance between the feature attributes
-  double calculateCurrentDistance() const;
+  /// Called on change of any argument-attribute of this object
+  /// \param theID identifier of changed attribute
+  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 
   /// \brief Use plugin manager for features creation
   SketchPlugin_ConstraintDistance();
-};
 
-/// Obtain the point object from specified constraint parameter
-std::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(DataPtr theData,
-                                                       const std::string& theAttribute);
+protected:
+  /// Returns the current distance between the feature attributes
+  virtual double calculateCurrentDistance();
 
-std::shared_ptr<SketchPlugin_Line> getFeatureLine(DataPtr theData,
-                                                    const std::string& theAttribute);
+  /// Check the attributes related to distanced points/features are initialized
+  bool areAttributesInitialized();
 
-std::shared_ptr<GeomAPI_Pnt2d> getProjectionPoint(
-    const std::shared_ptr<SketchPlugin_Line>& theLine,
-    const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
+protected:
+  bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
+};
 
 #endif