Salome HOME
updated copyright message
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Arc.h
index 47a9f9dd45d2d089d1f2c469478ba1631d2b1b17..57cf7654dddee8a0ee59fb5e05c3ce6a19975528 100644 (file)
@@ -1,16 +1,30 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        SketchPlugin_Arc.h
-// Created:     26 May 2014
-// Author:      Artem ZHIDKOV
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// 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
+//
 
 #ifndef SketchPlugin_Arc_H_
 #define SketchPlugin_Arc_H_
 
 #include "SketchPlugin.h"
-#include <SketchPlugin_SketchEntity.h>
-#include <SketchPlugin_Sketch.h>
-#include <GeomAPI_IPresentable.h>
+
+#include "SketchPlugin_SketchEntity.h"
+
+
 
 /**\class SketchPlugin_Arc
  * \ingroup Plugins
  * 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_SketchEntity, public GeomAPI_IPresentable
+class SketchPlugin_Arc: public SketchPlugin_SketchEntity
 {
-  /// to avoid cyclic dependencies in automatic updates: they mean that 
-  /// update is performed right now and automatic updates are not needed
-  bool myStartUpdate, myEndUpdate;
-
  public:
   /// Arc feature kind
   inline static const std::string& ID()
   {
-    static const std::string MY_SKETCH_ARC_ID("SketchArc");
-    return MY_SKETCH_ARC_ID;
+    static const std::string ID("SketchArc");
+    return ID;
   }
 
   /// 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;
+    static const std::string ID = "center_point";
+    return 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;
+    static const std::string ID = "start_point";
+    return 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;
+    static const std::string ID = "end_point";
+    return ID;
+  }
+
+  /// Arc radius.
+  static const std::string& RADIUS_ID()
+  {
+    static const std::string ID("radius");
+    return ID;
+  }
+
+  /// Arc angle.
+  static const std::string& ANGLE_ID()
+  {
+    static const std::string ID("angle");
+    return ID;
+  }
+
+  /// Reversed flag
+  inline static const std::string& REVERSED_ID()
+  {
+    static const std::string ID("reversed");
+    return ID;
   }
 
   /// Returns the kind of a feature
@@ -62,34 +95,30 @@ class SketchPlugin_Arc : public SketchPlugin_SketchEntity, public GeomAPI_IPrese
   /// 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);
+  /// Creates an arc-shape
+  SKETCHPLUGIN_EXPORT virtual void execute();
 
-  /// 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);
+  /// Updates the "reversed" flag
+  /// \param isReversed  whether the arc will be reversed
+  void setReversed(bool isReversed);
 
-  /// Return the distance between the feature and the point
-  /// \param thePoint the point
-  virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
+  /// 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();
+  /// to define in which direction draw arc
+  double myParamBefore;
 };
 
 #endif