1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_Arc.h
4 // Created: 26 May 2014
5 // Author: Artem ZHIDKOV
7 #ifndef SketchPlugin_Arc_H_
8 #define SketchPlugin_Arc_H_
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_SketchEntity.h>
12 #include <SketchPlugin_Sketch.h>
13 #include <GeomAPI_IPresentable.h>
15 /**\class SketchPlugin_Arc
17 * \brief Feature for creation of the new arc of circle in PartSet.
18 * The visualization of this object is separated in two parts. The first one is an AIS object
19 * calculated when there is non-initialized attributes of the arc. The second is a result and
20 * it is calculated if all attributes are initialized.
22 class SketchPlugin_Arc : public SketchPlugin_SketchEntity, public GeomAPI_IPresentable
24 /// to avoid cyclic dependencies in automatic updates: they mean that
25 /// update is performed right now and automatic updates are not needed
26 bool myStartUpdate, myEndUpdate;
30 inline static const std::string& ID()
32 static const std::string MY_SKETCH_ARC_ID("SketchArc");
33 return MY_SKETCH_ARC_ID;
36 /// Central 2D point of the circle which contains the arc
37 inline static const std::string& CENTER_ID()
39 static const std::string MY_CENTER_ID = "ArcCenter";
42 /// Start 2D point of the arc
43 inline static const std::string& START_ID()
45 static const std::string MY_START_ID = "ArcStartPoint";
48 /// End 2D point of the arc
49 inline static const std::string& END_ID()
51 static const std::string MY_END_ID = "ArcEndPoint";
55 /// Returns the kind of a feature
56 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
58 static std::string MY_KIND = SketchPlugin_Arc::ID();
62 /// Returns true is sketch element is under the rigid constraint
63 SKETCHPLUGIN_EXPORT virtual bool isFixed();
65 /// Creates an arc-shape
66 SKETCHPLUGIN_EXPORT virtual void execute();
68 /// Request for initialization of data model of the feature: adding all attributes
69 SKETCHPLUGIN_EXPORT virtual void initAttributes();
71 /// Called on change of any argument-attribute of this object
72 /// \param theID identifier of changed attribute
73 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
75 /// Returns the AIS preview
76 virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
79 /// \param theDeltaX the delta for X coordinate is moved
80 /// \param theDeltaY the delta for Y coordinate is moved
81 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
83 /// Return the distance between the feature and the point
84 /// \param thePoint the point
85 virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
87 /// Use plugin manager for features creation
91 /// Returns true if all obligatory attributes are initialized
92 bool isFeatureValid();