Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / SketchSolver / SketchSolver_ConstraintMultiTranslation.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef SketchSolver_ConstraintMultiTranslation_H_
22 #define SketchSolver_ConstraintMultiTranslation_H_
23
24 #include <SketchSolver_ConstraintMulti.h>
25
26 #include "GeomDataAPI_Point2D.h"
27
28 /** \class   SketchSolver_ConstraintMultiTranslation
29  *  \ingroup Plugins
30  *  \brief   Convert translated features to the list of SolveSpace constraints
31  */
32 class SketchSolver_ConstraintMultiTranslation : public SketchSolver_ConstraintMulti
33 {
34 public:
35   /// Constructor based on SketchPlugin constraint
36   SketchSolver_ConstraintMultiTranslation(ConstraintPtr theConstraint) :
37       SketchSolver_ConstraintMulti(theConstraint)
38   {}
39
40 protected:
41   /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
42   virtual void process();
43
44   /// \brief Generate list of translated entities
45   /// \param[out] theStartPoint start point of translation
46   /// \param[out] theEndPoint   final point of translation
47   /// \param[out] theFullValue  applying translation using the distance as a full or single value
48   /// \param[out] theEntities   list of base entities
49   void getAttributes(EntityWrapperPtr& theStartPoint, EntityWrapperPtr& theEndPoint,
50                      bool& theFullValue, std::list<EntityWrapperPtr>& theEntities);
51
52   /// \brief This method is used in derived objects to check consistence of constraint.
53   virtual void adjustConstraint();
54
55   /// \brief Update parameters (called from base class)
56   virtual void updateLocal();
57
58 private:
59   /// \brief Convert absolute coordinates to relative coordinates
60   virtual void getRelative(double theAbsX, double theAbsY,
61                            double& theRelX, double& theRelY);
62   /// \brief Convert relative coordinates to absolute coordinates
63   virtual void getAbsolute(double theRelX, double theRelY,
64                            double& theAbsX, double& theAbsY);
65   /// \brief Apply transformation for relative coordinates
66   virtual void transformRelative(double& theX, double& theY);
67
68   /// \brief Returns name of NUMBER_OF_COPIES parameter for corresponding feature
69   virtual const std::string& nameNbObjects();
70
71 private:
72   AttributePoint2DPtr myStartPointAttribute;
73   AttributePoint2DPtr myEndPointAttribute;
74
75   double myDelta[2]; ///< increment of translation
76 };
77
78 #endif