]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintLength.h
Salome HOME
Add SketchPlugin document template.
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintLength.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 SketchPlugin_ConstraintLength_H_
22 #define SketchPlugin_ConstraintLength_H_
23
24 #include "SketchPlugin.h"
25 #include "SketchPlugin_ConstraintBase.h"
26 #include "SketchPlugin_Sketch.h"
27
28 #include <GeomAPI_ICustomPrs.h>
29
30 #include <list>
31
32 class GeomAPI_Pnt2d;
33 class GeomDataAPI_Point2D;
34
35 /** \class SketchPlugin_ConstraintLength
36  *  \ingroup Plugins
37  *  \brief Feature for creation of a new constraint which defines a length of a line segment
38  *
39  *  This constraint has two attributes:
40  *  SketchPlugin_Constraint::VALUE() (length) and SketchPlugin_Constraint::ENTITY_A() (segment),
41  *  SketchPlugin_Constraint::FLYOUT_VALUE_PNT() (distance of a constraints handle)
42  */
43 class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
44 {
45  public:
46   /// Length constraint kind
47   inline static const std::string& ID()
48   {
49     static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength");
50     return MY_CONSTRAINT_LENGTH_ID;
51   }
52
53   /// \brief Returns the kind of a feature
54   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
55   {
56     static std::string MY_KIND = SketchPlugin_ConstraintLength::ID();
57     return MY_KIND;
58   }
59
60   /// attribute name of dimension location type
61   inline static const std::string& LOCATION_TYPE_ID()
62   {
63     static const std::string MY_LOCATION_TYPE_ID("LocationType");
64     return MY_LOCATION_TYPE_ID;
65   }
66
67   /// \brief Creates a new part document if needed
68   SKETCHPLUGIN_EXPORT virtual void execute();
69
70   /// Computes the attribute value on the base of other attributes if the value can be computed
71   /// \param theAttributeId an attribute index to be computed
72   /// \return a boolean value about it is computed
73   SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
74
75   /// \brief Request for initialization of data model of the feature: adding all attributes
76   SKETCHPLUGIN_EXPORT virtual void initAttributes();
77
78   /// Retuns the parameters of color definition in the resources config manager
79   SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
80                                                    std::string& theDefault);
81
82   /// Returns the AIS preview
83   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
84
85   /// Called on change of any argument-attribute of this object
86   /// \param theID identifier of changed attribute
87   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
88
89   /// \brief Use plugin manager for features creation
90   SketchPlugin_ConstraintLength();
91
92   /// Computes distance between lenght point attributes
93   /// \param theValue [out] distance or 0 if one of point attributes is not initialized
94   /// \return boolean value if distance is computed
95   bool computeLenghtValue(double& theValue);
96
97 private:
98   /// retrns the points-base of length, returns false if it is not possible
99   bool getPoints(
100     std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
101     std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,
102     std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint);
103
104 private:
105   bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
106 };
107
108 #endif