1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef SketchPlugin_MacroArc_H_
21 #define SketchPlugin_MacroArc_H_
23 #include <ModelAPI_IReentrant.h>
25 #include "SketchPlugin.h"
26 #include "SketchPlugin_SketchEntity.h"
28 #include <GeomAPI_IPresentable.h>
33 /**\class SketchPlugin_MacroArc
35 * \brief Feature for creation of the new arc of circle in PartSet.
36 * The visualization of this object is separated in two parts. The first one is an AIS object
37 * calculated when there is non-initialized attributes of the arc. The second is a result and
38 * it is calculated if all attributes are initialized.
40 class SketchPlugin_MacroArc: public SketchPlugin_SketchEntity,
41 public GeomAPI_IPresentable,
42 public ModelAPI_IReentrant
46 inline static const std::string& ID()
48 static const std::string ID("SketchMacroArc");
52 inline static const std::string& ARC_TYPE()
54 static const std::string ID("arc_type");
58 static const std::string& ARC_TYPE_BY_CENTER_AND_POINTS()
60 static const std::string ID("by_center_and_points");
63 static const std::string& ARC_TYPE_BY_THREE_POINTS()
65 static const std::string ID("by_three_points");
69 inline static const std::string& ARC_TYPE_BY_TANGENT_EDGE()
71 static const std::string ID("by_tangent_edge");
75 /// Central 2D point of the circle which contains the arc
76 inline static const std::string& CENTER_POINT_ID()
78 static const std::string ID = "center_point";
82 inline static const std::string& CENTER_POINT_REF_ID()
84 static const std::string ID = "center_point_ref";
88 /// Start 2D point of the arc
89 inline static const std::string& START_POINT_1_ID()
91 static const std::string ID = "start_point_1";
95 /// Start 2D point of the arc
96 inline static const std::string& START_POINT_2_ID()
98 static const std::string ID = "start_point_2";
102 inline static const std::string& START_POINT_REF_ID()
104 static const std::string ID = "start_point_ref";
108 /// End 2D point of the arc
109 inline static const std::string& END_POINT_1_ID()
111 static const std::string ID = "end_point_1";
115 /// End 2D point of the arc
116 inline static const std::string& END_POINT_2_ID()
118 static const std::string ID = "end_point_2";
122 /// End 2D point of the arc
123 inline static const std::string& END_POINT_3_ID()
125 static const std::string ID = "end_point_3";
129 inline static const std::string& END_POINT_REF_ID()
131 static const std::string ID = "end_point_ref";
135 /// Passed point of the arc.
136 static const std::string& PASSED_POINT_ID()
138 static const std::string ID("passed_point");
142 static const std::string& PASSED_POINT_REF_ID()
144 static const std::string ID("passed_point_ref");
148 static const std::string& TANGENT_POINT_ID()
150 static const std::string ID("tangent_point");
155 inline static const std::string& REVERSED_ID()
157 static const std::string ID("reversed");
162 static const std::string& RADIUS_ID()
164 static const std::string ID("radius");
169 static const std::string& ANGLE_ID()
171 static const std::string ID("angle");
176 static const std::string& EDIT_ARC_TYPE_ID()
178 static const std::string ID("edit_arc_type");
182 /// Returns the kind of a feature
183 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
185 static std::string MY_KIND = SketchPlugin_MacroArc::ID();
189 /// \brief Request for initialization of data model of the feature: adding all attributes.
190 SKETCHPLUGIN_EXPORT virtual void initAttributes();
192 /// Called on change of any argument-attribute of this object
193 /// \param theID identifier of changed attribute
194 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
196 /// Returns the AIS preview
197 virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
199 /// Creates an arc-shape
200 SKETCHPLUGIN_EXPORT virtual void execute();
202 /// Reimplemented from ModelAPI_Feature::isMacro().
203 SKETCHPLUGIN_EXPORT virtual bool isMacro() const {return true;};
205 SKETCHPLUGIN_EXPORT virtual bool isPreviewNeeded() const {return false;};
207 /// Apply information of the message to current object. It fills reference object,
208 /// tangent type and tangent point refence in case of tangent arc
209 virtual std::string processEvent(const std::shared_ptr<Events_Message>& theMessage);
211 /// Use plugin manager for features creation.
212 SketchPlugin_MacroArc();
214 /// Returns shape of arc.
215 /// \param isBound if true prepare arc, otherwice create circle containing this arc
216 GeomShapePtr getArcShape(bool isBound = true);
219 /// Set fields for center, start and end points
220 void fillByCenterAndTwoPassed();
221 /// Set fields for center, start and end points by selected passed points
222 void fillByThreePassedPoints();
223 /// Set fields for center, start and end points by selected tangent edge
224 void fillByTangentEdge();
226 FeaturePtr createArcFeature();
228 void recalculateReversedFlagByEnd(const GeomAPI_Circ2d& theCurrentCircular);
229 void recalculateReversedFlagByPassed(const GeomAPI_Circ2d& theCurrentCircular);
232 std::shared_ptr<GeomAPI_Pnt2d> myCenter;
233 std::shared_ptr<GeomAPI_Pnt2d> myStart;
234 std::shared_ptr<GeomAPI_Pnt2d> myEnd;
236 /// To define in which direction draw arc.
237 double myParamBefore;