Salome HOME
Copyright update 2022
[modules/shaper.git] / src / SketchSolver / SketchSolver_ConstraintDistance.h
index 5c1569f9a4f160f78b06f7ec81571f359dd36d47..8aaec282f0980c86011305e88b50ac5bb21491f5 100644 (file)
@@ -1,13 +1,25 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:    SketchSolver_ConstraintDistance.h
-// Created: 31 Mar 2015
-// Author:  Artem ZHIDKOV
+// Copyright (C) 2014-2022  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 SketchSolver_ConstraintDistance_H_
 #define SketchSolver_ConstraintDistance_H_
 
-#include "SketchSolver.h"
 #include <SketchSolver_Constraint.h>
 
 /** \class   SketchSolver_ConstraintDistance
@@ -20,28 +32,39 @@ public:
   /// Constructor based on SketchPlugin constraint
   SketchSolver_ConstraintDistance(ConstraintPtr theConstraint) :
       SketchSolver_Constraint(theConstraint),
-      myType(SLVS_C_UNKNOWN),
-      myIsNegative(false)
+      myIsSigned(false),
+      mySignValue(0.0)
   {}
 
   /// \brief Update constraint
-  virtual void update(ConstraintPtr theConstraint = ConstraintPtr());
+  virtual void update();
+
+  /// \brief Remove constraint
+  virtual bool remove();
 
-  virtual int getType() const
-  {return myType; }
+  /// \brief Notify this object about the feature is changed somewhere
+  virtual void notify(const FeaturePtr& theFeature, PlaneGCSSolver_Update*);
 
 protected:
-  /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
-  virtual void process();
+  /// \brief Generate list of attributes of constraint in order useful for constraints
+  /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
+  /// \param[out] theAttributes list of attributes to be filled
+  virtual void getAttributes(EntityWrapperPtr&              theValue,
+                             std::vector<EntityWrapperPtr>& theAttributes);
 
   /// \brief This method is used in derived objects to check consistence of constraint.
   ///        E.g. the distance between line and point may be signed.
   virtual void adjustConstraint();
 
 private:
-  int myType; ///< type of constraint (applicable: SLVS_C_PT_PT_DISTANCE, SLVS_C_PT_LINE_DISTANCE)
+  void addConstraintsToKeepSign();
+  void removeConstraintsKeepingSign();
+
+private:
   double myPrevValue; ///< previous value of distance (for correct calculation of a distance sign)
-  bool myIsNegative;  ///< \c true, if the point if placed rightside of line direction (SLVS_C_PT_LINE_DISTANCE only)
+  bool   myIsSigned;  ///< true if the sign of point-line distance should be kept everytime
+  GCSPointPtr myOddPoint; ///< auxiliary point to keep sign of distance
+  double mySignValue;
 };
 
 #endif