src/SketchSolver/SketchSolver_ConstraintManager.h

   1 // File:    SketchSolver_ConstraintManager.h
   2 // Created: 08 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchSolver_ConstraintManager_Headerfile
   6 #define SketchSolver_ConstraintManager_Headerfile
   7
   8 #include "SketchSolver.h"
   9 #include <SketchSolver_Solver.h>
  10
  11 #include <Events_Listener.h>
  12 #include <SketchPlugin_Constraint.h>
  13
  14 #include <string.h>
  15 #include <slvs.h>
  16
  17 #include <list>
  18 #include <map>
  19 #include <vector>
  20
  21
  22 // Unknown constraint (for error reporting)
  23 #define SLVS_C_UNKNOWN 0
  24 // Unknown entity
  25 #define SLVS_E_UNKNOWN 0
  26
  27 /** \class   SketchSolver_ConstraintManager
  28  *  \ingroup DataModel
  29  *  \brief   Listens the changes of SketchPlugin features and transforms the Constraint
  30  *           feature into the format understandable by SolveSpace library.
  31  *
  32  *  Constraints created for SolveSpace library are divided into the groups.
  33  *  The division order based on connectedness of the features by the constraints.
  34  *  The groups may be fused or separated according to the new constraints.
  35  *
  36  *  \remark This is a singleton.
  37  */
  38 class SketchSolver_ConstraintManager : public Events_Listener
  39 {
  40 public:
  41   /** \brief Main method to create constraint manager
  42    *  \return pointer to the singleton
  43    */
  44   static SketchSolver_ConstraintManager* Instance();
  45
  46   /** \brief Implementation of Event Listener method
  47    *  \param[in] theMessage the data of the event
  48    */
  49   virtual void processEvent(const Events_Message* theMessage);
  50
  51 protected:
  52   SketchSolver_ConstraintManager();
  53   ~SketchSolver_ConstraintManager();
  54
  55   /** \brief Adds or updates a constraint in the suitable group
  56    *  \param[in] theConstraint constraint to be changed
  57    *  \return \c true if the constraint changed successfully
  58    */
  59   bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
  60
  61   /** \brief Removes a constraint from the manager
  62    *  \param[in] theConstraint constraint to be removed
  63    *  \return \c true if the constraint removed successfully
  64    */
  65   bool removeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
  66
  67   /** \brief Adds or updates a workplane in the manager
  68    *  \param[in] theSketch the feature to create or update workplane
  69    *  \return \c true if the workplane changed successfully
  70    *  \remark Type of theSketch is not verified inside
  71    */
  72   bool changeWorkplane(boost::shared_ptr<SketchPlugin_Feature> theSketch);
  73
  74   /** \brief Removes a workplane from the manager.
  75    *         All groups based on such workplane will be removed too.
  76    *  \param[in] theSketch the feature to be removed
  77    *  \return \c true if the workplane removed successfully
  78    */
  79   bool removeWorkplane(boost::shared_ptr<SketchPlugin_Sketch> theSketch);
  80
  81   /** \brief Updates entity which is neither workplane nor constraint
  82    *  \param[in] theFeature entity to be updated
  83    */
  84   void updateEntity(boost::shared_ptr<SketchPlugin_Feature> theFeature);
  85
  86   /** \brief Goes through the list of groups and solve the constraints
  87    *  \param[in] needEvent shows that some features are probably updated and Update event should be thrown
  88    */
  89   void resolveConstraints(const bool needEvent);
  90
  91 private:
  92   class SketchSolver_ConstraintGroup;
  93
  94   /** \brief Searches list of groups which interact with specified constraint
  95    *  \param[in]  theConstraint constraint to be found
  96    *  \param[out] theGroups     list of group indexes interacted with constraint
  97    */
  98   void findGroups(boost::shared_ptr<SketchPlugin_Constraint> theConstraint,
  99                   std::vector<Slvs_hGroup>&                  theGroupIDs) const;
 100
 101   /** \brief Searches in the list of groups the workplane which constains specified constraint
 102    *  \param[in] theConstraint constraint to be found
 103    *  \return workplane containing the constraint
 104    */
 105   boost::shared_ptr<SketchPlugin_Feature> findWorkplaneForConstraint(
 106                   boost::shared_ptr<SketchPlugin_Constraint> theConstraint) const;
 107
 108 private:
 109   static SketchSolver_ConstraintManager*    _self;    ///< Self pointer to implement singleton functionality
 110   std::vector<SketchSolver_ConstraintGroup*> myGroups; ///< Groups of constraints
 111 };
 112
 113
 114 /** \class   SketchSolver_ConstraintGroup
 115  *  \ingroup DataModel
 116  *  \brief   Keeps the group of constraints which based on the same entities
 117  */
 118 class SketchSolver_ConstraintManager::SketchSolver_ConstraintGroup
 119 {
 120 public:
 121   /** \brief New group based on specified workplane.
 122    *         Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
 123    *  \remark Type of theSketch is not verified inside
 124    */
 125   SketchSolver_ConstraintGroup(boost::shared_ptr<SketchPlugin_Feature> theWorkplane);
 126
 127   ~SketchSolver_ConstraintGroup();
 128
 129   /// \brief Returns group's unique identifier
 130   const Slvs_hGroup& getId() const
 131   {return myID;}
 132
 133   /** \brief Adds or updates a constraint in the group
 134    *  \param[in] theConstraint constraint to be changed
 135    *  \return \c true if the constraint added or updated successfully
 136    */
 137   bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
 138
 139   /** \brief Verifies the constraint uses the objects from this group
 140    *  \param[in] theConstraint constraint for verification of interaction
 141    *  \return \c true if the constrained objects are used in current group
 142    */
 143   bool isInteract(boost::shared_ptr<SketchPlugin_Constraint> theConstraint) const;
 144
 145   /** \brief Verifies the specified feature is equal to the base workplane for this group
 146    *  \param[in] theWorkplane the feature to be compared with base workplane
 147    *  \return \c true if workplanes are the same
 148    */
 149   bool isBaseWorkplane(boost::shared_ptr<SketchPlugin_Feature> theWorkplane) const;
 150
 151   boost::shared_ptr<SketchPlugin_Feature> getWorkplane() const
 152   { return mySketch; }
 153
 154   /** \brief Update parameters of workplane. Should be called when Update event is coming.
 155    *  \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
 156    */
 157   bool updateWorkplane();
 158
 159   /** \brief If the entity is in this group it will updated
 160    *  \param[in] theEntity attribute, which values should update SolveSpace entity
 161    */
 162   void updateEntityIfPossible(boost::shared_ptr<ModelAPI_Attribute> theEntity);
 163
 164   /** \brief Searches invalid features and constraints in the group and avoids them
 165    *  \return \c true if the group's sketch is invalid and the group should be removed
 166    */
 167   bool updateGroup();
 168
 169   /** \brief Start solution procedure if necessary and update attributes of features
 170    */
 171   void resolveConstraints();
 172
 173 protected:
 174   /** \brief Adds or updates an entity in the group
 175    *
 176    *  The parameters of entity will be parsed and added to the list of SolveSpace parameters.
 177    *  Parameters of certain entity will be placed sequentially in the list.
 178    *
 179    *  \param[in] theEntity the object of constraint
 180    *  \return identifier of changed entity or 0 if entity could not be changed
 181    */
 182   Slvs_hEntity changeEntity(boost::shared_ptr<ModelAPI_Attribute> theEntity);
 183
 184   /** \brief Adds or updates a normal in the group
 185    *
 186    *  Normal is a special entity in SolveSpace, which defines a direction in 3D and
 187    *  a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
 188    *
 189    *  To define a normal there should be specified two coordinate axis
 190    *  on the plane transversed to created normal.
 191    *
 192    *  \param[in] theDirX first coordinate axis of the plane
 193    *  \param[in] theDirY second coordinate axis of the plane
 194    *  \param[in] theNorm attribute for the normal (used to identify newly created entity)
 195    *  \return identifier of created or updated normal
 196    */
 197   Slvs_hEntity changeNormal(boost::shared_ptr<ModelAPI_Attribute> theDirX,
 198                             boost::shared_ptr<ModelAPI_Attribute> theDirY,
 199                             boost::shared_ptr<ModelAPI_Attribute> theNorm);
 200
 201   /** \brief Adds or updates a parameter in the group
 202    *  \param[in] theParam   the value of parameter
 203    *  \param[in] thePrmIter the cell in the list of parameters which should be changed
 204    *                        (the iterator will be increased if it does not reach the end of the list)
 205    *  \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
 206    */
 207   Slvs_hParam changeParameter(const double& theParam,
 208                               std::vector<Slvs_Param>::const_iterator& thePrmIter);
 209
 210   /** \brief Compute constraint type according to SolveSpace identifiers
 211    *         and verify that constraint parameters are correct
 212    *  \param[in] theConstraint constraint which type should be determined
 213    *  \return identifier of constraint type or SLVS_C_UNKNOWN if the type is wrong
 214    */
 215   int getConstraintType(const boost::shared_ptr<SketchPlugin_Constraint>& theConstraint) const;
 216
 217   /** \brief Change values of attribute by parameters received from SolveSpace solver
 218    *  \param[in,out] theAttribute pointer to the attribute to be changed
 219    *  \param[in]     theEntityID  identifier of SolveSpace entity, which contains updated data
 220    */
 221   void updateAttribute(boost::shared_ptr<ModelAPI_Attribute> theAttribute, const Slvs_hEntity& theEntityID);
 222
 223   /** \brief Adds a constraint for a point which should not be changed during computations
 224    *  \param[in] theEntity the base for the constraint
 225    */
 226   void addTemporaryConstraintWhereDragged(boost::shared_ptr<ModelAPI_Attribute> theEntity);
 227
 228   /** \brief Remove all temporary constraint after computation finished
 229    */
 230   void removeTemporaryConstraints();
 231
 232 private:
 233   /** \brief Creates a workplane from the sketch parameters
 234    *  \param[in] theSketch parameters of workplane are the attributes of this sketch
 235    *  \return \c true if success, \c false if workplane parameters are not consistent
 236    */
 237   bool addWorkplane(boost::shared_ptr<SketchPlugin_Feature> theSketch);
 238
 239 private:
 240   // SolveSpace entities
 241   Slvs_hGroup                  myID;            ///< the index of the group
 242   Slvs_Entity                  myWorkplane;     ///< Workplane for the current group
 243   std::vector<Slvs_Param>      myParams;        ///< List of parameters of the constraints
 244   Slvs_hParam                  myParamMaxID;    ///< Actual maximal ID of parameters (not equal to myParams size)
 245   std::vector<Slvs_Entity>     myEntities;      ///< List of entities of the constaints
 246   Slvs_hEntity                 myEntityMaxID;   ///< Actual maximal ID of entities (not equal to myEntities size)
 247   std::vector<Slvs_Constraint> myConstraints;   ///< List of constraints in SolveSpace format
 248   Slvs_hConstraint             myConstrMaxID;   ///< Actual maximal ID of constraints (not equal to myConstraints size)
 249   bool                         myNeedToSolve;   ///< Indicator that something changed in the group and constraint system need to be rebuilt
 250
 251   SketchSolver_Solver          myConstrSolver;  ///< Solver for set of equations obtained by constraints
 252
 253   // SketchPlugin entities
 254   boost::shared_ptr<SketchPlugin_Feature> mySketch; ///< Equivalent to workplane
 255   std::map<boost::shared_ptr<SketchPlugin_Constraint>, Slvs_hConstraint>
 256                                 myConstraintMap;    ///< The map between SketchPlugin and SolveSpace constraints
 257   std::list<Slvs_hConstraint> myTempConstraints;    ///< The list of identifiers of temporary constraints
 258   std::map<boost::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity>
 259                                 myEntityMap;        ///< The map between parameters of constraints and their equivalent SolveSpace entities
 260 };
 261
 262 #endif