1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
20 #ifndef SketchSolver_Group_H_
21 #define SketchSolver_Group_H_
23 #include <SketchSolver_Constraint.h>
24 #include <SketchSolver_Storage.h>
26 #include <PlaneGCSSolver_Solver.h>
28 #include <SketchPlugin_Constraint.h>
37 typedef std::map<ConstraintPtr, SolverConstraintPtr> ConstraintConstraintMap;
39 /** \class SketchSolver_Group
41 * \brief Keeps the group of constraints which placed in the same sketch
43 class SketchSolver_Group
46 /** \brief New group based on specified workplane.
47 * Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
48 * \remark Type of theSketch is not verified inside
50 SketchSolver_Group(const CompositeFeaturePtr& theWorkplane);
52 virtual ~SketchSolver_Group();
54 /// \brief Returns true if the group has no constraints yet
55 inline bool isEmpty() const
57 return myConstraints.empty() && myTempConstraints.empty();
60 /// \brief Check for valid sketch data
61 inline bool isWorkplaneValid() const
63 return mySketch->data() && mySketch->data()->isValid();
66 /** \brief Adds or updates a constraint in the group
67 * \param[in] theConstraint constraint to be changed
68 * \return \c true if the constraint added or updated successfully
70 bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
72 /** \brief Updates the sketch feature
74 bool updateSketch(CompositeFeaturePtr theSketch);
76 /** \brief Updates the data corresponding the specified feature
77 * \param[in] theFeature the feature to be updated
79 bool updateFeature(FeaturePtr theFeature);
81 /** \brief Updates the data corresponding the specified feature moved in GUI.
82 * Special kind of Fixed constraints is created.
83 * \param[in] theFeature the feature to be updated
84 * \param[in] theFrom start point of the movement
85 * \param[in] theTo final point of the movement
86 * \return \c true, if the feature is really moved
88 bool moveFeature(FeaturePtr theFeature,
89 const std::shared_ptr<GeomAPI_Pnt2d>& theFrom,
90 const std::shared_ptr<GeomAPI_Pnt2d>& theTo);
91 /** \brief Updates the data corresponding the specified point moved in GUI.
92 * Special kind of Fixed constraints is created.
93 * \param[in] thePoint the attribute to be updated
94 * \param[in] theFrom start point of the movement
95 * \param[in] theTo final point of the movement
96 * \return \c true, if the attribute is really moved
98 bool movePoint(AttributePtr thePoint,
99 const std::shared_ptr<GeomAPI_Pnt2d>& theFrom,
100 const std::shared_ptr<GeomAPI_Pnt2d>& theTo);
102 /// Returns the current workplane
103 inline const CompositeFeaturePtr& getWorkplane() const
108 /** \brief Searches invalid features and constraints in the group and removes them
109 * \return \c false if the group several constraints were removed
111 void repairConsistency();
113 /** \brief Start solution procedure if necessary and update attributes of features
114 * \return \c false when no need to solve constraints
116 bool resolveConstraints();
118 /// \brief Block or unblock events sent by features in this group
119 void blockEvents(bool isBlocked);
122 /// \biref Verify constraints have not been removed
123 bool areConstraintsValid() const;
125 /** \brief Removes constraints from the group
126 * \param[in] theConstraint constraint to be removed
128 void removeConstraint(ConstraintPtr theConstraint);
130 /// \brief Remove all temporary constraints after the computation finished
131 void removeTemporaryConstraints();
133 /// \brief Append given constraint to the group of temporary constraints
134 void setTemporary(SolverConstraintPtr theConstraint);
136 /// \brief Compute DoF of the sketch and set corresponding field
140 CompositeFeaturePtr mySketch; ///< Sketch for this group
141 std::shared_ptr<GeomAPI_Pnt> mySketchOrigin;
142 std::shared_ptr<GeomAPI_Dir> mySketchNormal;
143 std::shared_ptr<GeomAPI_Dir> mySketchXDir;
145 ConstraintConstraintMap myConstraints; ///< List of constraints
146 std::set<SolverConstraintPtr> myTempConstraints; ///< List of temporary constraints
148 StoragePtr myStorage; ///< Container for the set of SolveSpace constraints and their entities
149 SolverPtr mySketchSolver; ///< Solver for set of equations obtained by constraints
151 /// Result of previous solution of the set of constraints
152 PlaneGCSSolver_Solver::SolveStatus myPrevResult;
153 std::set<ObjectPtr> myConflictingConstraints; ///< List of conflicting constraints
155 int myDOF; ///< degrees of freedom of the current sketch
157 bool myIsEventsBlocked; ///< shows the events are blocked for this group
159 int myMultiConstraintUpdateStack; ///< depth of the stack updating "Multi" constraints
162 typedef std::shared_ptr<SketchSolver_Group> SketchGroupPtr;