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");
57 /// attribute name of operation type
58 inline static const std::string& ANGLE_VALUE_ID()
60 static const std::string MY_ANGLE_VALUE_ID("AngleValue");
61 return MY_ANGLE_VALUE_ID;
64 /// attribute name indicating the first line is reversed
65 inline static const std::string& ANGLE_REVERSED_FIRST_LINE_ID()
67 static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine1");
68 return MY_ANGLE_REVERSED_ID;
70 /// attribute name indicating the second line is reversed
71 inline static const std::string& ANGLE_REVERSED_SECOND_LINE_ID()
73 static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine2");
74 return MY_ANGLE_REVERSED_ID;
77 /// attribute name of dimension location type
78 inline static const std::string& LOCATION_TYPE_ID()
80 static const std::string MY_LOCATION_TYPE_ID("LocationType");
81 return MY_LOCATION_TYPE_ID;
85 /// \brief Creates a new part document if needed
86 SKETCHPLUGIN_EXPORT virtual void execute();
88 /// Computes the attribute value on the base of other attributes if the value can be computed
89 /// \param theAttributeId an attribute index to be computed
90 /// \return a boolean value about it is computed
91 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
93 /// \brief Request for initialization of data model of the feature: adding all attributes
94 SKETCHPLUGIN_EXPORT virtual void initAttributes();
96 /// Retuns the parameters of color definition in the resources config manager
97 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
98 std::string& theDefault);
100 /// Called on change of any argument-attribute of this object
101 /// \param theID identifier of changed attribute
102 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
104 /// Returns the AIS preview
105 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
107 /// Calculate current value of the angle
108 double calculateAngle();
110 /// Converts the angle value according to the current angle type and sketch plane normal.
111 /// The in/out angle is in degree.
112 /// \param theAngle a source for the calculated angle
113 /// \param isPreviousValueObtuse a flag if obtuse should be processed
114 /// \param a double angle value
115 double getAngleForType(double theAngle, bool isPreviousValueObtuse = false);
117 /// Update value of VALUE attribute by the combination of the current angle type and angle value
118 void updateConstraintValueByAngleValue();
120 /// \brief Use plugin manager for features creation
121 SketchPlugin_ConstraintAngle();
124 bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point