src/SketchPlugin/SketchPlugin_SketchCopy.h

   1 // Copyright (C) 2020-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_SketchCopy_H_
  21 #define SketchPlugin_SketchCopy_H_
  22
  23 #include "SketchPlugin.h"
  24 #include <ModelAPI_Feature.h>
  25
  26 /// \class SketchPlugin_SketchCopy
  27 /// \ingroup Plugins
  28 /// \brief Feature for copy of a sketch and all its sub-features to the same plane.
  29 class SketchPlugin_SketchCopy : public ModelAPI_Feature
  30 {
  31 public:
  32   /// A constructor
  33   SketchPlugin_SketchCopy();
  34
  35   /// Feature kind.
  36   inline static const std::string& ID()
  37   {
  38     static const std::string MY_FEATURE_ID("SketchCopy");
  39     return MY_FEATURE_ID;
  40   }
  41
  42   /// Attribute name of the base sketch selected.
  43   inline static const std::string& BASE_ID()
  44   {
  45     static const std::string ID("base_sketch");
  46     return ID;
  47   }
  48
  49   /// \return the kind of a feature.
  50   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  51   {
  52     static std::string MY_KIND = SketchPlugin_SketchCopy::ID();
  53     return MY_KIND;
  54   }
  55
  56   /// Creates a new sketch.
  57   SKETCHPLUGIN_EXPORT virtual void execute();
  58
  59   /// Request for initialization of data model of the feature: adding all attributes.
  60   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  61
  62   /// Means that feature is removed on apply.
  63   SKETCHPLUGIN_EXPORT virtual bool isMacro() const {return true;}
  64
  65   /// No preview is generated until it is applied.
  66   SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const {return false;}
  67 };
  68
  69 #endif