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 SketchPlugin_ConstraintAngle_H_
21 #define SketchPlugin_ConstraintAngle_H_
23 #include "SketchPlugin.h"
24 #include <SketchPlugin_Sketch.h>
25 #include "SketchPlugin_ConstraintBase.h"
27 /** \class SketchPlugin_ConstraintAngle
29 * \brief Feature for creation of a new constraint fix angle between two lines
31 * This constraint has two attributes:
32 * SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
34 class SketchPlugin_ConstraintAngle : public SketchPlugin_ConstraintBase
37 /// Angle constraint kind
38 inline static const std::string& ID()
40 static const std::string MY_CONSTRAINT_ANGLE_ID("SketchConstraintAngle");
41 return MY_CONSTRAINT_ANGLE_ID;
43 /// \brief Returns the kind of a feature
44 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
46 static std::string MY_KIND = SketchPlugin_ConstraintAngle::ID();
50 /// attribute name of operation type
51 inline static const std::string& TYPE_ID()
53 static const std::string MY_TYPE_ID("AngleType");
56 /// attribute name of previous value of operation type
57 inline static const std::string& PREV_TYPE_ID()
59 static const std::string MY_TYPE_ID("AngleTypePrevious");
63 /// attribute name of operation type
64 inline static const std::string& ANGLE_VALUE_ID()
66 static const std::string MY_ANGLE_VALUE_ID("AngleValue");
67 return MY_ANGLE_VALUE_ID;
70 /// attribute name indicating the first line is reversed
71 inline static const std::string& ANGLE_REVERSED_FIRST_LINE_ID()
73 static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine1");
74 return MY_ANGLE_REVERSED_ID;
76 /// attribute name indicating the second line is reversed
77 inline static const std::string& ANGLE_REVERSED_SECOND_LINE_ID()
79 static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine2");
80 return MY_ANGLE_REVERSED_ID;
83 /// attribute name of dimension location type
84 inline static const std::string& LOCATION_TYPE_ID()
86 static const std::string MY_LOCATION_TYPE_ID("LocationType");
87 return MY_LOCATION_TYPE_ID;
90 /// attribute name indicating the first point selected
91 inline static const std::string& SELECTED_FIRST_POINT_ID()
93 static const std::string MY_SELECTED_FIRST_POINT_ID("SelectedPointA");
94 return MY_SELECTED_FIRST_POINT_ID;
97 /// attribute name indicating the second point selected
98 inline static const std::string& SELECTED_SECOND_POINT_ID()
100 static const std::string MY_SELECTED_SECOND_POINT_ID("SelectedPointB");
101 return MY_SELECTED_SECOND_POINT_ID;
105 static const int THE_VERSION_0 = 0;
106 static const int THE_VERSION_1 = 20191210;
108 /// Attribute name of the version of Angle feature
109 inline static const std::string& VERSION_ID()
111 static const std::string MY_VERSION_ID("version");
112 return MY_VERSION_ID;
116 /// \brief Creates a new part document if needed
117 SKETCHPLUGIN_EXPORT virtual void execute();
119 /// Computes the attribute value on the base of other attributes if the value can be computed
120 /// \param theAttributeId an attribute index to be computed
121 /// \return a boolean value about it is computed
122 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
124 /// \brief Request for initialization of data model of the feature: adding all attributes
125 SKETCHPLUGIN_EXPORT virtual void initAttributes();
127 /// Retuns the parameters of color definition in the resources config manager
128 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
129 std::string& theDefault);
131 /// Called on change of any argument-attribute of this object
132 /// \param theID identifier of changed attribute
133 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
135 /// Returns the AIS preview
136 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
138 /// \brief Use plugin manager for features creation
139 SketchPlugin_ConstraintAngle();
142 /// Calculate current value of the angle
143 void calculateAngle();
145 /// Compute the position of the angle presentation (the quarter selected by the user)
146 void calculateAnglePosition();
148 /// Converts the angle value according to the current angle type and sketch plane normal.
149 /// The in/out angle is in degree.
150 /// \param theAngle a source for the calculated angle
151 /// \param a double angle value
152 double getAngleForType(double theAngle, bool isReversed1 = false, bool isReversed2 = false);
154 /// Update value of ANGLE_VALUE attribute according to the current type
155 void updateAngleValue();
157 /// Update parameters of the Angle to meet requirements for the latest version
158 void updateVersion();
161 bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point