src/SketchPlugin/SketchPlugin_ConstraintAngle.h

   1 // Copyright (C) 2014-2019  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
  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   /// attribute name of previous value of operation type
  57   inline static const std::string& PREV_TYPE_ID()
  58   {
  59     static const std::string MY_TYPE_ID("AngleTypePrevious");
  60     return MY_TYPE_ID;
  61   }
  62
  63   /// attribute name of operation type
  64   inline static const std::string& ANGLE_VALUE_ID()
  65   {
  66     static const std::string MY_ANGLE_VALUE_ID("AngleValue");
  67     return MY_ANGLE_VALUE_ID;
  68   }
  69
  70   /// attribute name indicating the first line is reversed
  71   inline static const std::string& ANGLE_REVERSED_FIRST_LINE_ID()
  72   {
  73     static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine1");
  74     return MY_ANGLE_REVERSED_ID;
  75   }
  76   /// attribute name indicating the second line is reversed
  77   inline static const std::string& ANGLE_REVERSED_SECOND_LINE_ID()
  78   {
  79     static const std::string MY_ANGLE_REVERSED_ID("AngleReversedLine2");
  80     return MY_ANGLE_REVERSED_ID;
  81   }
  82
  83   /// attribute name of dimension location type
  84   inline static const std::string& LOCATION_TYPE_ID()
  85   {
  86     static const std::string MY_LOCATION_TYPE_ID("LocationType");
  87     return MY_LOCATION_TYPE_ID;
  88   }
  89
  90   /// attribute name indicating the first point selected
  91   inline static const std::string& SELECTED_FIRST_POINT_ID()
  92   {
  93     static const std::string MY_SELECTED_FIRST_POINT_ID("SelectedPointA");
  94     return MY_SELECTED_FIRST_POINT_ID;
  95   }
  96
  97   /// attribute name indicating the second point selected
  98   inline static const std::string& SELECTED_SECOND_POINT_ID()
  99   {
 100     static const std::string MY_SELECTED_SECOND_POINT_ID("SelectedPointB");
 101     return MY_SELECTED_SECOND_POINT_ID;
 102   }
 103
 104   /// \brief Creates a new part document if needed
 105   SKETCHPLUGIN_EXPORT virtual void execute();
 106
 107   /// Computes the attribute value on the base of other attributes if the value can be computed
 108   /// \param theAttributeId an attribute index to be computed
 109   /// \return a boolean value about it is computed
 110   SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
 111
 112   /// \brief Request for initialization of data model of the feature: adding all attributes
 113   SKETCHPLUGIN_EXPORT virtual void initAttributes();
 114
 115   /// Retuns the parameters of color definition in the resources config manager
 116   SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
 117                                                    std::string& theDefault);
 118
 119   /// Called on change of any argument-attribute of this object
 120   /// \param theID identifier of changed attribute
 121   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 122
 123   /// Returns the AIS preview
 124   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
 125
 126   /// \brief Use plugin manager for features creation
 127   SketchPlugin_ConstraintAngle();
 128
 129 protected:
 130   /// Calculate current value of the angle
 131   void calculateAngle();
 132
 133   /// Compute the position of the angle presentation (the quarter selected by the user)
 134   void calculateAnglePosition();
 135
 136   /// Converts the angle value according to the current angle type and sketch plane normal.
 137   /// The in/out angle is in degree.
 138   /// \param theAngle a source for the calculated angle
 139   /// \param a double angle value
 140   double getAngleForType(double theAngle, bool isReversed1 = false, bool isReversed2 = false);
 141
 142   /// Update value of ANGLE_VALUE attribute according to the current type
 143   void updateAngleValue();
 144
 145 private:
 146   bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
 147 };
 148
 149 #endif