1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketchSolver_Manager.h
4 // Created: 08 May 2014
5 // Author: Artem ZHIDKOV
7 #ifndef SketchSolver_Manager_H_
8 #define SketchSolver_Manager_H_
10 #include "SketchSolver.h"
11 #include <SketchSolver_Group.h>
13 #include <Events_Listener.h>
14 #include <SketchPlugin_Constraint.h>
19 /** \class SketchSolver_Manager
21 * \brief Listens the changes of SketchPlugin features and transforms the Constraint
22 * feature into the format understandable by sketch solver.
24 * \remark This is a singleton.
26 class SketchSolver_Manager : public Events_Listener
29 /** \brief Main method to create constraint manager
30 * \return pointer to the singleton
32 static SketchSolver_Manager* instance();
34 /** \brief Implementation of Event Listener method
35 * \param[in] theMessage the data of the event
37 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
40 * The solver needs all the updated objects are transfered in one group, not one by one.
41 * This iscreases performance and avoids problems in resolve of only part of the made updates.
43 virtual bool groupMessages();
46 SketchSolver_Manager();
47 ~SketchSolver_Manager();
49 /** \brief Adds or updates a constraint or an entity in the suitable group
50 * \param[in] theFeature sketch feature to be changed
51 * \param[in] theMoved \c true if the feature has been moved in the viewer
52 * \return \c true if the feature changed successfully
54 bool updateFeature(std::shared_ptr<SketchPlugin_Feature> theFeature, bool theMoved = false);
56 /** \brief Removes a constraint from the manager
57 * \param[in] theConstraint constraint to be removed
58 * \return \c true if the constraint removed successfully
60 bool removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
62 /** \brief Goes through the list of groups and solve the constraints
63 * \return \c true, if groups are resolved, and features should be updated
64 * (send the Update event)
66 bool resolveConstraints();
69 /** \brief Searches group which interact with specified feature
70 * \param[in] theFeature object to be found
71 * \return Pointer to corresponding group or NULL if the group cannot be created.
73 SketchGroupPtr findGroup(std::shared_ptr<SketchPlugin_Feature> theFeature);
75 /// \brief Stop sending the Update event until all features updated
76 /// \return \c true, if the last flushed event is Update
77 bool stopSendUpdate() const;
78 /// \brief Allow to send the Update event
79 void allowSendUpdate() const;
82 std::list<SketchGroupPtr> myGroups; ///< Groups of constraints
83 /// true if computation is performed and all "updates" are generated by this algo
84 /// and needs no recomputation