src/SketchSolver/SketchSolver_Manager.h

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SketchSolver_Manager_H_
  21 #define SketchSolver_Manager_H_
  22
  23 #include <SketchSolver_Group.h>
  24
  25 #include <Events_Listener.h>
  26
  27 #include <list>
  28 #include <set>
  29
  30 class GeomAPI_Pnt2d;
  31 class GeomDataAPI_Point2D;
  32 class ModelAPI_CompositeFeature;
  33 class SketchPlugin_Constraint;
  34
  35 /** \class   SketchSolver_Manager
  36  *  \ingroup Plugins
  37  *  \brief   Listens the changes of SketchPlugin features and transforms the Constraint
  38  *           feature into the format understandable by sketch solver.
  39  *
  40  *  \remark This is a singleton.
  41  */
  42 class SketchSolver_Manager : public Events_Listener
  43 {
  44 public:
  45   /** \brief Main method to create constraint manager
  46    *  \return pointer to the singleton
  47    */
  48   static SketchSolver_Manager* instance();
  49
  50   /** \brief Implementation of Event Listener method
  51    *  \param[in] theMessage the data of the event
  52    */
  53   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
  54
  55   /**
  56    * The solver needs all the updated objects are transfered in one group, not one by one.
  57    * This iscreases performance and avoids problems in resolve of only part of the made updates.
  58    */
  59   virtual bool groupMessages();
  60
  61 protected:
  62   SketchSolver_Manager();
  63   ~SketchSolver_Manager();
  64
  65   /** \brief Adds or updates a constraint or an entity in the suitable group
  66    *  \param[in] theFeature sketch feature to be changed
  67    *  \return \c true if the feature changed successfully
  68    */
  69   bool updateFeature(const std::shared_ptr<SketchPlugin_Feature>& theFeature);
  70
  71   /** \brief Updates the sketch and related constraints, if the sketch plane is changed
  72    *  \param[in] theSketch sketch to be updated
  73    *  \return \c true if the sketch plane is changed
  74    */
  75   bool updateSketch(const std::shared_ptr<ModelAPI_CompositeFeature>& theSketch);
  76
  77   /** \brief Move feature
  78    *  \param[in] theMovedFeature dragged sketch feature
  79    *  \param[in] theFromPoint    original position of the feature
  80    *  \param[in] theToPoint      prefereble position of the feature (current position of the mouse)
  81    *  \return \c true if the feature has been changed successfully
  82    */
  83   bool moveFeature(const std::shared_ptr<SketchPlugin_Feature>& theMovedFeature,
  84                    const std::shared_ptr<GeomAPI_Pnt2d>& theFromPoint,
  85                    const std::shared_ptr<GeomAPI_Pnt2d>& theToPoint);
  86
  87   /** \brief Move feature using its moved attribute
  88    *  \param[in] theMovedAttribute  dragged point (array of points) attribute of sketch feature
  89    *  \param[in] theMovedPointIndex index of dragged point in an array (-1 otherwise)
  90    *  \param[in] theFromPoint       original position of the moved point
  91    *  \param[in] theToPoint         prefereble position (current position of the mouse)
  92    *  \return \c true if the attribute owner has been changed successfully
  93    */
  94   bool moveAttribute(const std::shared_ptr<ModelAPI_Attribute>& theMovedAttribute,
  95                      const int theMovedPointIndex,
  96                      const std::shared_ptr<GeomAPI_Pnt2d>& theFromPoint,
  97                      const std::shared_ptr<GeomAPI_Pnt2d>& theToPoint);
  98
  99   /** \brief Removes a constraint from the manager
 100    *  \param[in] theConstraint constraint to be removed
 101    *  \return \c true if the constraint removed successfully
 102    */
 103   bool removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
 104
 105   /** \brief Goes through the list of groups and solve the constraints
 106    *  \return \c true, if groups are resolved, and features should be updated
 107    *  (send the Update event)
 108    */
 109   bool resolveConstraints();
 110
 111 private:
 112   /** \brief Searches group which interact with specified feature
 113    *  \param[in]  theFeature  object to be found
 114    *  \return Pointer to corresponding group or NULL if the group cannot be created.
 115    */
 116   SketchGroupPtr findGroup(std::shared_ptr<SketchPlugin_Feature> theFeature);
 117   /** \brief Searches group related to specified composite feature
 118    *  \param[in]  theSketch  sketch to be found
 119    *  \return Pointer to corresponding group or NULL if the group cannot be created.
 120    */
 121   SketchGroupPtr findGroup(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
 122
 123   /// \brief Stop sending the Update event until all features updated
 124   /// \return \c true, if the last flushed event is Update
 125   bool stopSendUpdate() const;
 126   /// \brief Allow to send the Update event
 127   void allowSendUpdate() const;
 128
 129   /// \brief Allow send events about changing features in groups
 130   void releaseFeaturesIfEventsBlocked() const;
 131
 132 private:
 133   std::list<SketchGroupPtr> myGroups; ///< Groups of constraints
 134   /// true if computation is performed and all "updates" are generated by this algo
 135   /// and needs no recomputation
 136   bool myIsComputed;
 137 };
 138
 139 #endif