Salome HOME
Fix for stable processing of mirror constraint (eliminating SolveSpace problems)
[modules/shaper.git] / src / SketchSolver / SketchSolver_ConstraintGroup.h
index c8a673029e2ce047589e971d17e7cdb2b132dd70..5c6f965e33b54d4344ddb5acff661dac4a11463f 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:    SketchSolver_ConstraintGroup.h
 // Created: 27 May 2014
 // Author:  Artem ZHIDKOV
 
 #include <SketchPlugin_Constraint.h>
 #include <ModelAPI_Data.h>
+#include <ModelAPI_Feature.h>
+
 
+#include <memory>
 #include <list>
 #include <map>
 #include <vector>
 #include <set>
 
-typedef std::map< boost::shared_ptr<SketchPlugin_Constraint>, std::vector<Slvs_hConstraint> >
+typedef std::map< std::shared_ptr<SketchPlugin_Constraint>, std::vector<Slvs_hConstraint> >
   ConstraintMap;
 
 /** \class   SketchSolver_ConstraintGroup
- *  \ingroup DataModel
+ *  \ingroup Plugins
  *  \brief   Keeps the group of constraints which based on the same entities
  */
 class SketchSolver_ConstraintGroup
@@ -30,7 +35,7 @@ class SketchSolver_ConstraintGroup
    *         Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
    *  \remark Type of theSketch is not verified inside
    */
