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