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>
35 typedef std::map<ConstraintPtr, SolverConstraintPtr> ConstraintConstraintMap;
37 /** \class SketchSolver_Group
39 * \brief Keeps the group of constraints which placed in the same sketch
41 class SketchSolver_Group
44 /** \brief New group based on specified workplane.
45 * Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
46 * \remark Type of theSketch is not verified inside
48 SketchSolver_Group(const CompositeFeaturePtr& theWorkplane);
50 virtual ~SketchSolver_Group();
52 /// \brief Returns true if the group has no constraints yet
53 inline bool isEmpty() const
55 return myConstraints.empty() && myTempConstraints.empty();
58 /// \brief Check for valid sketch data
59 inline bool isWorkplaneValid() const
61 return mySketch->data() && mySketch->data()->isValid();
64 /** \brief Adds or updates a constraint in the group
65 * \param[in] theConstraint constraint to be changed
66 * \return \c true if the constraint added or updated successfully
68 bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
70 /** \brief Updates the data corresponding the specified feature
71 * \param[in] theFeature the feature to be updated
73 bool updateFeature(FeaturePtr theFeature);
75 /** \brief Updates the data corresponding the specified feature moved in GUI.
76 * Special kind of Fixed constraints is created.
77 * \param[in] theFeature the feature to be updated
78 * \param[in] theFrom start point of the movement
79 * \param[in] theTo final point of the movement
80 * \return \c true, if the feature is really moved
82 bool moveFeature(FeaturePtr theFeature,
83 const std::shared_ptr<GeomAPI_Pnt2d>& theFrom,
84 const std::shared_ptr<GeomAPI_Pnt2d>& theTo);
85 /** \brief Updates the data corresponding the specified point moved in GUI.
86 * Special kind of Fixed constraints is created.
87 * \param[in] thePoint the attribute to be updated
88 * \param[in] theFrom start point of the movement
89 * \param[in] theTo final point of the movement
90 * \return \c true, if the attribute is really moved
92 bool movePoint(AttributePtr thePoint,
93 const std::shared_ptr<GeomAPI_Pnt2d>& theFrom,
94 const std::shared_ptr<GeomAPI_Pnt2d>& theTo);
96 /// Returns the current workplane
97 inline const CompositeFeaturePtr& getWorkplane() const
102 /** \brief Searches invalid features and constraints in the group and removes them
103 * \return \c false if the group several constraints were removed
105 void repairConsistency();
107 /** \brief Start solution procedure if necessary and update attributes of features
108 * \return \c false when no need to solve constraints
110 bool resolveConstraints();
112 /// \brief Block or unblock events sent by features in this group
113 void blockEvents(bool isBlocked);
116 /// \biref Verify constraints have not been removed
117 bool areConstraintsValid() const;
119 /** \brief Removes constraints from the group
120 * \param[in] theConstraint constraint to be removed
122 void removeConstraint(ConstraintPtr theConstraint);
124 /// \brief Remove all temporary constraints after the computation finished
125 void removeTemporaryConstraints();
127 /// \brief Append given constraint to the group of temporary constraints
128 void setTemporary(SolverConstraintPtr theConstraint);
130 /// \brief Compute DoF of the sketch and set corresponding field
134 CompositeFeaturePtr mySketch; ///< Sketch for this group
135 ConstraintConstraintMap myConstraints; ///< List of constraints
136 std::set<SolverConstraintPtr> myTempConstraints; ///< List of temporary constraints
138 StoragePtr myStorage; ///< Container for the set of SolveSpace constraints and their entities
139 SolverPtr mySketchSolver; ///< Solver for set of equations obtained by constraints
141 /// Result of previous solution of the set of constraints
142 PlaneGCSSolver_Solver::SolveStatus myPrevResult;
143 std::set<ObjectPtr> myConflictingConstraints; ///< List of conflicting constraints
145 int myDOF; ///< degrees of freedom of the current sketch
147 bool myIsEventsBlocked; ///< shows the events are blocked for this group
149 int myMultiConstraintUpdateStack; ///< depth of the stack updating "Multi" constraints
152 typedef std::shared_ptr<SketchSolver_Group> SketchGroupPtr;