src/SketchPlugin/SketchPlugin_ConstraintRadius.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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_ConstraintRadius_H_
  21 #define SketchPlugin_ConstraintRadius_H_
  22
  23 #include "SketchPlugin.h"
  24 #include <SketchPlugin_Sketch.h>
  25 #include "SketchPlugin_ConstraintBase.h"
  26
  27 /** \class SketchPlugin_ConstraintRadius
  28  *  \ingroup Plugins
  29  *  \brief Feature for creation of a new constraint which defines
  30  *         a radius of a circle or an arc of circle
  31  *
  32  *  This constraint has two attributes:
  33  *  SketchPlugin_Constraint::VALUE() (radius), SketchPlugin_Constraint::ENTITY_A() (a circle)
  34  */
  35 class SketchPlugin_ConstraintRadius : public SketchPlugin_ConstraintBase
  36 {
  37  public:
  38   /// Radius constraint kind
  39   inline static const std::string& ID()
  40   {
  41     static const std::string MY_CONSTRAINT_RADIUS_ID("SketchConstraintRadius");
  42     return MY_CONSTRAINT_RADIUS_ID;
  43   }
  44   /// \brief Returns the kind of a feature
  45   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  46   {
  47     static std::string MY_KIND = SketchPlugin_ConstraintRadius::ID();
  48     return MY_KIND;
  49   }
  50
  51   /// attribute name of dimension location type
  52   inline static const std::string& LOCATION_TYPE_ID()
  53   {
  54     static const std::string MY_LOCATION_TYPE_ID("LocationType");
  55     return MY_LOCATION_TYPE_ID;
  56   }
  57
  58   /// \brief Creates a new part document if needed
  59   SKETCHPLUGIN_EXPORT virtual void execute();
  60
  61   /// Computes the attribute value on the base of other attributes if the value can be computed
  62   /// \param theAttributeId an attribute index to be computed
  63   /// \return a boolean value about it is computed
  64   SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
  65
  66   /// \brief Request for initialization of data model of the feature: adding all attributes
  67   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  68
  69   /// Retuns the parameters of color definition in the resources config manager
  70   SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  71                                                    std::string& theDefault);
  72
  73   /// Returns the AIS preview
  74   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  75
  76   /// Called on change of any argument-attribute of this object
  77   /// \param theID identifier of changed attribute
  78   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  79
  80   /// \brief Use plugin manager for features creation
  81   SketchPlugin_ConstraintRadius();
  82
  83 private:
  84   /// Checks and gets the radius of referenced circle (or arc) otherwise returns -1.
  85   /// \param theCircData the found referenced circle returned by this method
  86   double circleRadius(std::shared_ptr<ModelAPI_Feature>& theCirc);
  87
  88 private:
  89   bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point
  90 };
  91
  92 #endif