-  SketchSolver_ConstraintGroup(boost::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
+  SketchSolver_ConstraintGroup(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
 
   ~SketchSolver_ConstraintGroup();
 
@@ -56,22 +61,37 @@ class SketchSolver_ConstraintGroup
    *  \param[in] theConstraint constraint to be changed
    *  \return \c true if the constraint added or updated successfully
    */
-  bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
-  bool changeRigidConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  /** \brief Adds or updates a rigid constraint in the group
+   *  \param[in] theConstraint constraint to be changed
+   *  \return \c true if the constraint added or updated successfully
+   */
+  bool changeRigidConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  /** \brief Adds or updates a mirror constraint in the group
+   *  \param[in] theConstraint constraint to be changed
+   *  \return \c true if the constraint added or updated successfully
+   */
+  bool changeMirrorConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  /** \brief Adds or updates a fillet constraint in the group
+   *  \param[in] theConstraint constraint to be changed
+   *  \return \c true if the constraint added or updated successfully
+   */
+  bool changeFilletConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \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(boost::shared_ptr<SketchPlugin_Feature> theFeature) const;
+  bool isInteract(std::shared_ptr<SketchPlugin_Feature> 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(boost::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
+  bool isBaseWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
 
-  boost::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
+  /// Returns the current workplane
+  std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
   {
     return mySketch;
   }
@@ -84,7 +104,7 @@ class SketchSolver_ConstraintGroup
   /** \brief If the entity is in this group it will updated
    *  \param[in] theEntity attribute, which values should update SolveSpace entity
    */
-  void updateEntityIfPossible(boost::shared_ptr<ModelAPI_Attribute> theEntity);
+  void updateEntityIfPossible(std::shared_ptr<ModelAPI_Attribute> theEntity);
 
   /** \brief Searches invalid features and constraints in the group and avoids them
    *  \return \c true if the group several constraints were removed
@@ -109,8 +129,11 @@ class SketchSolver_ConstraintGroup
   /** \brief Searches the constraints built on the entity and emit the signal to update them
    *  \param[in] theEntity attribute of the constraint
    */
-  void updateRelatedConstraints(boost::shared_ptr<ModelAPI_Attribute> theEntity) const;
-  void updateRelatedConstraints(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
+  void updateRelatedConstraints(std::shared_ptr<ModelAPI_Attribute> theEntity) const;
+  /** \brief Searches the constraints built on the entity and emit the signal to update them
+   *  \param[in] theFeature feature of the constraint
+   */
+  void updateRelatedConstraintsFeature(std::shared_ptr<ModelAPI_Feature> theFeature) const;
 
   /** \brief Adds or updates an entity in the group
    *
@@ -120,8 +143,8 @@ class SketchSolver_ConstraintGroup
    *  \param[in] theEntity the object of constraint
    *  \return identifier of changed entity or 0 if entity could not be changed
    */
-  Slvs_hEntity changeEntity(boost::shared_ptr<ModelAPI_Attribute> theEntity);
-  Slvs_hEntity changeEntity(FeaturePtr theEntity);
+  Slvs_hEntity changeEntity(std::shared_ptr<ModelAPI_Attribute> theEntity);
+  Slvs_hEntity changeEntityFeature(std::shared_ptr<ModelAPI_Feature> theEntity);
 
 protected:
   /** \brief Adds or updates a normal in the group
@@ -137,9 +160,9 @@ protected:
    *  \param[in] theNorm attribute for the normal (used to identify newly created entity)
    *  \return identifier of created or updated normal
    */
-  Slvs_hEntity changeNormal(boost::shared_ptr<ModelAPI_Attribute> theDirX,
-                            boost::shared_ptr<ModelAPI_Attribute> theDirY,
-                            boost::shared_ptr<ModelAPI_Attribute> theNorm);
+  Slvs_hEntity changeNormal(std::shared_ptr<ModelAPI_Attribute> theDirX,
+                            std::shared_ptr<ModelAPI_Attribute> theDirY,
+                            std::shared_ptr<ModelAPI_Attribute> theNorm);
 
   /** \brief Adds or updates a parameter in the group
    *  \param[in] theParam   the value of parameter
@@ -158,23 +181,26 @@ protected:
   /** \brief Removes constraints from the group
    *  \param[in] theConstraint constraint to be removed
    */
-  void removeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
+  void removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 
   /** \brief Change values of attribute by parameters received from SolveSpace solver
    *  \param[in,out] theAttribute pointer to the attribute to be changed
    *  \param[in]     theEntityID  identifier of SolveSpace entity, which contains updated data
    *  \return \c true if the attribute's value has changed
    */
-  bool updateAttribute(boost::shared_ptr<ModelAPI_Attribute> theAttribute,
+  bool updateAttribute(std::shared_ptr<ModelAPI_Attribute> theAttribute,
                        const Slvs_hEntity& theEntityID);
 
+  /// \brief Update arc of fillet to be less than 180 degree
+  void updateFilletConstraints();
+
   /** \brief Adds a constraint for a point which should not be changed during computations
    *  \param[in] theEntity     the base for the constraint
    *  \param[in] theAllowToFit this flag shows that the entity may be placed into 
    *                           the 'dragged' field of SolveSpace solver, so this entity 
    *                           may be changed a little during solution
    */
-  void addTemporaryConstraintWhereDragged(boost::shared_ptr<ModelAPI_Attribute> theEntity,
+  void addTemporaryConstraintWhereDragged(std::shared_ptr<ModelAPI_Attribute> theEntity,
                                           bool theAllowToFit = true);
 
   /** \brief Remove all temporary constraint after computation finished
@@ -188,7 +214,7 @@ protected:
    *  \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(boost::shared_ptr<ModelAPI_CompositeFeature> theSketch);
+  bool addWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
 
   /** \brief Add the entities of constraint for points coincidence into the appropriate list
    *  \param[in] thePoint1 identifier of the first point
@@ -204,6 +230,23 @@ protected:
    */
   void checkConstraintConsistence(Slvs_Constraint& theConstraint);
 
+  /** \brief Change entities parameters to make them symmetric relating to the mirror line
+   *  \param[in] theBase        entity to be mirrored
+   *  \param[in] theMirror      a mirrored object
+   *  \param[in] theMirrorLine  a mirror line
+   */
+  void makeMirrorEntity(const Slvs_hEntity& theBase,
+                        const Slvs_hEntity& theMirror,
+                        const Slvs_hEntity& theMirrorLine);
+
+  /** \brief Calculates middle point on line or arc
+   *  \param[in]  theEntity  identifier of line or arc
+   *  \param[out] theX       X value of middle point
+   *  \param[out] theY       Y value of middle point
+   */
+  void calculateMiddlePoint(const Slvs_hEntity& theEntity,
+                            double& theX, double& theY) const;
+
  private:
   // SolveSpace entities
   Slvs_hGroup myID;            ///< the index of the group
@@ -224,14 +267,14 @@ protected:
   std::list<Slvs_hConstraint> myTempConstraints;  ///< The list of identifiers of temporary constraints (SLVS_C_WHERE_DRAGGED) applied for all other points moved by user
 
   // SketchPlugin entities
-  boost::shared_ptr<ModelAPI_CompositeFeature> mySketch;        ///< Equivalent to workplane
+  std::shared_ptr<ModelAPI_CompositeFeature> mySketch;        ///< Equivalent to workplane
   ConstraintMap myConstraintMap;  ///< The map between SketchPlugin and SolveSpace constraints
-  std::map<boost::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap;  ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
+  std::map<std::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap;  ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
   std::map<FeaturePtr, Slvs_hEntity> myEntityFeatMap;  ///< The map between "feature" parameters of constraints and their equivalent SolveSpace entities
 
   // Conincident items
   std::vector<std::set<Slvs_hEntity> > myCoincidentPoints;  ///< Stores the lists of identifiers of coincident points (to avoid unnecessary coincidence constraints)
-  std::set<boost::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence;  ///< Additional coincidence constraints which are not necessary (coincidence between points already done
+  std::set<std::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence;  ///< Additional coincidence constraints which are not necessary (coincidence between points already done
                                                                              ///< by other constraints) but created by GUI tools. Useful when some coincidence constraints were removed
 };