1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SketchPlugin_ConstraintAngle_H_
22 #define SketchPlugin_ConstraintAngle_H_
24 #include "SketchPlugin.h"
25 #include <SketchPlugin_Sketch.h>
26 #include "SketchPlugin_ConstraintBase.h"
28 /** \class SketchPlugin_ConstraintAngle
30 * \brief Feature for creation of a new constraint fix angle between two lines
32 * This constraint has two attributes:
33 * SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
35 class SketchPlugin_ConstraintAngle : public SketchPlugin_ConstraintBase
38 /// Angle constraint kind
39 inline static const std::string& ID()
41 static const std::string MY_CONSTRAINT_ANGLE_ID("SketchConstraintAngle");
42 return MY_CONSTRAINT_ANGLE_ID;
44 /// \brief Returns the kind of a feature
45 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
47 static std::string MY_KIND = SketchPlugin_ConstraintAngle::ID();
51 /// attribute name of operation type
52 inline static const std::string& TYPE_ID()
54 static const std::string MY_TYPE_ID("AngleType");
58 /// attribute name of operation type
59 inline static const std::string& ANGLE_VALUE_ID()
61 static const std::string MY_ANGLE_VALUE_ID("AngleValue");
62 return MY_ANGLE_VALUE_ID;
65 /// attribute name indicating the first line is reversed
66 inline static const std::string& ANGLE_REVERSED_FIRST_LINE_ID()
68 static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine1");
69 return MY_ANGLE_REVERSED_ID;
71 /// attribute name indicating the second line is reversed
72 inline static const std::string& ANGLE_REVERSED_SECOND_LINE_ID()
74 static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine2");
75 return MY_ANGLE_REVERSED_ID;
78 /// \brief Creates a new part document if needed
79 SKETCHPLUGIN_EXPORT virtual void execute();
81 /// Computes the attribute value on the base of other attributes if the value can be computed
82 /// \param theAttributeId an attribute index to be computed
83 /// \return a boolean value about it is computed
84 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
86 /// \brief Request for initialization of data model of the feature: adding all attributes
87 SKETCHPLUGIN_EXPORT virtual void initAttributes();
89 /// Retuns the parameters of color definition in the resources config manager
90 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
91 std::string& theDefault);
93 /// Called on change of any argument-attribute of this object
94 /// \param theID identifier of changed attribute
95 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
97 /// Returns the AIS preview
98 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
100 /// Moves the feature
101 /// \param theDeltaX the delta for X coordinate is moved
102 /// \param theDeltaY the delta for Y coordinate is moved
103 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
105 /// Calculate current value of the angle
106 double calculateAngle();
108 /// Converts the angle value according to the current angle type and sketch plane normal.
109 /// The in/out angle is in degree.
110 /// \param theAngle a source for the calculated angle
111 /// \param isPreviousValueObtuse a flag if obtuse should be processed
112 /// \param a double angle value
113 double getAngleForType(double theAngle, bool isPreviousValueObtuse = false);
115 /// Update value of VALUE attribute by the combination of the current angle type and angle value
116 void updateConstraintValueByAngleValue();
118 /// \brief Use plugin manager for features creation
119 SketchPlugin_ConstraintAngle();
122 bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point