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