updated copyright message

[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintLength.h

diff --git a/src/SketchPlugin/SketchPlugin_ConstraintLength.h b/src/SketchPlugin/SketchPlugin_ConstraintLength.h
index a905ad1d697d1ffa5fd0f328bc7603608f468779..b150a48c76b7a8ce576243ecac08ae2d99d99397 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_ConstraintLength.h
+++ b/src/SketchPlugin/SketchPlugin_ConstraintLength.h
@@ -1,17 +1,34 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:    SketchPlugin_ConstraintLength.h
-// Created: 30 May 2014
-// Author:  Artem ZHIDKOV
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// 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_ConstraintLength_H_
 #define SketchPlugin_ConstraintLength_H_
 
 #include "SketchPlugin.h"
 #include "SketchPlugin_ConstraintBase.h"
-#include <SketchPlugin_Sketch.h>
+#include "SketchPlugin_Sketch.h"
+
+#include <GeomAPI_ICustomPrs.h>
+
 #include <list>
 
+class GeomAPI_Pnt2d;
 class GeomDataAPI_Point2D;
 
 /** \class SketchPlugin_ConstraintLength
@@ -31,6 +48,7 @@ class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
     static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength");
     return MY_CONSTRAINT_LENGTH_ID;
   }
+
   /// \brief Returns the kind of a feature
   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
   {
@@ -38,6 +56,13 @@ class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
     return MY_KIND;
   }
 
+  /// 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();
 
@@ -49,14 +74,13 @@ class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
   /// \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);
-
   /// 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);
@@ -64,8 +88,13 @@ class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
   /// \brief Use plugin manager for features creation
   SketchPlugin_ConstraintLength();
 
+  /// Computes distance between lenght point attributes
+  /// \param theValue [out] distance or 0 if one of point attributes is not initialized
+  /// \return boolean value if distance is computed
+  bool computeLenghtValue(double& theValue);
+
 private:
-  // retrns the points-base of length, returns false if it is not possible
+  /// retrns the points-base of length, returns false if it is not possible
   bool getPoints(
     std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
     std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,