Salome HOME
SketchSolver Refactoring: Eliminate SolveSpace as a sketch solver.
[modules/shaper.git] / src / SketchSolver / SketchSolver_Manager.h
index c1e853603273d070854a9f1d1a98b0460ae796a6..89a9b7acc77aa4d9edd2960c15ce33df67af22e2 100644 (file)
 /** \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 +30,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
@@ -49,7 +45,7 @@ public:
 
   /// \brief Initialize builder for solver's data structure entities
   /// \param theBuilder [in]  solver's specific builder
-  SKETCHSOLVER_EXPORT void setBuilder(BuilderPtr theBuilder);
+  void setBuilder(BuilderPtr theBuilder);
   /// \brief Returns the builder specific for the solver
   BuilderPtr builder();
 
@@ -59,9 +55,10 @@ protected:
 
   /** \brief Adds or updates a constraint or an entity in the suitable group
    *  \param[in] theFeature sketch feature to be changed
+   *  \param[in] theMoved   \c true if the feature has been moved in the viewer
    *  \return \c true if the feature changed successfully
    */
-  bool changeFeature(std::shared_ptr<SketchPlugin_Feature> theFeature);
+  bool updateFeature(std::shared_ptr<SketchPlugin_Feature> theFeature, bool theMoved = false);
 
   /** \brief Removes a constraint from the manager
    *  \param[in] theConstraint constraint to be removed
@@ -69,48 +66,18 @@ protected:
    */
   bool removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
-  /** \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
-   */
-  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 removeWorkplane(std::shared_ptr<SketchPlugin_Sketch> theSketch);
-
-  /** \brief Updates entity which is moved in GUI
-   *  \param[in] theFeature entity to be updated
-   *  \return \c true, if the entity has been moved
-   */
-  bool moveEntity(std::shared_ptr<SketchPlugin_Feature> theFeature);
-
   /** \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
-   */
-  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
+   *  \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<SketchPlugin_Feature> theFeature);
 
   /// \brief Stop sending the Update event until all features updated
   /// \return \c true, if the last flushed event is Update
@@ -118,22 +85,12 @@ 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();
-
 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
+  BuilderPtr                  myBuilder; ///< Builder for solver's entities
   /// 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