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 PlaneGCSSolver_Tools_H_
21 #define PlaneGCSSolver_Tools_H_
23 #include <SketchSolver_Constraint.h>
24 #include <SketchSolver_ConstraintMovement.h>
25 #include <SketchPlugin_Constraint.h>
27 #include <GeomAPI_Lin2d.h>
28 #include <GeomAPI_Pnt2d.h>
30 /** \namespace PlaneGCSSolver_Tools
32 * \brief Converter tools
34 namespace PlaneGCSSolver_Tools
36 /// \brief Creates a solver's constraint using given SketchPlugin constraint
37 /// or returns empty pointer if not all attributes are correct
38 SolverConstraintPtr createConstraint(ConstraintPtr theConstraint);
40 /// \brief Creates temporary constraint to fix the feature after movement
41 std::shared_ptr<SketchSolver_ConstraintMovement>
42 createMovementConstraint(FeaturePtr theMovedFeature);
43 /// \brief Creates temporary constraint to fix the attribute after movement
44 std::shared_ptr<SketchSolver_ConstraintMovement>
45 createMovementConstraint(AttributePtr theMovedAttribute);
47 /// \brief Creates new constraint using given parameters
48 /// \param theConstraint [in] original constraint
49 /// \param theType [in] type of constraint
50 /// \param theValue [in] numeric characteristic of constraint
51 /// (e.g. distance or radius) if applicable
52 /// \param theEntity1 [in] first attribute of constraint
53 /// \param theEntity2 [in] second attribute of constraint
54 /// \param theEntity3 [in] third attribute of constraint
55 /// \param theEntity4 [in] fourth attribute of constraint
56 /// \return Created wrapper of constraints applicable for specific solver.
57 ConstraintWrapperPtr createConstraint(ConstraintPtr theConstraint,
58 const SketchSolver_ConstraintType& theType,
59 const EntityWrapperPtr& theValue,
60 const EntityWrapperPtr& theEntity1,
61 const EntityWrapperPtr& theEntity2 = EntityWrapperPtr(),
62 const EntityWrapperPtr& theEntity3 = EntityWrapperPtr(),
63 const EntityWrapperPtr& theEntity4 = EntityWrapperPtr());
65 /// \brief Convert entity to point
66 /// \return empty pointer if the entity is not a point
67 std::shared_ptr<GeomAPI_Pnt2d> point(EntityWrapperPtr theEntity);
68 /// \brief Convert entity to line
69 /// \return empty pointer if the entity is not a line
70 std::shared_ptr<GeomAPI_Lin2d> line(EntityWrapperPtr theEntity);
72 /// \brief Convert entity to line
73 /// \return empty pointer if the entity is not a line
74 std::shared_ptr<GeomAPI_Lin2d> line(FeaturePtr theFeature);
76 /// brief Return list of parameters for the given entity
77 GCS::SET_pD parameters(const EntityWrapperPtr& theEntity);