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_Group_H_
22 #define SketchSolver_Group_H_
24 #include <SketchSolver_Constraint.h>
25 #include <SketchSolver_Storage.h>
27 #include <PlaneGCSSolver_Solver.h>
29 #include <SketchPlugin_Constraint.h>
34 typedef std::map<ConstraintPtr, SolverConstraintPtr> ConstraintConstraintMap;
36 /** \class SketchSolver_Group
38 * \brief Keeps the group of constraints which placed in the same sketch
40 class SketchSolver_Group
43 /** \brief New group based on specified workplane.
44 * Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
45 * \remark Type of theSketch is not verified inside
47 SketchSolver_Group(const CompositeFeaturePtr& theWorkplane);
49 virtual ~SketchSolver_Group();
51 /// \brief Returns true if the group has no constraints yet
52 inline bool isEmpty() const
54 return myConstraints.empty() && myTempConstraints.empty();
57 /// \brief Check for valid sketch data
58 inline bool isWorkplaneValid() const
60 return mySketch->data() && mySketch->data()->isValid();
63 /** \brief Adds or updates a constraint in the group
64 * \param[in] theConstraint constraint to be changed
65 * \return \c true if the constraint added or updated successfully
67 bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
69 /** \brief Updates the data corresponding the specified feature
70 * \param[in] theFeature the feature to be updated
72 bool updateFeature(FeaturePtr theFeature);
74 /** \brief Updates the data corresponding the specified feature moved in GUI.
75 * Additional Fixed constraints are created.
76 * \param[in] theFeature the feature to be updated
77 * \return \c true, if the feature is moved
79 bool moveFeature(FeaturePtr theFeature);
81 /// Returns the current workplane
82 inline const CompositeFeaturePtr& getWorkplane() const
87 /** \brief Searches invalid features and constraints in the group and removes them
88 * \return \c false if the group several constraints were removed
90 void repairConsistency();
92 /** \brief Start solution procedure if necessary and update attributes of features
93 * \return \c false when no need to solve constraints
95 bool resolveConstraints();
97 /// \brief Block or unblock events sent by features in this group
98 void blockEvents(bool isBlocked);
101 /// \biref Verify constraints have not been removed
102 bool areConstraintsValid() const;
104 /** \brief Removes constraints from the group
105 * \param[in] theConstraint constraint to be removed
107 void removeConstraint(ConstraintPtr theConstraint);
109 /// \brief Remove all temporary constraints after the computation finished
110 void removeTemporaryConstraints();
112 /// \brief Append given constraint to the group of temporary constraints
113 void setTemporary(SolverConstraintPtr theConstraint);
115 /// \brief Compute DoF of the sketch and set corresponding field
119 CompositeFeaturePtr mySketch; ///< Sketch for this group
120 ConstraintConstraintMap myConstraints; ///< List of constraints
121 std::set<SolverConstraintPtr> myTempConstraints; ///< List of temporary constraints
123 StoragePtr myStorage; ///< Container for the set of SolveSpace constraints and their entities
124 SolverPtr mySketchSolver; ///< Solver for set of equations obtained by constraints
126 /// Result of previous solution of the set of constraints
127 PlaneGCSSolver_Solver::SolveStatus myPrevResult;
128 std::set<ObjectPtr> myConflictingConstraints; ///< List of conflicting constraints
130 int myDOF; ///< degrees of freedom of the current sketch
132 bool myIsEventsBlocked; ///< shows the events are blocked for this group
134 int myMultiConstraintUpdateStack; ///< depth of the stack updating "Multi" constraints
137 typedef std::shared_ptr<SketchSolver_Group> SketchGroupPtr;