Salome HOME
Avoid of reference to not-initialized attributes values
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Arc.h
index f22e92b4cd82222fcd87a9872af74f5b63f0c33a..812123b04e142af2de742fcb98d8353da923e622 100644 (file)
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        SketchPlugin_Arc.h
 // Created:     26 May 2014
 // Author:      Artem ZHIDKOV
 
-#ifndef SketchPlugin_Arc_HeaderFile
-#define SketchPlugin_Arc_HeaderFile
+#ifndef SketchPlugin_Arc_H_
+#define SketchPlugin_Arc_H_
 
 #include "SketchPlugin.h"
-#include <SketchPlugin_Feature.h>
-
-/// Central 2D point of the circle which contains the arc
-const std::string ARC_ATTR_CENTER("ArcCenter");
-/// Start 2D point of the arc
-const std::string ARC_ATTR_START("ArcStartPoint");
-/// End 2D point of the arc
-const std::string ARC_ATTR_END("ArcEndPoint");
+#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
+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()
+  {
+    static const std::string MY_SKETCH_ARC_ID("SketchArc");
+    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;
+  }
+  /// Start 2D point of the arc
+  inline static const std::string& START_ID()
+  {
+    static const std::string MY_START_ID = "ArcStartPoint";
+    return MY_START_ID;
+  }
+  /// End 2D point of the arc
+  inline static const std::string& END_ID()
+  {
+    static const std::string MY_END_ID = "ArcEndPoint";
+    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 = "SketchArc"; return MY_KIND;}
+  {
+    static std::string MY_KIND = SketchPlugin_Arc::ID();
+    return MY_KIND;
+  }
 
-  /// 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;}
+  /// Returns true is sketch element is under the rigid constraint
+  SKETCHPLUGIN_EXPORT virtual bool isFixed();
 
-  /// Creates a new part document if needed
+  /// 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);
 
-  /// Returns the sketch preview
-  SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
+  /// 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);
 
-  /// 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) {};
+  /// 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