src/SketchSolver/SketchSolver_ConstraintGroup.h

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