Issue #273: Add copyright string

[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Feature.h

diff --git a/src/SketchPlugin/SketchPlugin_Feature.h b/src/SketchPlugin/SketchPlugin_Feature.h
index 08476395845b4718e3b2c028a27d435cbe171677..01b9d88eecf788dd89f6f2ec9a7b858ea32cd17f 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_Feature.h
+++ b/src/SketchPlugin/SketchPlugin_Feature.h
@@ -1,13 +1,18 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        SketchPlugin_Feature.h
 // Created:     27 Mar 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef SketchPlugin_Feature_HeaderFile
-#define SketchPlugin_Feature_HeaderFile
+#ifndef SketchPlugin_Feature_H_
+#define SketchPlugin_Feature_H_
 
 #include "SketchPlugin.h"
-#include <ModelAPI_Feature.h>
+#include <ModelAPI_CompositeFeature.h>
 #include <GeomAPI_Shape.h>
+#include <GeomAPI_AISObject.h>
+#include <ModelAPI_Document.h>
+#include <ModelAPI_AttributeSelection.h>
 
 class SketchPlugin_Sketch;
 class GeomAPI_Pnt2d;
@@ -18,24 +23,25 @@ class Handle_AIS_InteractiveObject;
  * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
  * an interface to create the sketch feature preview.
  */
-class SketchPlugin_Feature: public ModelAPI_Feature
+class SketchPlugin_Feature : public ModelAPI_Feature
 {
-public:
-  /// Returns the sketch preview
-  /// \param theSketch the owner of this feature
-  /// \return the built preview
-  SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview() = 0;
-
-  /// Returns the AIS preview
-  SKETCHPLUGIN_EXPORT virtual Handle_AIS_InteractiveObject getAISShape(Handle_AIS_InteractiveObject thePrevious);
+ public:
+  /// Simple creation of interactive object by the result of the object
+  static AISObjectPtr simpleAISObject(std::shared_ptr<ModelAPI_Result> theRes,
+                                      AISObjectPtr thePrevious);
 
-  /// Adds sub-feature of the higher level feature (sub-element of the sketch)
-  /// \param theFeature sub-feature
-  SKETCHPLUGIN_EXPORT virtual const void addSub(
-    const FeaturePtr& theFeature) = 0;
+  /// Reference to the external edge or vertex as a AttributeSelection
+  inline static const std::string& EXTERNAL_ID()
+  {
+    static const std::string MY_EXTERNAL_ID("External");
+    return MY_EXTERNAL_ID;
+  }
 
   /// Returns true if this feature must be displayed in the history (top level of Part tree)
-  SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return false;}
+  SKETCHPLUGIN_EXPORT virtual bool isInHistory()
+  {
+    return false;
+  }
 
   /// Moves the feature
   /// \param theDeltaX the delta for X coordinate is moved
@@ -44,27 +50,38 @@ public:
 
   /// Return the distance between the feature and the point
   /// \param thePoint the point
-  virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
+  virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
+
+  /// Construction result is allways recomuted on the fly
+  SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
+
+  /// Returns true is sketch element is under the rigid constraint
+  SKETCHPLUGIN_EXPORT virtual bool isFixed() {return false;}
+
+  inline bool isExternal() const
+  {
+    AttributeSelectionPtr aAttr = data()->selection(EXTERNAL_ID());
+    if (aAttr)
+      return aAttr->context();
+    return false;
+  }
 
-protected:
-  /// Set the shape to the internal preview field
-  /// \param theShape a preview shape
-  void setPreview(const boost::shared_ptr<GeomAPI_Shape>& theShape); ///< the preview shape
-  /// Return the shape from the internal preview field
-  /// \return theShape a preview shape
-  const boost::shared_ptr<GeomAPI_Shape>& getPreview() const;
-  /// Sets the higher-level feature for the sub-feature (sketch for line)
-  void setSketch(SketchPlugin_Sketch* theSketch) {mySketch = theSketch;}
   /// Returns the sketch of this feature
   SketchPlugin_Sketch* sketch();
+protected:
+  /// Sets the higher-level feature for the sub-feature (sketch for line)
+  void setSketch(SketchPlugin_Sketch* theSketch)
+  {
+    mySketch = theSketch;
+  }
   /// initializes mySketch
   SketchPlugin_Feature();
 
   friend class SketchPlugin_Sketch;
 
-private:
-  boost::shared_ptr<GeomAPI_Shape> myPreview; ///< the preview shape
-  SketchPlugin_Sketch* mySketch; /// sketch that contains this feature
+ private:
+  std::shared_ptr<GeomAPI_Shape> myPreview;  ///< the preview shape
+  SketchPlugin_Sketch* mySketch;  /// sketch that contains this feature
 };
 
 #endif