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 #include <GeomDataAPI_Point2D.h>
  26
  27 /**\class SketchPlugin_Offset
  28  * \ingroup Plugins
  29  * \brief Builds offset curves in the sketch.
  30  */
  31 class SketchPlugin_Offset : public SketchPlugin_SketchEntity
  32 {
  33 public:
  34   /// Offset macro feature kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string ID("SketchOffset");
  38     return ID;
  39   }
  40
  41   /// Returns the kind of a feature
  42   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  43   {
  44     static std::string MY_KIND = SketchPlugin_Offset::ID();
  45     return MY_KIND;
  46   }
  47
  48   /// list of offset edges
  49   inline static const std::string& EDGES_ID()
  50   {
  51     static const std::string ID("segments");
  52     return ID;
  53   }
  54
  55   /// attribute to store the offset value
  56   inline static const std::string& VALUE_ID()
  57   {
  58     static const std::string ID("offset_value");
  59     return ID;
  60   }
  61
  62   /// attribute to store the reversed offset direction
  63   inline static const std::string& REVERSED_ID()
  64   {
  65     static const std::string ID("reversed");
  66     return ID;
  67   }
  68
  69   /// name for add wire action
  70   inline static const std::string& ADD_WIRE_ACTION_ID()
  71   {
  72     static const std::string ID("add_wire");
  73     return ID;
  74   }
  75
  76   /// Called on change of any argument-attribute of this object
  77   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  78
  79   /// Creates a new part document if needed
  80   SKETCHPLUGIN_EXPORT virtual void execute();
  81
  82   /// Reimplemented from ModelAPI_Feature::isMacro().
  83   /// \returns true
  84   SKETCHPLUGIN_EXPORT virtual bool isMacro() const { return true; }
  85
  86   //SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
  87   SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return true; }
  88
  89   /// Find edges connected by coincident boundary constraint and composing a wire with
  90   /// the already selected segments. It means that not more than 2 edges can be connected
  91   /// with the coincident point.
  92   /// \param[in] theActionId action key id (in following form: Action#Index)
  93   /// \return \c false in case the action not performed.
  94   SKETCHPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
  95
  96   /// Use plugin manager for features creation.
  97   SketchPlugin_Offset();
  98
  99 protected:
 100   /// \brief Initializes attributes of derived class.
 101   virtual void initDerivedClassAttributes();
 102
 103 private:
 104   /// Find all wires connected with the selected edges
 105   bool findWires();
 106
 107   // Create sketch feature for each edge of theOffsetResult,
 108   // and store it in myCreatedFeatures to remove on next execute()
 109   void addToSketch (const std::shared_ptr<GeomAPI_Shape>& theOffsetResult);
 110
 111   // Find edges that prolongate theEdgeFeature (in a chain) at theEndPoint
 112   // Recursive method.
 113   // \param[in] theFirstEdge Start edge of wire searching
 114   // \param[in] theEdge Current edge
 115   // \param[in] theEndPoint Point of the Current edge, not belonging to a previous edge
 116   // \param[in/out] theEdgesSet All edges to find among. If empty, all sketch edges assumed.
 117   // \param[in/out] theChain Resulting edges
 118   /// \return \c true if the chain is closed
 119   bool findWireOneWay (const FeaturePtr& theFirstEdge,
 120                        const FeaturePtr& theEdge,
 121                        const std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint,
 122                        std::set<FeaturePtr>& theEdgesSet,
 123                        std::list<FeaturePtr>& theChain);
 124
 125   // tmp
 126   std::set<FeaturePtr> myCreatedFeatures;
 127 };
 128
 129 #endif