Salome HOME
Relaunch operation on end of previous sketch operation
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Constraint.h
index 61cd2bf0554bc18567dbc87e17c4d48e078be365..d0a76b1cfd6a7d51fb2fdad963c809d051481147 100644 (file)
@@ -7,10 +7,12 @@
 
 #include "SketchPlugin.h"
 #include "SketchPlugin_Feature.h"
+#include <SketchPlugin_Sketch.h>
 #include <ModelAPI_AttributeReference.h>
 #include <ModelAPI_AttributeRefAttr.h>
 #include <list>
 
+
 /*  Description: 
  *    Each constraint uses a set of parameters. In the SolveSpace library 
  *    these parameters are named "valA", "ptA", "ptB", "entityA", "entityB". 
  *
  *    Also the list of possible attributes is provided to simplify assignment.
  */
-/// The value parameter for the constraint
-const std::string CONSTRAINT_ATTR_VALUE("ConstraintValue");
-/// First entity for the constraint
-const std::string CONSTRAINT_ATTR_ENTITY_A("ConstraintEntityA");
-/// Second entity for the constraint
-const std::string CONSTRAINT_ATTR_ENTITY_B("ConstraintEntityB");
-/// Third entity for the constraint
-const std::string CONSTRAINT_ATTR_ENTITY_C("ConstraintEntityC");
-/// Fourth entity for the constraint
-const std::string CONSTRAINT_ATTR_ENTITY_D("ConstraintEntityD");
-/// List of constraint attributes
-const unsigned int CONSTRAINT_ATTR_SIZE = 4;
-const std::string CONSTRAINT_ATTRIBUTES[CONSTRAINT_ATTR_SIZE] = 
-                      {CONSTRAINT_ATTR_ENTITY_A, CONSTRAINT_ATTR_ENTITY_B, 
-                       CONSTRAINT_ATTR_ENTITY_C, CONSTRAINT_ATTR_ENTITY_D};
 
+/// Size of the list of constraint attributes
+const unsigned int CONSTRAINT_ATTR_SIZE = 4;
 
 /** \class SketchPlugin_Constraint
  *  \ingroup DataModel
@@ -48,20 +37,80 @@ const std::string CONSTRAINT_ATTRIBUTES[CONSTRAINT_ATTR_SIZE] =
 class SketchPlugin_Constraint: public SketchPlugin_Feature
 {
 public:
-  /// \brief Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = "SketchConstraint"; return MY_KIND;}
+  /// The value parameter for the constraint
+  inline static const std::string& VALUE()
+  {
+    static const std::string MY_CONSTRAINT_VALUE("ConstraintValue");
+    return MY_CONSTRAINT_VALUE;
+  }
+  /// The 2D value parameter for the constraint
+  inline static const std::string& FLYOUT_VALUE_PNT()
+  {
+    static const std::string MY_FLYOUT_VALUE_PNT("ConstraintFlyoutValuePnt");
+    return MY_FLYOUT_VALUE_PNT;
+  }
+  /// First entity for the constraint
+  inline static const std::string& ENTITY_A()
+  {
+    static const std::string MY_ENTITY_A("ConstraintEntityA");
+    return MY_ENTITY_A;
+  }
+  /// Second entity for the constraint
+  inline static const std::string& ENTITY_B()
+  {
+    static const std::string MY_ENTITY_B("ConstraintEntityB");
+    return MY_ENTITY_B;
+  }
+  /// Third entity for the constraint
+  inline static const std::string& ENTITY_C()
+  {
+    static const std::string MY_ENTITY_C("ConstraintEntityC");
+    return MY_ENTITY_C;
+  }
+  /// Fourth entity for the constraint
+  inline static const std::string& ENTITY_D()
+  {
+    static const std::string MY_ENTITY_D("ConstraintEntityD");
+    return MY_ENTITY_D;
+  }
+
+  /// List of constraint attributes
+  inline static const std::string& ATTRIBUTE(const int theNumber) {
+    switch (theNumber) {
+      case 0: return ENTITY_A();
+      case 1: return ENTITY_B();
+      case 2: return ENTITY_C();
+      case 3: return ENTITY_D();
+      default: break;
+    }
+    static const std::string EMPTY_STRING("");
+    return EMPTY_STRING;
+  }
 
   /// \brief Returns to which group in the document must be added feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
-  {static std::string MY_GROUP = "Sketch"; return MY_GROUP;}
+  SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
+  {static std::string MY_GROUP = SketchPlugin_Sketch::ID(); return MY_GROUP;}
 
   /** \brief 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) {}
+    const FeaturePtr& theFeature) {}
+
+  /// Returns the AIS preview
+  SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
+                                boost::shared_ptr<GeomAPI_AISObject> thePrevious);
+
+  /// 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) {};
+
+  /// Return the distance between the feature and the point
+  /// \param thePoint the point
+  virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) { return 0; };
 
+protected:
   /// \brief Use plugin manager for features creation
   SketchPlugin_Constraint() {}
 };