src/SketchPlugin/SketchPlugin_MacroCircle.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_MacroCircle_H_
  21 #define SketchPlugin_MacroCircle_H_
  22
  23 #include <ModelAPI_IReentrant.h>
  24
  25 #include "SketchPlugin.h"
  26
  27 #include "SketchPlugin_SketchEntity.h"
  28
  29 #include <GeomAPI_IPresentable.h>
  30
  31 class GeomAPI_Circ2d;
  32 class GeomAPI_Pnt2d;
  33
  34 /**\class SketchPlugin_MacroCircle
  35  * \ingroup Plugins
  36  * \brief Feature for creation of the new circle in Sketch.
  37  */
  38 class SketchPlugin_MacroCircle: public SketchPlugin_SketchEntity,
  39                                 public GeomAPI_IPresentable,
  40                                 public ModelAPI_IReentrant
  41 {
  42  public:
  43   /// Circle feature kind
  44   inline static const std::string& ID()
  45   {
  46     static const std::string ID("SketchMacroCircle");
  47     return ID;
  48   }
  49
  50   inline static const std::string& CIRCLE_TYPE()
  51   {
  52     static const std::string ID("circle_type");
  53     return ID;
  54   }
  55
  56   inline static const std::string& EDIT_CIRCLE_TYPE()
  57   {
  58     static const std::string ID("edit_circle_type");
  59     return ID;
  60   }
  61
  62   /// Creation method by center and passed point.
  63   inline static const std::string& CIRCLE_TYPE_BY_CENTER_AND_PASSED_POINTS()
  64   {
  65     static const std::string ID("circle_type_by_center_and_passed_points");
  66     return ID;
  67   }
  68
  69   /// Creation method by three points.
  70   inline static const std::string& CIRCLE_TYPE_BY_THREE_POINTS()
  71   {
  72     static const std::string ID("circle_type_by_three_points");
  73     return ID;
  74   }
  75
  76   /// 2D point - center of the circle.
  77   inline static const std::string& CENTER_POINT_ID()
  78   {
  79     static const std::string ID("center_point");
  80     return ID;
  81   }
  82
  83   /// Reference for center point selection.
  84   inline static const std::string& CENTER_POINT_REF_ID()
  85   {
  86     static const std::string ID("center_point_ref");
  87     return ID;
  88   }
  89
  90   /// 2D point - passed point of the circle
  91   inline static const std::string& PASSED_POINT_ID()
  92   {
  93     static const std::string ID("passed_point");
  94     return ID;
  95   }
  96
  97   /// Reference for passed point selection.
  98   inline static const std::string& PASSED_POINT_REF_ID()
  99   {
 100     static const std::string ID("passed_point_ref");
 101     return ID;
 102   }
 103
 104   /// First point id.
 105   inline static const std::string& FIRST_POINT_ID()
 106   {
 107     static const std::string ID("first_point");
 108     return ID;
 109   }
 110
 111   /// Reference for first point selection.
 112   inline static const std::string& FIRST_POINT_REF_ID()
 113   {
 114     static const std::string ID("first_point_ref");
 115     return ID;
 116   }
 117
 118   /// Second point id.
 119   inline static const std::string& SECOND_POINT_ID()
 120   {
 121     static const std::string ID("second_point");
 122     return ID;
 123   }
 124
 125   /// Reference for second point selection.
 126   inline static const std::string& SECOND_POINT_REF_ID()
 127   {
 128     static const std::string ID("second_point_ref");
 129     return ID;
 130   }
 131
 132   /// Third point id.
 133   inline static const std::string& THIRD_POINT_ID()
 134   {
 135     static const std::string ID("third_point");
 136     return ID;
 137   }
 138
 139   /// Reference for third point selection.
 140   inline static const std::string& THIRD_POINT_REF_ID()
 141   {
 142     static const std::string ID("third_point_ref");
 143     return ID;
 144   }
 145
 146   /// Radius of the circle
 147   inline static const std::string& CIRCLE_RADIUS_ID()
 148   {
 149     static const std::string ID("circle_radius");
 150     return ID;
 151   }
 152
 153   /// Returns the kind of a feature
 154   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
 155   {
 156     static std::string MY_KIND = SketchPlugin_MacroCircle::ID();
 157     return MY_KIND;
 158   }
 159
 160   /// \brief Request for initialization of data model of the feature: adding all attributes.
 161   SKETCHPLUGIN_EXPORT virtual void initAttributes();
 162
 163   /// Called on change of any argument-attribute of this object
 164   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 165
 166   /// Returns the AIS preview
 167   virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
 168
 169   /// Creates a new part document if needed
 170   SKETCHPLUGIN_EXPORT virtual void execute();
 171
 172   /// Reimplemented from ModelAPI_Feature::isMacro().
 173   /// \returns true
 174   SKETCHPLUGIN_EXPORT virtual bool isMacro() const {return true;};
 175
 176   SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const {return false;};
 177
 178   /// Apply information of the message to current object. It fills reference object,
 179   /// tangent type and tangent point refence in case of tangent arc
 180   virtual std::string processEvent(const std::shared_ptr<Events_Message>& theMessage);
 181
 182   /// Use plugin manager for features creation
 183   SketchPlugin_MacroCircle();
 184
 185 private:
 186   void fillByCenterAndPassed();
 187   void fillByThreePoints();
 188   /// set fields if only two of three points is initialized
 189   void fillByTwoPassedPoints();
 190
 191   void constraintsForCircleByCenterAndPassed(FeaturePtr theCircleFeature);
 192   void constraintsForCircleByThreePoints(FeaturePtr theCircleFeature);
 193
 194   FeaturePtr createCircleFeature();
 195
 196 private:
 197   std::shared_ptr<GeomAPI_Pnt2d> myCenter;
 198   double                         myRadius;
 199 };
 200
 201 #endif