]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintAngle.h
Salome HOME
Add SketchPlugin document template.
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintAngle.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_ConstraintAngle_H_
22 #define SketchPlugin_ConstraintAngle_H_
23
24 #include "SketchPlugin.h"
25 #include <SketchPlugin_Sketch.h>
26 #include "SketchPlugin_ConstraintBase.h"
27
28 /** \class SketchPlugin_ConstraintAngle
29  *  \ingroup Plugins
30  *  \brief Feature for creation of a new constraint fix angle between two lines
31  *
32  *  This constraint has two attributes:
33  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
34  */
35 class SketchPlugin_ConstraintAngle : public SketchPlugin_ConstraintBase
36 {
37  public:
38   /// Angle constraint kind
39   inline static const std::string& ID()
40   {
41     static const std::string MY_CONSTRAINT_ANGLE_ID("SketchConstraintAngle");
42     return MY_CONSTRAINT_ANGLE_ID;
43   }
44   /// \brief Returns the kind of a feature
45   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
46   {
47     static std::string MY_KIND = SketchPlugin_ConstraintAngle::ID();
48     return MY_KIND;
49   }
50
51   /// attribute name of operation type
52   inline static const std::string& TYPE_ID()
53   {
54     static const std::string MY_TYPE_ID("AngleType");
55     return MY_TYPE_ID;
56   }
57
58   /// attribute name of operation type
59   inline static const std::string& ANGLE_VALUE_ID()
60   {
61     static const std::string MY_ANGLE_VALUE_ID("AngleValue");
62     return MY_ANGLE_VALUE_ID;
63   }
64
65   /// attribute name indicating the first line is reversed
66   inline static const std::string& ANGLE_REVERSED_FIRST_LINE_ID()
67   {
68     static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine1");
69     return MY_ANGLE_REVERSED_ID;
70   }
71   /// attribute name indicating the second line is reversed
72   inline static const std::string& ANGLE_REVERSED_SECOND_LINE_ID()
73   {
74     static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine2");
75     return MY_ANGLE_REVERSED_ID;
76   }
77
78   /// attribute name of dimension location type
79   inline static const std::string& LOCATION_TYPE_ID()
80   {
81     static const std::string MY_LOCATION_TYPE_ID("LocationType");
82     return MY_LOCATION_TYPE_ID;
83   }
84
85
86   /// \brief Creates a new part document if needed
87   SKETCHPLUGIN_EXPORT virtual void execute();
88
89   /// Computes the attribute value on the base of other attributes if the value can be computed
90   /// \param theAttributeId an attribute index to be computed
91   /// \return a boolean value about it is computed
92   SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
93
94   /// \brief Request for initialization of data model of the feature: adding all attributes
95   SKETCHPLUGIN_EXPORT virtual void initAttributes();
96
97   /// Retuns the parameters of color definition in the resources config manager
98   SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
99                                                    std::string& theDefault);
100
101   /// Called on change of any argument-attribute of this object
102   /// \param theID identifier of changed attribute
103   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
104
105   /// Returns the AIS preview
106   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
107
108   /// Calculate current value of the angle
109   double calculateAngle();
110
111   /// Converts the angle value according to the current angle type and sketch plane normal.
112   /// The in/out angle is in degree.
113   /// \param theAngle a source for the calculated angle
114   /// \param isPreviousValueObtuse a flag if obtuse should be processed
115   /// \param a double angle value
116   double getAngleForType(double theAngle, bool isPreviousValueObtuse = false);
117
118   /// Update value of VALUE attribute by the combination of the current angle type and angle value
119   void updateConstraintValueByAngleValue();
120
121   /// \brief Use plugin manager for features creation
122   SketchPlugin_ConstraintAngle();
123
124 private:
125   bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
126 };
127
128 #endif