]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_Plugin.cpp
Salome HOME
Add SketchPlugin document template.
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Plugin.cpp
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #include <SketchPlugin_Plugin.h>
22 #include <SketchPlugin_Sketch.h>
23 #include <SketchPlugin_Line.h>
24 #include <SketchPlugin_Point.h>
25 #include <SketchPlugin_IntersectionPoint.h>
26 #include <SketchPlugin_Circle.h>
27 #include <SketchPlugin_Arc.h>
28 #include <SketchPlugin_Projection.h>
29 #include <SketchPlugin_ConstraintAngle.h>
30 #include <SketchPlugin_ConstraintCoincidence.h>
31 #include <SketchPlugin_ConstraintCollinear.h>
32 #include <SketchPlugin_ConstraintDistance.h>
33 #include <SketchPlugin_ConstraintDistanceHorizontal.h>
34 #include <SketchPlugin_ConstraintDistanceVertical.h>
35 #include <SketchPlugin_ConstraintEqual.h>
36 #include <SketchPlugin_Fillet.h>
37 #include <SketchPlugin_ConstraintHorizontal.h>
38 #include <SketchPlugin_ConstraintLength.h>
39 #include <SketchPlugin_ConstraintMiddle.h>
40 #include <SketchPlugin_ConstraintMirror.h>
41 #include <SketchPlugin_ConstraintParallel.h>
42 #include <SketchPlugin_ConstraintPerpendicular.h>
43 #include <SketchPlugin_ConstraintRadius.h>
44 #include <SketchPlugin_ConstraintRigid.h>
45 #include <SketchPlugin_ConstraintTangent.h>
46 #include <SketchPlugin_ConstraintVertical.h>
47 #include <SketchPlugin_MacroArc.h>
48 #include <SketchPlugin_MacroCircle.h>
49 #include <SketchPlugin_MultiRotation.h>
50 #include <SketchPlugin_MultiTranslation.h>
51 #include <SketchPlugin_Trim.h>
52 #include <SketchPlugin_Split.h>
53 #include <SketchPlugin_Validators.h>
54 #include <SketchPlugin_ExternalValidator.h>
55 #include <SketchPlugin_Ellipse.h>
56 #include <SketchPlugin_MacroEllipse.h>
57
58 #include <SketcherPrs_Tools.h>
59
60 #include <Events_Loop.h>
61 #include <GeomDataAPI_Dir.h>
62
63 #include <ModelAPI_Session.h>
64 #include <ModelAPI_Document.h>
65 #include <ModelAPI_Validator.h>
66 #include <ModelAPI_Data.h>
67
68 #include <Config_PropManager.h>
69
70 #include <memory>
71 #include <sstream>
72
73 #ifdef _DEBUG
74 #include <iostream>
75 #endif
76
77 #define SKETCH_ENTITY_COLOR "225,0,0"
78 #define SKETCH_EXTERNAL_COLOR "170,0,225"
79 #define SKETCH_AUXILIARY_COLOR "0,85,0"
80 #define SKETCH_OVERCONSTRAINT_COLOR "0,0,0"
81 #define SKETCH_FULLY_CONSTRAINED_COLOR "0,150,0"
82
83 //#define SET_PLANES_COLOR_IN_PREFERENCES
84
85 // the only created instance of this plugin
86 static SketchPlugin_Plugin* MY_SKETCH_INSTANCE = new SketchPlugin_Plugin();
87
88 SketchPlugin_Plugin::SketchPlugin_Plugin()
89 {
90   SessionPtr aMgr = ModelAPI_Session::get();
91   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
92   aFactory->registerValidator("SketchPlugin_DistanceAttr",
93                               new SketchPlugin_DistanceAttrValidator);
94   aFactory->registerValidator("SketchPlugin_ExternalValidator",
95                               new SketchPlugin_ExternalValidator);
96   aFactory->registerValidator("SketchPlugin_TangentAttr",
97                               new SketchPlugin_TangentAttrValidator);
98   aFactory->registerValidator("SketchPlugin_NotFixed",
99                               new SketchPlugin_NotFixedValidator);
100   aFactory->registerValidator("SketchPlugin_EqualAttr",
101                               new SketchPlugin_EqualAttrValidator);
102   aFactory->registerValidator("SketchPlugin_MirrorAttr",
103                               new SketchPlugin_MirrorAttrValidator);
104   aFactory->registerValidator("SketchPlugin_CoincidenceAttr",
105                               new SketchPlugin_CoincidenceAttrValidator);
106   aFactory->registerValidator("SketchPlugin_CopyValidator",
107                               new SketchPlugin_CopyValidator);
108   aFactory->registerValidator("SketchPlugin_SolverErrorValidator",
109                               new SketchPlugin_SolverErrorValidator);
110   aFactory->registerValidator("SketchPlugin_FilletVertexValidator",
111                               new SketchPlugin_FilletVertexValidator);
112   aFactory->registerValidator("SketchPlugin_SplitValidator",
113                               new SketchPlugin_SplitValidator);
114   aFactory->registerValidator("SketchPlugin_TrimValidator",
115                               new SketchPlugin_TrimValidator);
116   aFactory->registerValidator("SketchPlugin_MiddlePointAttr",
117                               new SketchPlugin_MiddlePointAttrValidator);
118   aFactory->registerValidator("SketchPlugin_ArcTangentPoint",
119                               new SketchPlugin_ArcTangentPointValidator);
120   aFactory->registerValidator("SketchPlugin_IntersectionValidator",
121                               new SketchPlugin_IntersectionValidator);
122   aFactory->registerValidator("SketchPlugin_ProjectionValidator",
123                               new SketchPlugin_ProjectionValidator);
124   aFactory->registerValidator("SketchPlugin_DifferentReference",
125                               new SketchPlugin_DifferentReferenceValidator);
126   aFactory->registerValidator("SketchPlugin_DifferentPointReference",
127                               new SketchPlugin_DifferentPointReferenceValidator);
128   aFactory->registerValidator("SketchPlugin_CirclePassedPointValidator",
129                               new SketchPlugin_CirclePassedPointValidator);
130   aFactory->registerValidator("SketchPlugin_ThirdPointValidator",
131                               new SketchPlugin_ThirdPointValidator);
132   aFactory->registerValidator("SketchPlugin_ArcEndPointValidator",
133                               new SketchPlugin_ArcEndPointValidator);
134   aFactory->registerValidator("SketchPlugin_ArcEndPointIntersectionValidator",
135                               new SketchPlugin_ArcEndPointIntersectionValidator);
136   aFactory->registerValidator("SketchPlugin_HasNoConstraint", new SketchPlugin_HasNoConstraint);
137   aFactory->registerValidator("SketchPlugin_ReplicationReference",
138                               new SketchPlugin_ReplicationReferenceValidator);
139   aFactory->registerValidator("SketchPlugin_SketchFeatureValidator",
140                               new SketchPlugin_SketchFeatureValidator);
141   aFactory->registerValidator("SketchPlugin_MultiRotationAngleValidator",
142                               new SketchPlugin_MultiRotationAngleValidator);
143
144   // register this plugin
145   ModelAPI_Session::get()->registerPlugin(this);
146
147   Config_PropManager::registerProp("Visualization", "sketch_entity_color",
148                                    "Sketch entity color",
149                                    Config_Prop::Color, SKETCH_ENTITY_COLOR);
150
151   Config_PropManager::registerProp("Visualization", "sketch_external_color",
152                                    "Sketch external entity color",
153                                    Config_Prop::Color, SKETCH_EXTERNAL_COLOR);
154
155   Config_PropManager::registerProp("Visualization", "sketch_auxiliary_color",
156                                    "Sketch auxiliary entity color",
157                                    Config_Prop::Color, SKETCH_AUXILIARY_COLOR);
158
159   Config_PropManager::registerProp("Visualization", "sketch_overconstraint_color",
160                                    "Sketch overconstraint color",
161                                    Config_Prop::Color, SKETCH_OVERCONSTRAINT_COLOR);
162
163   Config_PropManager::registerProp("Visualization", "sketch_fully_constrained_color",
164                                    "Sketch fully constrained color",
165                                    Config_Prop::Color, SKETCH_FULLY_CONSTRAINED_COLOR);
166
167   // register sketcher properties
168 #ifdef SET_PLANES_COLOR_IN_PREFERENCES
169   Config_PropManager::registerProp("Visualization", "yz_plane_color", "YZ plane color",
170                                    Config_Prop::Color, YZ_PLANE_COLOR);
171   Config_PropManager::registerProp("Visualization", "xz_plane_color", "XZ plane color",
172                                    Config_Prop::Color, XZ_PLANE_COLOR);
173   Config_PropManager::registerProp("Visualization", "xy_plane_color", "XY plane color",
174                                    Config_Prop::Color, XY_PLANE_COLOR);
175 #endif
176
177 }
178
179 FeaturePtr SketchPlugin_Plugin::createFeature(std::string theFeatureID)
180 {
181   if (theFeatureID == SketchPlugin_Sketch::ID()) {
182     return FeaturePtr(new SketchPlugin_Sketch);
183   } else if (theFeatureID == SketchPlugin_Point::ID()) {
184     return FeaturePtr(new SketchPlugin_Point);
185   } else if (theFeatureID == SketchPlugin_IntersectionPoint::ID()) {
186     return FeaturePtr(new SketchPlugin_IntersectionPoint);
187   } else if (theFeatureID == SketchPlugin_Line::ID()) {
188     return FeaturePtr(new SketchPlugin_Line);
189   } else if (theFeatureID == SketchPlugin_Circle::ID()) {
190     return FeaturePtr(new SketchPlugin_Circle);
191   } else if (theFeatureID == SketchPlugin_Arc::ID()) {
192     return FeaturePtr(new SketchPlugin_Arc);
193   } else if (theFeatureID == SketchPlugin_Projection::ID()) {
194     return FeaturePtr(new SketchPlugin_Projection);
195   } else if (theFeatureID == SketchPlugin_ConstraintCoincidence::ID()) {
196     return FeaturePtr(new SketchPlugin_ConstraintCoincidence);
197   } else if (theFeatureID == SketchPlugin_ConstraintCollinear::ID()) {
198     return FeaturePtr(new SketchPlugin_ConstraintCollinear);
199   } else if (theFeatureID == SketchPlugin_ConstraintDistance::ID()) {
200     return FeaturePtr(new SketchPlugin_ConstraintDistance);
201   } else if (theFeatureID == SketchPlugin_ConstraintDistanceHorizontal::ID()) {
202     return FeaturePtr(new SketchPlugin_ConstraintDistanceHorizontal);
203   } else if (theFeatureID == SketchPlugin_ConstraintDistanceVertical::ID()) {
204     return FeaturePtr(new SketchPlugin_ConstraintDistanceVertical);
205   } else if (theFeatureID == SketchPlugin_ConstraintLength::ID()) {
206     return FeaturePtr(new SketchPlugin_ConstraintLength);
207   } else if (theFeatureID == SketchPlugin_ConstraintParallel::ID()) {
208     return FeaturePtr(new SketchPlugin_ConstraintParallel);
209   } else if (theFeatureID == SketchPlugin_ConstraintPerpendicular::ID()) {
210     return FeaturePtr(new SketchPlugin_ConstraintPerpendicular);
211   } else if (theFeatureID == SketchPlugin_ConstraintRadius::ID()) {
212     return FeaturePtr(new SketchPlugin_ConstraintRadius);
213   } else if (theFeatureID == SketchPlugin_ConstraintRigid::ID()) {
214     return FeaturePtr(new SketchPlugin_ConstraintRigid);
215   } else if (theFeatureID == SketchPlugin_ConstraintHorizontal::ID()) {
216     return FeaturePtr(new SketchPlugin_ConstraintHorizontal);
217   } else if (theFeatureID == SketchPlugin_ConstraintVertical::ID()) {
218     return FeaturePtr(new SketchPlugin_ConstraintVertical);
219   } else if (theFeatureID == SketchPlugin_ConstraintEqual::ID()) {
220     return FeaturePtr(new SketchPlugin_ConstraintEqual);
221   } else if (theFeatureID == SketchPlugin_ConstraintTangent::ID()) {
222     return FeaturePtr(new SketchPlugin_ConstraintTangent);
223   } else if (theFeatureID == SketchPlugin_ConstraintMiddle::ID()) {
224     return FeaturePtr(new SketchPlugin_ConstraintMiddle);
225   } else if (theFeatureID == SketchPlugin_ConstraintMirror::ID()) {
226     return FeaturePtr(new SketchPlugin_ConstraintMirror);
227   } else if (theFeatureID == SketchPlugin_Fillet::ID()) {
228     return FeaturePtr(new SketchPlugin_Fillet);
229   } else if (theFeatureID == SketchPlugin_MultiTranslation::ID()) {
230     return FeaturePtr(new SketchPlugin_MultiTranslation);
231   } else if (theFeatureID == SketchPlugin_MultiRotation::ID()) {
232     return FeaturePtr(new SketchPlugin_MultiRotation);
233   } else if (theFeatureID == SketchPlugin_ConstraintAngle::ID()) {
234     return FeaturePtr(new SketchPlugin_ConstraintAngle);
235   } else if (theFeatureID == SketchPlugin_Split::ID()) {
236     return FeaturePtr(new SketchPlugin_Split);
237   } else if (theFeatureID == SketchPlugin_Trim::ID()) {
238     return FeaturePtr(new SketchPlugin_Trim);
239   } else if (theFeatureID == SketchPlugin_MacroArc::ID()) {
240     return FeaturePtr(new SketchPlugin_MacroArc);
241   } else if (theFeatureID == SketchPlugin_MacroCircle::ID()) {
242     return FeaturePtr(new SketchPlugin_MacroCircle);
243   } else if (theFeatureID == SketchPlugin_Ellipse::ID()) {
244     return FeaturePtr(new SketchPlugin_Ellipse);
245   } else if (theFeatureID == SketchPlugin_MacroEllipse::ID()) {
246     return FeaturePtr(new SketchPlugin_MacroEllipse);
247   }
248   // feature of such kind is not found
249   return FeaturePtr();
250 }
251
252 void SketchPlugin_Plugin::processEvent(const std::shared_ptr<Events_Message>& theMessage)
253 {
254   const Events_ID kRequestEvent =
255       Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
256   if (theMessage->eventID() == kRequestEvent) {
257     std::shared_ptr<ModelAPI_FeatureStateMessage> aStateMessage =
258         std::dynamic_pointer_cast<ModelAPI_FeatureStateMessage>(theMessage);
259     Events_Loop::loop()->send(getFeaturesState(aStateMessage->feature()), false);
260   }
261 }
262
263 std::shared_ptr<ModelAPI_FeatureStateMessage> SketchPlugin_Plugin
264 ::getFeaturesState(const std::shared_ptr<ModelAPI_Feature>& theFeature) const
265 {
266   const Events_ID kResponseEvent = Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_RESPONSE);
267   std::shared_ptr<ModelAPI_FeatureStateMessage> aMsg(
268       new ModelAPI_FeatureStateMessage(kResponseEvent, this));
269
270   bool aHasSketchPlane = false;
271   std::shared_ptr<SketchPlugin_Sketch> aSketchFeature =
272       std::dynamic_pointer_cast<SketchPlugin_Sketch>(theFeature);
273   if (aSketchFeature.get()) {
274     std::shared_ptr<ModelAPI_Data> aData = aSketchFeature->data();
275     if (aData) {
276       std::shared_ptr<GeomDataAPI_Dir> aNormal =
277         std::dynamic_pointer_cast<GeomDataAPI_Dir>(
278         aData->attribute(SketchPlugin_Sketch::NORM_ID()));
279       // it is important to check whether the normal attribute is initialized
280       // because it is possible that normal values are filled when the plane is checked on validity
281       aHasSketchPlane = aNormal && aNormal->isInitialized() &&
282                         !(aNormal->x() == 0 && aNormal->y() == 0 && aNormal->z() == 0);
283
284       aMsg->setState(SketchPlugin_Point::ID(), aHasSketchPlane);
285       aMsg->setState(SketchPlugin_IntersectionPoint::ID(), aHasSketchPlane);
286       aMsg->setState(SketchPlugin_Line::ID(), aHasSketchPlane);
287       aMsg->setState(SketchPlugin_Circle::ID(), aHasSketchPlane);
288       aMsg->setState(SketchPlugin_Arc::ID(), aHasSketchPlane);
289       aMsg->setState(SketchPlugin_Ellipse::ID(), aHasSketchPlane);
290       aMsg->setState(SketchPlugin_Projection::ID(), aHasSketchPlane);
291       aMsg->setState(SketchPlugin_ConstraintCoincidence::ID(), aHasSketchPlane);
292       aMsg->setState(SketchPlugin_ConstraintCollinear::ID(), aHasSketchPlane);
293       aMsg->setState(SketchPlugin_ConstraintDistance::ID(), aHasSketchPlane);
294       aMsg->setState(SketchPlugin_ConstraintLength::ID(), aHasSketchPlane);
295       aMsg->setState(SketchPlugin_ConstraintParallel::ID(), aHasSketchPlane);
296       aMsg->setState(SketchPlugin_ConstraintPerpendicular::ID(), aHasSketchPlane);
297       aMsg->setState(SketchPlugin_ConstraintRadius::ID(), aHasSketchPlane);
298       aMsg->setState(SketchPlugin_ConstraintRigid::ID(), aHasSketchPlane);
299       aMsg->setState(SketchPlugin_ConstraintHorizontal::ID(), aHasSketchPlane);
300       aMsg->setState(SketchPlugin_ConstraintVertical::ID(), aHasSketchPlane);
301       aMsg->setState(SketchPlugin_ConstraintEqual::ID(), aHasSketchPlane);
302       aMsg->setState(SketchPlugin_ConstraintTangent::ID(), aHasSketchPlane);
303       aMsg->setState(SketchPlugin_ConstraintMiddle::ID(), aHasSketchPlane);
304       aMsg->setState(SketchPlugin_ConstraintMirror::ID(), aHasSketchPlane);
305       aMsg->setState(SketchPlugin_Fillet::ID(), aHasSketchPlane);
306       aMsg->setState(SketchPlugin_ConstraintAngle::ID(), aHasSketchPlane);
307       aMsg->setState(SketchPlugin_MultiRotation::ID(), aHasSketchPlane);
308       aMsg->setState(SketchPlugin_MultiTranslation::ID(), aHasSketchPlane);
309       aMsg->setState(SketchPlugin_Split::ID(), aHasSketchPlane);
310       aMsg->setState(SketchPlugin_Trim::ID(), aHasSketchPlane);
311       aMsg->setState(SketchPlugin_MacroArc::ID(), aHasSketchPlane);
312       aMsg->setState(SketchPlugin_MacroCircle::ID(), aHasSketchPlane);
313       aMsg->setState(SketchPlugin_ConstraintDistanceHorizontal::ID(), aHasSketchPlane);
314       aMsg->setState(SketchPlugin_ConstraintDistanceVertical::ID(), aHasSketchPlane);
315       // SketchRectangle is a python feature, so its ID is passed just as a string
316       aMsg->setState("SketchRectangle", aHasSketchPlane);
317     }
318   }
319   return aMsg;
320 }