]> SALOME platform Git repositories - modules/shaper.git/blobdiff - src/SketchSolver/SketchSolver_Group.h
Salome HOME
SketchSolver Refactoring: Eliminate SolveSpace as a sketch solver.
[modules/shaper.git] / src / SketchSolver / SketchSolver_Group.h
index 193e1d54182391bfa0aa62f17d57b7b0f4392d73..c37524fa24663a90803f514199e26a7e3677f4f2 100644 (file)
@@ -7,24 +7,20 @@
 #ifndef SketchSolver_Group_H_
 #define SketchSolver_Group_H_
 
-#include "SketchSolver.h"
 #include <SketchSolver_Constraint.h>
 #include <SketchSolver_Storage.h>
 #include <SketchSolver_ISolver.h>
 
 #include <SketchPlugin_Constraint.h>
-#include <ModelAPI_Feature.h>
 
 #include <memory>
-#include <list>
 #include <map>
-#include <set>
 
 typedef std::map<ConstraintPtr, SolverConstraintPtr> ConstraintConstraintMap;
 
 /** \class   SketchSolver_Group
  *  \ingroup Plugins
- *  \brief   Keeps the group of constraints which based on the same entities
+ *  \brief   Keeps the group of constraints which placed in the same sketch
  */
 class SketchSolver_Group
 {
@@ -33,21 +29,9 @@ class SketchSolver_Group
    *         Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
    *  \remark Type of theSketch is not verified inside
    */
-  SketchSolver_Group(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
+  SketchSolver_Group(const CompositeFeaturePtr& theWorkplane);
 
-  ~SketchSolver_Group();
-
-  /// \brief Returns group's unique identifier
-  inline const GroupID& getId() const
-  {
-    return myID;
-  }
-
-  /// \brief Returns identifier of the workplane
-  inline const EntityID& getWorkplaneId() const
-  {
-    return myWorkplaneID;
-  }
+  virtual ~SketchSolver_Group();
 
   /// \brief Returns true if the group has no constraints yet
   inline bool isEmpty() const
@@ -61,12 +45,6 @@ class SketchSolver_Group
     return mySketch->data() && mySketch->data()->isValid();
   }
 
-  /// \brief Check the group has conflicting constraints
-  inline bool isFailed() const
-  {
-    return !myConflictingConstraints.empty();
-  }
-
   /** \brief Adds or updates a constraint in the group
    *  \param[in] theConstraint constraint to be changed
    *  \return \c true if the constraint added or updated successfully
@@ -85,100 +63,52 @@ class SketchSolver_Group
    */
   bool moveFeature(FeaturePtr theFeature);
 
-  /** \brief Verifies the feature attributes are used in this group
-   *  \param[in] theFeature constraint or any other object for verification of interaction
-   *  \return \c true if some of attributes are used in current group
-   */
-  bool isInteract(FeaturePtr theFeature) const;
-
-  /** \brief Verifies the specified feature is equal to the base workplane for this group
-   *  \param[in] theWorkplane the feature to be compared with base workplane
-   *  \return \c true if workplanes are the same
-   */
-  bool isBaseWorkplane(CompositeFeaturePtr theWorkplane) const;
-
   /// Returns the current workplane
-  std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
+  inline const CompositeFeaturePtr& getWorkplane() const
   {
     return mySketch;
   }
 
-  /** \brief Update parameters of workplane. Should be called when Update event is coming.
-   *  \return \c true if workplane updated successfully, 
-   *  \c false if workplane parameters are not consistent
-   */
-  bool updateWorkplane();
-
   /** \brief Searches invalid features and constraints in the group and removes them
    *  \return \c false if the group several constraints were removed
    */
-  bool isConsistent();
-
-  /** \brief Add specified group to this one
-   *  \param[in] theGroup group of constraint to be added
-   */
-  void mergeGroups(const SketchSolver_Group& theGroup);
-
-  /** \brief Cut from the group several subgroups, which are not connected to 
-   * the current one by any constraint
-   *  \param[out] theCuts enlarge this list by newly created groups
-   */
-  void splitGroup(std::list<SketchSolver_Group*>& theCuts);
+  void repairConsistency();
 
   /** \brief Start solution procedure if necessary and update attributes of features
    *  \return \c false when no need to solve constraints
    */
   bool resolveConstraints();
 
-  /** \brief Collect all features applicable for the sketch
-   *  \param theObjects  list of features
-   *  \return list of bolted and sorted features
-   */
-  static std::list<FeaturePtr> selectApplicableFeatures(const std::set<ObjectPtr>& theObjects);
+  /// \brief Block or unblock events sent by features in this group
+  void blockEvents(bool isBlocked);
 
-protected:
+private:
   /** \brief Removes constraints from the group
    *  \param[in] theConstraint constraint to be removed
    */
   void removeConstraint(ConstraintPtr theConstraint);
 
-  /// \brief Remove all temporary constraint after computation finished
+  /// \brief Remove all temporary constraints after the computation finished
   void removeTemporaryConstraints();
 
-private:
-  /** \brief Creates a workplane from the sketch parameters
-   *  \param[in] theSketch parameters of workplane are the attributes of this sketch
-   *  \return \c true if success, \c false if workplane parameters are not consistent
-   */
-  bool addWorkplane(CompositeFeaturePtr theSketch);
-
   /// \brief Append given constraint to the group of temporary constraints
   void setTemporary(SolverConstraintPtr theConstraint);
 
-  /// \brief Verifies is the feature valid
-  bool checkFeatureValidity(FeaturePtr theFeature);
-
-  /// \brief Notify all interested constraints that coincidence appears or removed
-  /// \param[in] theCoincidence  coincidence constraint
-  void notifyCoincidenceChanged(SolverConstraintPtr theCoincidence);
-
 private:
-  GroupID  myID; ///< Index of the group
-  EntityID myWorkplaneID; ///< Index of workplane, the group is based on
-  CompositeFeaturePtr mySketch; ///< Sketch is equivalent to workplane
+  CompositeFeaturePtr mySketch; ///< Sketch for this group
   ConstraintConstraintMap myConstraints; ///< List of constraints
   std::set<SolverConstraintPtr> myTempConstraints; ///< List of temporary constraints
 
-  /// List of parametric constraints
-  std::map<AttributePtr, SolverConstraintPtr> myParametricConstraints;
-
   StoragePtr myStorage; ///< Container for the set of SolveSpace constraints and their entities
-
   SolverPtr mySketchSolver;  ///< Solver for set of equations obtained by constraints
 
   /// Result of previous solution of the set of constraints
   SketchSolver_SolveStatus myPrevResult;
   std::set<ObjectPtr>      myConflictingConstraints; ///< List of conflicting constraints
+
+  bool myIsEventsBlocked; ///< shows the events are blocked for this group
 };
 
+typedef std::shared_ptr<SketchSolver_Group> SketchGroupPtr;
+
 #endif