src/SketchPlugin/SketchPlugin_Offset.h

   1 // Copyright (C) 2020  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_Offset_H_
  21 #define SketchPlugin_Offset_H_
  22
  23 #include <SketchPlugin.h>
  24 #include <SketchPlugin_SketchEntity.h>
  25
  26 /**\class SketchPlugin_Offset
  27  * \ingroup Plugins
  28  * \brief Builds offset curves in the sketch.
  29  */
  30 class SketchPlugin_Offset : public SketchPlugin_SketchEntity
  31 {
  32 public:
  33   /// Offset macro feature kind
  34   inline static const std::string& ID()
  35   {
  36     static const std::string ID("SketchOffset");
  37     return ID;
  38   }
  39
  40   /// Returns the kind of a feature
  41   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  42   {
  43     static std::string MY_KIND = SketchPlugin_Offset::ID();
  44     return MY_KIND;
  45   }
  46
  47   /// list of offset edges
  48   inline static const std::string& EDGES_ID()
  49   {
  50     static const std::string ID("segments");
  51     return ID;
  52   }
  53
  54   /// attribute to store the offset value
  55   inline static const std::string& VALUE_ID()
  56   {
  57     static const std::string ID("offset_value");
  58     return ID;
  59   }
  60
  61   /// attribute to store the reversed offset direction
  62   inline static const std::string& REVERSED_ID()
  63   {
  64     static const std::string ID("reversed");
  65     return ID;
  66   }
  67
  68   /// name for add wire action
  69   inline static const std::string& ADD_WIRE_ACTION_ID()
  70   {
  71     static const std::string ID("add_wire");
  72     return ID;
  73   }
  74
  75   /// Called on change of any argument-attribute of this object
  76   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  77
  78   /// Creates a new part document if needed
  79   SKETCHPLUGIN_EXPORT virtual void execute();
  80
  81   /// Reimplemented from ModelAPI_Feature::isMacro().
  82   /// \returns true
  83   SKETCHPLUGIN_EXPORT virtual bool isMacro() const { return true; }
  84
  85   SKETCHPLUGIN_EXPORT virtual bool isPreviesNeeded() const { return false; }
  86
  87   /// Find edges connected by coincident boundary constraint and composing a wire with
  88   /// the already selected segments. It means that not more than 2 edges can be connected
  89   /// with the coincident point.
  90   /// \param[in] theActionId action key id (in following form: Action#Index)
  91   /// \return \c false in case the action not performed.
  92   SKETCHPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
  93
  94   /// Use plugin manager for features creatio
  95   SketchPlugin_Offset();
  96
  97 protected:
  98   /// \brief Initializes attributes of derived class.
  99   virtual void initDerivedClassAttributes();
 100
 101 private:
 102   /// Find all wires connected with the selected edges
 103   bool findWires();
 104 };
 105
 106 #endif