1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SketchSolver_Manager_H_
22 #define SketchSolver_Manager_H_
24 #include <SketchSolver_Group.h>
26 #include <Events_Listener.h>
27 #include <SketchPlugin_Constraint.h>
32 /** \class SketchSolver_Manager
34 * \brief Listens the changes of SketchPlugin features and transforms the Constraint
35 * feature into the format understandable by sketch solver.
37 * \remark This is a singleton.
39 class SketchSolver_Manager : public Events_Listener
42 /** \brief Main method to create constraint manager
43 * \return pointer to the singleton
45 static SketchSolver_Manager* instance();
47 /** \brief Implementation of Event Listener method
48 * \param[in] theMessage the data of the event
50 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
53 * The solver needs all the updated objects are transfered in one group, not one by one.
54 * This iscreases performance and avoids problems in resolve of only part of the made updates.
56 virtual bool groupMessages();
59 SketchSolver_Manager();
60 ~SketchSolver_Manager();
62 /** \brief Adds or updates a constraint or an entity in the suitable group
63 * \param[in] theFeature sketch feature to be changed
64 * \param[in] theMoved \c true if the feature has been moved in the viewer
65 * \return \c true if the feature changed successfully
67 bool updateFeature(std::shared_ptr<SketchPlugin_Feature> theFeature, bool theMoved = false);
69 /** \brief Removes a constraint from the manager
70 * \param[in] theConstraint constraint to be removed
71 * \return \c true if the constraint removed successfully
73 bool removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
75 /** \brief Goes through the list of groups and solve the constraints
76 * \return \c true, if groups are resolved, and features should be updated
77 * (send the Update event)
79 bool resolveConstraints();
82 /** \brief Searches group which interact with specified feature
83 * \param[in] theFeature object to be found
84 * \return Pointer to corresponding group or NULL if the group cannot be created.
86 SketchGroupPtr findGroup(std::shared_ptr<SketchPlugin_Feature> theFeature);
88 /// \brief Stop sending the Update event until all features updated
89 /// \return \c true, if the last flushed event is Update
90 bool stopSendUpdate() const;
91 /// \brief Allow to send the Update event
92 void allowSendUpdate() const;
94 /// \brief Allow send events about changing features in groups
95 void releaseFeaturesIfEventsBlocked() const;
98 std::list<SketchGroupPtr> myGroups; ///< Groups of constraints
99 /// true if computation is performed and all "updates" are generated by this algo
100 /// and needs no recomputation