Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Feature.h
index 486b8495ff102786dac42918dfcd357486dfd64a..a780d5e10efc223bf7f27575b36c679e4a63b911 100644 (file)
@@ -1,6 +1,22 @@
-// File:        SketchPlugin_Feature.h
-// Created:     27 Mar 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef SketchPlugin_Feature_H_
 #define SketchPlugin_Feature_H_
 #include "SketchPlugin.h"
 #include <ModelAPI_CompositeFeature.h>
 #include <GeomAPI_Shape.h>
-#include <GeomAPI_AISObject.h>
 #include <ModelAPI_Document.h>
 #include <ModelAPI_AttributeSelection.h>
+#include <ModelAPI_AttributeBoolean.h>
+
+#include <Config_PropManager.h>
 
 class SketchPlugin_Sketch;
-class GeomAPI_Pnt2d;
-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
 {
  public:
-  /// Simple creation of interactive object by the result of the object
-  static AISObjectPtr simpleAISObject(boost::shared_ptr<ModelAPI_Result> theRes,
-                                      AISObjectPtr thePrevious);
+  /// Returns true if this feature must be displayed in the history (top level of Part tree)
+  SKETCHPLUGIN_EXPORT virtual bool isInHistory()
+  {
+    return false;
+  }
 
-  /// Reference to the external edge or vertex as a AttributeSelection
-  inline static const std::string& EXTERNAL_ID()
+  /// Returns true of the feature is created basing on the external shape of not-this-sketch object
+  SKETCHPLUGIN_EXPORT virtual bool isExternal() const
   {
-    static const std::string MY_EXTERNAL_ID("External");
-    return MY_EXTERNAL_ID;
+    return false;
   }
 
-  /// Returns true if this feature must be displayed in the history (top level of Part tree)
-  SKETCHPLUGIN_EXPORT virtual bool isInHistory()
+  /// 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;
 
-  /// Return the distance between the feature and the point
-  /// \param thePoint the point
-  virtual double distanceToPoint(const boost::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;
-  }
-
   /// Returns the sketch of this feature
   SketchPlugin_Sketch* sketch();
 protected:
@@ -78,7 +90,7 @@ protected:
   friend class SketchPlugin_Sketch;
 
  private:
-  boost::shared_ptr<GeomAPI_Shape> myPreview;  ///< the preview shape
+  std::shared_ptr<GeomAPI_Shape> myPreview;  ///< the preview shape
   SketchPlugin_Sketch* mySketch;  /// sketch that contains this feature
 };