src/SketchSolver/SketchSolver_ConstraintGroup.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    SketchSolver_ConstraintGroup.h
   4 // Created: 27 May 2014
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchSolver_ConstraintGroup_H_
   8 #define SketchSolver_ConstraintGroup_H_
   9
  10 #include "SketchSolver.h"
  11 #include <SketchSolver_Solver.h>
  12
  13 #include <SketchPlugin_Constraint.h>
  14 #include <ModelAPI_Data.h>
  15 #include <ModelAPI_Feature.h>
  16
  17
  18 #include <memory>
  19 #include <list>
  20 #include <map>
  21 #include <vector>
  22 #include <set>
  23
  24 typedef std::map< std::shared_ptr<SketchPlugin_Constraint>, std::vector<Slvs_hConstraint> >
  25   ConstraintMap;
  26
  27 /** \class   SketchSolver_ConstraintGroup
  28  *  \ingroup Plugins
  29  *  \brief   Keeps the group of constraints which based on the same entities
  30  */
  31 class SketchSolver_ConstraintGroup
  32 {
  33  public:
  34   /** \brief New group based on specified workplane.
  35    *         Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
  36    *  \remark Type of theSketch is not verified inside
  37    */
  38   SketchSolver_ConstraintGroup(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
  39
  40   ~SketchSolver_ConstraintGroup();
  41
  42   /// \brief Returns group's unique identifier
  43   inline const Slvs_hGroup& getId() const
  44   {
  45     return myID;
  46   }
  47
  48   /// \brief Returns true if the group has no constraints yet
  49   inline bool isEmpty() const
  50   {
  51     return myConstraints.empty();
  52   }
  53
  54   /// \brief Check for valid sketch data
  55   inline bool isWorkplaneValid() const
  56   {
  57     return mySketch->data() && mySketch->data()->isValid();
  58   }
  59
  60   /** \brief Adds or updates a constraint in the group
  61    *  \param[in] theConstraint constraint to be changed
  62    *  \return \c true if the constraint added or updated successfully
  63    */
  64   bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
  65   /** \brief Adds or updates a rigid constraint in the group
  66    *  \param[in] theConstraint constraint to be changed
  67    *  \return \c true if the constraint added or updated successfully
  68    */
  69   bool changeRigidConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
  70
  71   /** \brief Verifies the feature attributes are used in this group
  72    *  \param[in] theFeature constraint or any other object for verification of interaction
  73    *  \return \c true if some of attributes are used in current group
  74    */
  75   bool isInteract(std::shared_ptr<SketchPlugin_Feature> theFeature) const;
  76
  77   /** \brief Verifies the specified feature is equal to the base workplane for this group
  78    *  \param[in] theWorkplane the feature to be compared with base workplane
  79    *  \return \c true if workplanes are the same
  80    */
  81   bool isBaseWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
  82
  83   /// Returns the current workplane
  84   std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
  85   {
  86     return mySketch;
  87   }
  88
  89   /** \brief Update parameters of workplane. Should be called when Update event is coming.
  90    *  \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
  91    */
  92   bool updateWorkplane();
  93
  94   /** \brief If the entity is in this group it will updated
  95    *  \param[in] theEntity attribute, which values should update SolveSpace entity
  96    */
  97   void updateEntityIfPossible(std::shared_ptr<ModelAPI_Attribute> theEntity);
  98
  99   /** \brief Searches invalid features and constraints in the group and avoids them
 100    *  \return \c true if the group several constraints were removed
 101    */
 102   bool updateGroup();
 103
 104   /** \brief Add specified group to this one
 105    *  \param[in] theGroup group of constraint to be added
 106    */
 107   void mergeGroups(const SketchSolver_ConstraintGroup& theGroup);
 108
 109   /** \brief Cut from the group several subgroups, which are not connected to the current one by any constraint
 110    *  \param[out] theCuts enlarge this list by newly created groups
 111    */
 112   void splitGroup(std::vector<SketchSolver_ConstraintGroup*>& theCuts);
 113
 114   /** \brief Start solution procedure if necessary and update attributes of features
 115    *  \return \c false when no need to solve constraints
 116    */
 117   bool resolveConstraints();
 118
 119   /** \brief Searches the constraints built on the entity and emit the signal to update them
 120    *  \param[in] theEntity attribute of the constraint
 121    */
 122   void updateRelatedConstraints(std::shared_ptr<ModelAPI_Attribute> theEntity) const;
 123   /** \brief Searches the constraints built on the entity and emit the signal to update them
 124    *  \param[in] theFeature feature of the constraint
 125    */
 126   void updateRelatedConstraintsFeature(std::shared_ptr<ModelAPI_Feature> theFeature) const;
 127
 128   /** \brief Adds or updates an entity in the group
 129    *
 130    *  The parameters of entity will be parsed and added to the list of SolveSpace parameters.
 131    *  Parameters of certain entity will be placed sequentially in the list.
 132    *
 133    *  \param[in] theEntity the object of constraint
 134    *  \return identifier of changed entity or 0 if entity could not be changed
 135    */
 136   Slvs_hEntity changeEntity(std::shared_ptr<ModelAPI_Attribute> theEntity);
 137   Slvs_hEntity changeEntityFeature(std::shared_ptr<ModelAPI_Feature> theEntity);
 138
 139 protected:
 140   /** \brief Adds or updates a normal in the group
 141    *
 142    *  Normal is a special entity in SolveSpace, which defines a direction in 3D and
 143    *  a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
 144    *
 145    *  To define a normal there should be specified two coordinate axis
 146    *  on the plane transversed to created normal.
 147    *
 148    *  \param[in] theDirX first coordinate axis of the plane
 149    *  \param[in] theDirY second coordinate axis of the plane
 150    *  \param[in] theNorm attribute for the normal (used to identify newly created entity)
 151    *  \return identifier of created or updated normal
 152    */
 153   Slvs_hEntity changeNormal(std::shared_ptr<ModelAPI_Attribute> theDirX,
 154                             std::shared_ptr<ModelAPI_Attribute> theDirY,
 155                             std::shared_ptr<ModelAPI_Attribute> theNorm);
 156
 157   /** \brief Adds or updates a parameter in the group
 158    *  \param[in] theParam   the value of parameter
 159    *  \param[in] thePrmIter the cell in the list of parameters which should be changed
 160    *                        (the iterator will be increased if it does not reach the end of the list)
 161    *  \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
 162    */
 163   Slvs_hParam changeParameter(const double& theParam,
 164                               std::vector<Slvs_Param>::const_iterator& thePrmIter);
 165
 166   /** \brief Removes specified entities and their parameters
 167    *  \param[in] theEntities  list of IDs of the entities to be removed
 168    */
 169   void removeEntitiesById(const std::set<Slvs_hEntity>& theEntities);
 170
 171   /** \brief Removes constraints from the group
 172    *  \param[in] theConstraint constraint to be removed
 173    */
 174   void removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 175
 176   /** \brief Change values of attribute by parameters received from SolveSpace solver
 177    *  \param[in,out] theAttribute pointer to the attribute to be changed
 178    *  \param[in]     theEntityID  identifier of SolveSpace entity, which contains updated data
 179    *  \return \c true if the attribute's value has changed
 180    */
 181   bool updateAttribute(std::shared_ptr<ModelAPI_Attribute> theAttribute,
 182                        const Slvs_hEntity& theEntityID);
 183
 184   /** \brief Adds a constraint for a point which should not be changed during computations
 185    *  \param[in] theEntity     the base for the constraint
 186    *  \param[in] theAllowToFit this flag shows that the entity may be placed into
 187    *                           the 'dragged' field of SolveSpace solver, so this entity
 188    *                           may be changed a little during solution
 189    */
 190   void addTemporaryConstraintWhereDragged(std::shared_ptr<ModelAPI_Attribute> theEntity,
 191                                           bool theAllowToFit = true);
 192
 193   /** \brief Remove all temporary constraint after computation finished
 194    *  \param[in] theRemoved  indexes of constraints to be removed. If empty, all temporary constraints should be deleted
 195    */
 196   void removeTemporaryConstraints(const std::set<Slvs_hConstraint>& theRemoved =
 197                                                                  std::set<Slvs_hConstraint>());
 198
 199  private:
 200   /** \brief Creates a workplane from the sketch parameters
 201    *  \param[in] theSketch parameters of workplane are the attributes of this sketch
 202    *  \return \c true if success, \c false if workplane parameters are not consistent
 203    */
 204   bool addWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
 205
 206   /** \brief Add the entities of constraint for points coincidence into the appropriate list
 207    *  \param[in] thePoint1 identifier of the first point
 208    *  \param[in] thePoint2 identifier of the second point
 209    *  \return \c true if the points are added successfully, and
 210    *          \c false if the constraint is the extra one (should not be created in SolveSpace)
 211    */
 212   bool addCoincidentPoints(const Slvs_hEntity& thePoint1, const Slvs_hEntity& thePoint2);
 213
 214   /** \brief Verifies and changes parameters of constriant,
 215    *         e.g. sign of the distance between line and point
 216    *  \param[in,out] theConstraint SolveSpace constraint to be verified
 217    */
 218   void checkConstraintConsistence(Slvs_Constraint& theConstraint);
 219
 220  private:
 221   // SolveSpace entities
 222   Slvs_hGroup myID;            ///< the index of the group
 223   Slvs_Entity myWorkplane;     ///< Workplane for the current group
 224   std::vector<Slvs_Param> myParams;        ///< List of parameters of the constraints
 225   Slvs_hParam myParamMaxID;    ///< Actual maximal ID of parameters (not equal to myParams size)
 226   std::vector<Slvs_Entity> myEntities;      ///< List of entities of the constaints
 227   std::vector<bool> myEntOfConstr; ///< Flags show that certain entity used in constraints
 228   Slvs_hEntity myEntityMaxID;   ///< Actual maximal ID of entities (not equal to myEntities size)
 229   std::vector<Slvs_Constraint> myConstraints;   ///< List of constraints in SolveSpace format
 230   Slvs_hConstraint myConstrMaxID;  ///< Actual maximal ID of constraints (not equal to myConstraints size)
 231   bool myNeedToSolve;  ///< Indicator that something changed in the group and constraint system need to be rebuilt
 232
 233   SketchSolver_Solver myConstrSolver;  ///< Solver for set of equations obtained by constraints
 234
 235   std::vector<Slvs_hParam> myTempPointWhereDragged;  ///< Parameters of one of the points which is moved by user
 236   Slvs_hEntity myTempPointWDrgdID;      ///< Identifier of such point
 237   std::list<Slvs_hConstraint> myTempConstraints;  ///< The list of identifiers of temporary constraints (SLVS_C_WHERE_DRAGGED) applied for all other points moved by user
 238
 239   // SketchPlugin entities
 240   std::shared_ptr<ModelAPI_CompositeFeature> mySketch;        ///< Equivalent to workplane
 241   ConstraintMap myConstraintMap;  ///< The map between SketchPlugin and SolveSpace constraints
 242   std::map<std::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap;  ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
 243   std::map<FeaturePtr, Slvs_hEntity> myEntityFeatMap;  ///< The map between "feature" parameters of constraints and their equivalent SolveSpace entities
 244
 245   // Conincident items
 246   std::vector<std::set<Slvs_hEntity> > myCoincidentPoints;  ///< Stores the lists of identifiers of coincident points (to avoid unnecessary coincidence constraints)
 247   std::set<std::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence;  ///< Additional coincidence constraints which are not necessary (coincidence between points already done
 248                                                                              ///< by other constraints) but created by GUI tools. Useful when some coincidence constraints were removed
 249 };
 250
 251 #endif