1 // Copyright (C) 2014-2020 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 PlaneGCSSolver_Tools_H_
21 #define PlaneGCSSolver_Tools_H_
23 #include <SketchSolver_Constraint.h>
24 #include <SketchSolver_ConstraintMovement.h>
25 #include <SketchPlugin_Constraint.h>
27 class GeomAPI_BSpline2d;
29 class GeomAPI_Ellipse2d;
33 class ModelAPI_AttributeDoubleArray;
34 class ModelAPI_AttributeIntArray;
36 /** \namespace PlaneGCSSolver_Tools
38 * \brief Converter tools
40 namespace PlaneGCSSolver_Tools
42 /// \brief Creates a solver's constraint using given SketchPlugin constraint
43 /// or returns empty pointer if not all attributes are correct
44 SolverConstraintPtr createConstraint(ConstraintPtr theConstraint);
46 /// \brief Creates temporary constraint to fix the feature after movement
47 std::shared_ptr<SketchSolver_ConstraintMovement>
48 createMovementConstraint(FeaturePtr theMovedFeature);
49 /// \brief Creates temporary constraint to fix the attribute after movement
50 std::shared_ptr<SketchSolver_ConstraintMovement>
51 createMovementConstraint(AttributePtr theMovedAttribute);
52 /// \brief Creates temporary constraint to fix the point in array after movement
53 std::shared_ptr<SketchSolver_ConstraintMovement>
54 createMovementConstraint(const std::pair<AttributePtr, int>& theMovedPointInArray);
56 /// \brief Creates new constraint using given parameters
57 /// \param theConstraint [in] original constraint
58 /// \param theType [in] type of constraint
59 /// \param theValue [in] numeric characteristic of constraint
60 /// (e.g. distance or radius) if applicable
61 /// \param theEntity1 [in] first attribute of constraint
62 /// \param theEntity2 [in] second attribute of constraint
63 /// \param theEntity3 [in] third attribute of constraint
64 /// \param theEntity4 [in] fourth attribute of constraint
65 /// \return Created wrapper of constraints applicable for specific solver.
66 ConstraintWrapperPtr createConstraint(ConstraintPtr theConstraint,
67 const SketchSolver_ConstraintType& theType,
68 const EntityWrapperPtr& theValue,
69 const EntityWrapperPtr& theEntity1,
70 const EntityWrapperPtr& theEntity2 = EntityWrapperPtr(),
71 const EntityWrapperPtr& theEntity3 = EntityWrapperPtr(),
72 const EntityWrapperPtr& theEntity4 = EntityWrapperPtr());
74 /// \brief Return \c true if the attribute is used in PlaneGCS solver
75 /// \param[in] theAttrName name of the attribute
76 /// \param[in] theOwnerName name of the parent feature
77 bool isAttributeApplicable(const std::string& theAttrName,
78 const std::string& theOwnerName);
80 /// \brief Convert entity to point
81 /// \return empty pointer if the entity is not a point
82 std::shared_ptr<GeomAPI_Pnt2d> point(EntityWrapperPtr theEntity);
83 /// \brief Convert entity to line
84 /// \return empty pointer if the entity is not a line
85 std::shared_ptr<GeomAPI_Lin2d> line(EntityWrapperPtr theEntity);
86 /// \brief Convert entity to circle
87 /// \return empty pointer if the entity is not a circle
88 std::shared_ptr<GeomAPI_Circ2d> circle(EntityWrapperPtr theEntity);
89 /// \brief Convert entity to ellipse
90 /// \return empty pointer if the entity is not an ellipse
91 std::shared_ptr<GeomAPI_Ellipse2d> ellipse(EntityWrapperPtr theEntity);
92 /// \brief Convert entity to Bs-pline
93 /// \return empty pointer if the entity is not an ellipse
94 std::shared_ptr<GeomAPI_BSpline2d> bspline(EntityWrapperPtr theEntity);
96 /// \brief Convert entity to line
97 /// \return empty pointer if the entity is not a line
98 std::shared_ptr<GeomAPI_Lin2d> line(FeaturePtr theFeature);
100 /// \brief Update start and end parameters of circular and elliptic arcs
101 /// respectively to start and end points on the arc.
102 /// For the circular arc, the radius is calculated too.
103 void recalculateArcParameters(EntityWrapperPtr theArc);
105 /// brief Return list of parameters for the given entity
106 GCS::SET_pD parameters(const EntityWrapperPtr& theEntity);
108 /// \brief Update value in theDest if theSource is differ more than theTolerance
109 /// \return \c true if the value was updated.
110 bool updateValue(const double& theSource, double& theDest,
111 const double theTolerance = 1.e4 * tolerance);
113 double distance(const GCS::Point& thePnt1, const GCS::Point& thePnt2);
115 /// \brief Provide an interface to access values in attribute which is an array of values
119 AttributeArray(AttributePtr theAttribute);
121 bool isInitialized() const;
125 double value(const int theIndex) const;
128 std::shared_ptr<ModelAPI_AttributeDoubleArray> myDouble;
129 std::shared_ptr<ModelAPI_AttributeIntArray> myInteger;