Salome HOME
Merge branch 'master' into cgt/devCEA
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Arc.h
index 26815bc9ec1586bb04b05da1ae7ac2f8d6c61b79..1a5a5fc5ec54bca456733d12d347c40660547f45 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        SketchPlugin_Arc.h
 // Created:     26 May 2014
 // Author:      Artem ZHIDKOV
@@ -6,17 +8,29 @@
 #define SketchPlugin_Arc_H_
 
 #include "SketchPlugin.h"
-#include <SketchPlugin_Feature.h>
+#include <SketchPlugin_SketchEntity.h>
 #include <SketchPlugin_Sketch.h>
 #include <GeomAPI_IPresentable.h>
 
 /**\class SketchPlugin_Arc
- * \ingroup DataModel
+ * \ingroup Plugins
  * \brief Feature for creation of the new arc of circle in PartSet.
+ * The visualization of this object is separated in two parts. The first one is an AIS object
+ * calculated when there is non-initialized attributes of the arc. The second is a result and
+ * it is calculated if all attributes are initialized.
  */
-class SketchPlugin_Arc: public SketchPlugin_Feature//, public GeomAPI_IPresentable
+class SketchPlugin_Arc : public SketchPlugin_SketchEntity, public GeomAPI_IPresentable
 {
-public:
+  /// to avoid cyclic dependencies in automatic updates: they mean that
+  /// update is performed right now and automatic updates are not needed
+  bool myStartUpdate, myEndUpdate;
+  /// to avoid (if possible) additional modification of changed coordinate (issue #855)
+  double myXEndBefore, myYEndBefore;
+
+  /// to define in which direction draw arc
+  double myParamBefore;
+
+ public:
   /// Arc feature kind
   inline static const std::string& ID()
   {
@@ -24,12 +38,48 @@ public:
     return MY_SKETCH_ARC_ID;
   }
 
+  inline static const std::string& ARC_TYPE()
+  {
+    static const std::string TYPE("ArcType");
+    return TYPE;
+  }
+
+  inline static const std::string& ARC_TYPE_TANGENT()
+  {
+    static const std::string TYPE("Tangent");
+    return TYPE;
+  }
+
+  static const std::string& ARC_TYPE_CENTER_START_END()
+  {
+    static const std::string TYPE("CenterStartEnd");
+    return TYPE;
+  }
+  static const std::string& ARC_TYPE_THREE_POINTS()
+  {
+    static const std::string TYPE("ThreePoints");
+    return TYPE;
+  }
+
+  static const std::string& TANGENT_POINT_ID()
+  {
+    static const std::string TANGENT_PNT("ArcTangentPoint");
+    return TANGENT_PNT;
+  }
+
   /// Central 2D point of the circle which contains the arc
   inline static const std::string& CENTER_ID()
   {
     static const std::string MY_CENTER_ID = "ArcCenter";
     return MY_CENTER_ID;
   }
+
+  inline static const std::string& CENTER_REF_ID()
+  {
+    static const std::string MY_CENTER_REF_ID = "ArcCenterRef";
+    return MY_CENTER_REF_ID;
+  }
+
   /// Start 2D point of the arc
   inline static const std::string& START_ID()
   {
@@ -43,31 +93,79 @@ public:
     return MY_END_ID;
   }
 
+  /// Inversed flag
+  inline static const std::string& INVERSED_ID()
+  {
+    static const std::string MY_INVERSED_ID("InversedArc");
+    return MY_INVERSED_ID;
+  }
+
+  /// Passed point of the arc.
+  static const std::string& PASSED_POINT_ID()
+  {
+    static const std::string PASSED_PNT("ArcPassedPoint");
+    return PASSED_PNT;
+  }
+
+  /// Arc radius.
+  static const std::string& RADIUS_ID()
+  {
+    static const std::string RADIUS("ArcRadius");
+    return RADIUS;
+  }
+
+  /// Arc angle.
+  static const std::string& ANGLE_ID()
+  {
+    static const std::string ANGLE("ArcAngle");
+    return ANGLE;
+  }
+
   /// Returns the kind of a feature
   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
-  {static std::string MY_KIND = SketchPlugin_Arc::ID(); return MY_KIND;}
+  {
+    static std::string MY_KIND = SketchPlugin_Arc::ID();
+    return MY_KIND;
+  }
+
+  /// Returns true is sketch element is under the rigid constraint
+  SKETCHPLUGIN_EXPORT virtual bool isFixed();
 
   /// Creates an arc-shape
   SKETCHPLUGIN_EXPORT virtual void execute();
 
-  /// Request for initialization of data model of the feature: adding all attributes
-  SKETCHPLUGIN_EXPORT virtual void initAttributes();
+  /// Called on change of any argument-attribute of this object
+  /// \param theID identifier of changed attribute
+  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 
   /// Returns the AIS preview
-  virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious)
-  {return simpleAISObject(firstResult(), thePrevious);}
+  virtual AISObjectPtr getAISObject(AISObjectPtr 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);
+  /// Updates the "reversed" flag
+  /// \param isReversed  whether the arc will be reversed
+  void setReversed(bool isReversed);
+  /// Returns \c true is the arc is reversed
+  bool isReversed();
 
   /// Use plugin manager for features creation
   SketchPlugin_Arc();
+
+protected:
+  /// \brief Initializes attributes of derived class.
+  virtual void initDerivedClassAttributes();
+
+private:
+  /// Returns true if all obligatory attributes are initialized
+  bool isFeatureValid();
+
+  /// Compose constraints to build tangency arc
+  void tangencyArcConstraints();
+
 };
 
 #endif