Salome HOME
Copyright update 2021
[modules/shaper.git] / src / SketchSolver / SketchSolver_Manager.h
index 5eab8bc9e5d7c02c5d59ca796d684ac465cc6fd8..99ef5e585afcc5424ab5eda01f4f066629b59829 100644 (file)
@@ -1,30 +1,41 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:    SketchSolver_Manager.h
-// Created: 08 May 2014
-// Author:  Artem ZHIDKOV
+// Copyright (C) 2014-2021  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_Manager_H_
 #define SketchSolver_Manager_H_
 
-#include "SketchSolver.h"
 #include <SketchSolver_Group.h>
-#include <SketchSolver_Builder.h>
 
 #include <Events_Listener.h>
-#include <SketchPlugin_Constraint.h>
 
 #include <list>
 #include <set>
 
+class GeomAPI_Pnt2d;
+class GeomDataAPI_Point2D;
+class ModelAPI_CompositeFeature;
+class SketchPlugin_Constraint;
+
 /** \class   SketchSolver_Manager
  *  \ingroup Plugins
  *  \brief   Listens the changes of SketchPlugin features and transforms the Constraint
- *           feature into the format understandable by SolveSpace library.
- *
- *  Constraints created for SolveSpace library are divided into the groups.
- *  The division order based on connectedness of the features by the constraints.
- *  The groups may be fused or separated according to the new constraints.
+ *           feature into the format understandable by sketch solver.
  *
  *  \remark This is a singleton.
  */
@@ -34,7 +45,7 @@ public:
   /** \brief Main method to create constraint manager
    *  \return pointer to the singleton
    */
-  SKETCHSOLVER_EXPORT static SketchSolver_Manager* instance();
+  static SketchSolver_Manager* instance();
 
   /** \brief Implementation of Event Listener method
    *  \param[in] theMessage the data of the event
@@ -47,12 +58,6 @@ public:
    */
   virtual bool groupMessages();
 
-  /// \brief Initialize builder for solver's data structure entities
-  /// \param theBuilder [in]  solver's specific builder
-  SKETCHSOLVER_EXPORT void setBuilder(BuilderPtr theBuilder);
-  /// \brief Returns the builder specific for the solver
-  BuilderPtr builder();
-
 protected:
   SketchSolver_Manager();
   ~SketchSolver_Manager();
@@ -61,56 +66,59 @@ protected:
    *  \param[in] theFeature sketch feature to be changed
    *  \return \c true if the feature changed successfully
    */
-  bool changeFeature(std::shared_ptr<SketchPlugin_Feature> theFeature);
+  bool updateFeature(const std::shared_ptr<SketchPlugin_Feature>& theFeature);
 
-  /** \brief Removes a constraint from the manager
-   *  \param[in] theConstraint constraint to be removed
-   *  \return \c true if the constraint removed successfully
+  /** \brief Updates the sketch and related constraints, if the sketch plane is changed
+   *  \param[in] theSketch sketch to be updated
+   *  \return \c true if the sketch plane is changed
    */
-  bool removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  bool updateSketch(const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch);
 
-  /** \brief Adds or updates a workplane in the manager
-   *  \param[in] theSketch the feature to create or update workplane
-   *  \return \c true if the workplane changed successfully
-   *  \remark Type of theSketch is not verified inside
+  /** \brief Move feature
+   *  \param[in] theMovedFeature dragged sketch feature
+   *  \param[in] theFromPoint    original position of the feature
+   *  \param[in] theToPoint      prefereble position of the feature (current position of the mouse)
+   *  \return \c true if the feature has been changed successfully
    */
-  bool changeWorkplane(CompositeFeaturePtr theSketch);
-
-  /** \brief Removes a workplane from the manager.
-   *         All groups based on such workplane will be removed too.
-   *  \param[in] theSketch the feature to be removed
-   *  \return \c true if the workplane removed successfully
+  bool moveFeature(const std::shared_ptr<SketchPlugin_Feature>& theMovedFeature,
+                   const std::shared_ptr<GeomAPI_Pnt2d>& theFromPoint,
+                   const std::shared_ptr<GeomAPI_Pnt2d>& theToPoint);
+
+  /** \brief Move feature using its moved attribute
+   *  \param[in] theMovedAttribute  dragged point (array of points) attribute of sketch feature
+   *  \param[in] theMovedPointIndex index of dragged point in an array (-1 otherwise)
+   *  \param[in] theFromPoint       original position of the moved point
+   *  \param[in] theToPoint         prefereble position (current position of the mouse)
+   *  \return \c true if the attribute owner has been changed successfully
    */
