Salome HOME
Update unit-tests for SketchPlugin. Test case for the Projection has been added
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Feature.h
index b9c32307157ce6dd76d7f566ca7f369faf15fad2..8829f102f5f9ea007d555b0fda4c71fb8dcd41b6 100644 (file)
@@ -1,59 +1,84 @@
+// 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 <ModelAPI_Document.h>
+#include <ModelAPI_AttributeSelection.h>
+#include <ModelAPI_AttributeBoolean.h>
+
+#include <Config_PropManager.h>
 
 class SketchPlugin_Sketch;
+class Handle_AIS_InteractiveObject;
 
 /**\class SketchPlugin_Feature
- * \ingroup DataModel
+ * \ingroup Plugins
  * \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;
+ public:
+  /// Returns true if this feature must be displayed in the history (top level of Part tree)
+  SKETCHPLUGIN_EXPORT virtual bool isInHistory()
+  {
+    return false;
+  }
 
-  /// Adds sub-feature of the higher level feature (sub-element of the sketch)
-  /// \param theFeature sub-feature
-  SKETCHPLUGIN_EXPORT virtual const void addSub(
-    const boost::shared_ptr<ModelAPI_Feature>& theFeature) = 0;
+  /// Returns true of the feature is created basing on the external shape of not-this-sketch object
+  SKETCHPLUGIN_EXPORT virtual bool isExternal() const
+  {
+    return false;
+  }
 
-  /// Returns true if this feature must be displayed in the history (top level of Part tree)
-  SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return false;}
+  /// Returns true if the feature is a copy of other feature
+  SKETCHPLUGIN_EXPORT virtual bool isCopy() const
+  {
+    return false;
+  }
+
+  /// Returns true if the feature and the feature results can be displayed
+  /// \return true
+  SKETCHPLUGIN_EXPORT virtual bool canBeDisplayed() const
+  {
+    return true;
+  }
 
+  /// Moves the feature
+  /// \param theDeltaX the delta for X coordinate is moved
+  /// \param theDeltaY the delta for Y coordinate is moved
+  SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 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;}
+
+  /// Returns the sketch of this feature
+  SketchPlugin_Sketch* sketch();
 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() {return mySketch;}
+  void setSketch(SketchPlugin_Sketch* theSketch)
+  {
+    mySketch = theSketch;
+  }
   /// initializes mySketch
   SketchPlugin_Feature();
-  /// Sets the data manager of an object and here initializes mySketch field
-  SKETCHPLUGIN_EXPORT virtual void setData(boost::shared_ptr<ModelAPI_Data> theData)
-  {ModelAPI_Feature::setData(theData);}
 
   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