src/SketchPlugin/SketchPlugin_Feature.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        SketchPlugin_Feature.h
   4 // Created:     27 Mar 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef SketchPlugin_Feature_H_
   8 #define SketchPlugin_Feature_H_
   9
  10 #include "SketchPlugin.h"
  11 #include <ModelAPI_CompositeFeature.h>
  12 #include <GeomAPI_Shape.h>
  13 #include <GeomAPI_AISObject.h>
  14 #include <ModelAPI_Document.h>
  15 #include <ModelAPI_AttributeSelection.h>
  16 #include <ModelAPI_AttributeBoolean.h>
  17
  18 #include <Config_PropManager.h>
  19
  20 class SketchPlugin_Sketch;
  21 class Handle_AIS_InteractiveObject;
  22
  23 /**\class SketchPlugin_Feature
  24  * \ingroup Plugins
  25  * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
  26  * an interface to create the sketch feature preview.
  27  */
  28 class SketchPlugin_Feature : public ModelAPI_Feature
  29 {
  30  public:
  31   /// Returns true if this feature must be displayed in the history (top level of Part tree)
  32   SKETCHPLUGIN_EXPORT virtual bool isInHistory()
  33   {
  34     return false;
  35   }
  36
  37   /// Returns true of the feature is created basing on the external shape of not-this-sketch object
  38   SKETCHPLUGIN_EXPORT virtual bool isExternal() const
  39   {
  40     return false;
  41   }
  42
  43   /// Moves the feature
  44   /// \param theDeltaX the delta for X coordinate is moved
  45   /// \param theDeltaY the delta for Y coordinate is moved
  46   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 0;
  47
  48   /// Construction result is allways recomuted on the fly
  49   SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
  50
  51   /// Returns true is sketch element is under the rigid constraint
  52   SKETCHPLUGIN_EXPORT virtual bool isFixed() {return false;}
  53
  54   /// Returns the sketch of this feature
  55   SketchPlugin_Sketch* sketch();
  56 protected:
  57   /// Sets the higher-level feature for the sub-feature (sketch for line)
  58   void setSketch(SketchPlugin_Sketch* theSketch)
  59   {
  60     mySketch = theSketch;
  61   }
  62   /// initializes mySketch
  63   SketchPlugin_Feature();
  64
  65   friend class SketchPlugin_Sketch;
  66
  67  private:
  68   std::shared_ptr<GeomAPI_Shape> myPreview;  ///< the preview shape
  69   SketchPlugin_Sketch* mySketch;  /// sketch that contains this feature
  70 };
  71
  72 #endif