-  bool removeWorkplane(std::shared_ptr<SketchPlugin_Sketch> theSketch);
+  bool moveAttribute(const std::shared_ptr<ModelAPI_Attribute>& theMovedAttribute,
+                     const int theMovedPointIndex,
+                     const std::shared_ptr<GeomAPI_Pnt2d>& theFromPoint,
+                     const std::shared_ptr<GeomAPI_Pnt2d>& theToPoint);
 
-  /** \brief Updates entity which is moved in GUI
-   *  \param[in] theFeature entity to be updated
-   *  \return \c true, if the entity has been moved
+  /** \brief Removes a constraint from the manager
+   *  \param[in] theConstraint constraint to be removed
+   *  \return \c true if the constraint removed successfully
    */
-  bool moveEntity(std::shared_ptr<SketchPlugin_Feature> theFeature);
+  bool removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \brief Goes through the list of groups and solve the constraints
-   *  \param[in] theGroups  list of groups to be resolved (if empty list, all groups are resolved)
    *  \return \c true, if groups are resolved, and features should be updated 
    *  (send the Update event)
    */
-  bool resolveConstraints(const std::list<SketchSolver_Group*>& theGroups = 
-    std::list<SketchSolver_Group*>());
+  bool resolveConstraints();
 
 private:
-  /** \brief Searches list of groups which interact with specified feature
+  /** \brief Searches group which interact with specified feature
    *  \param[in]  theFeature  object to be found
-   *  \param[out] theGroups   list of group indexes interacted with the feature
+   *  \return Pointer to corresponding group or NULL if the group cannot be created.
    */
-  void findGroups(std::shared_ptr<SketchPlugin_Feature> theFeature,
-                  std::set<GroupID>& theGroupIDs) const;
-
-  /** \brief Searches in the list of groups the workplane which contains specified feature
-   *  \param[in] theFeature object to be found
-   *  \return workplane containing the feature
+  SketchGroupPtr findGroup(std::shared_ptr<SketchPlugin_Feature> theFeature);
+  /** \brief Searches group related to specified composite feature
+   *  \param[in]  theSketch  sketch to be found
+   *  \return Pointer to corresponding group or NULL if the group cannot be created.
    */
-  std::shared_ptr<ModelAPI_CompositeFeature> findWorkplane(
-      std::shared_ptr<SketchPlugin_Feature> theFeature) const;
+  SketchGroupPtr findGroup(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
 
   /// \brief Stop sending the Update event until all features updated
   /// \return \c true, if the last flushed event is Update
@@ -118,22 +126,14 @@ private:
   /// \brief Allow to send the Update event
   void allowSendUpdate() const;
 
-  /// \brief If the message shows that any group is repaired after conflicting,
-  ///        find other groups on the same sketch, which have conflicts.
-  void checkConflictingConstraints(const std::shared_ptr<Events_Message>& theMessage);
-
-  /// \brief Calculate DoF for each sketch and send messages if changed
-  void degreesOfFreedom();
+  /// \brief Allow send events about changing features in groups
+  void releaseFeaturesIfEventsBlocked() const;
 
 private:
-  static SketchSolver_Manager*     mySelf;    ///< Self pointer to implement singleton functionality
-  std::list<SketchSolver_Group*>   myGroups;  ///< Groups of constraints
-  BuilderPtr                       myBuilder; ///< Builder for solver's entities
+  std::list<SketchGroupPtr> myGroups; ///< Groups of constraints
   /// true if computation is performed and all "updates" are generated by this algo
   /// and needs no recomputation
   bool myIsComputed;
-
-  std::map<CompositeFeaturePtr, int> myDoF; ///< Degree of freedom for corresponding sketch
 };
 
 #endif