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 #include <SketchPlugin_Plugin.h>
21 #include <SketchPlugin_Sketch.h>
22 #include <SketchPlugin_Line.h>
23 #include <SketchPlugin_Point.h>
24 #include <SketchPlugin_IntersectionPoint.h>
25 #include <SketchPlugin_Circle.h>
26 #include <SketchPlugin_Arc.h>
27 #include <SketchPlugin_Projection.h>
28 #include <SketchPlugin_ConstraintAngle.h>
29 #include <SketchPlugin_ConstraintCoincidence.h>
30 #include <SketchPlugin_ConstraintCoincidenceInternal.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 #include <SketchPlugin_SketchDrawer.h>
59 #include <SketcherPrs_Tools.h>
61 #include <Events_Loop.h>
62 #include <GeomDataAPI_Dir.h>
64 #include <ModelAPI_Session.h>
65 #include <ModelAPI_Document.h>
66 #include <ModelAPI_Validator.h>
67 #include <ModelAPI_Data.h>
69 #include <Config_PropManager.h>
78 #define SKETCH_ENTITY_COLOR "225,0,0"
79 #define SKETCH_EXTERNAL_COLOR "170,0,225"
80 #define SKETCH_AUXILIARY_COLOR "0,85,0"
81 #define SKETCH_OVERCONSTRAINT_COLOR "255,0,0"
82 #define SKETCH_FULLY_CONSTRAINED_COLOR "0,150,0"
84 //#define SET_PLANES_COLOR_IN_PREFERENCES
86 // the only created instance of this plugin
87 static SketchPlugin_Plugin* MY_SKETCH_INSTANCE = new SketchPlugin_Plugin();
89 SketchPlugin_Plugin::SketchPlugin_Plugin()
91 SessionPtr aMgr = ModelAPI_Session::get();
92 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
93 aFactory->registerValidator("SketchPlugin_DistanceAttr",
94 new SketchPlugin_DistanceAttrValidator);
95 aFactory->registerValidator("SketchPlugin_ExternalValidator",
96 new SketchPlugin_ExternalValidator);
97 aFactory->registerValidator("SketchPlugin_TangentAttr",
98 new SketchPlugin_TangentAttrValidator);
99 aFactory->registerValidator("SketchPlugin_PerpendicularAttr",
100 new SketchPlugin_PerpendicularAttrValidator);
101 aFactory->registerValidator("SketchPlugin_NotFixed",
102 new SketchPlugin_NotFixedValidator);
103 aFactory->registerValidator("SketchPlugin_EqualAttr",
104 new SketchPlugin_EqualAttrValidator);
105 aFactory->registerValidator("SketchPlugin_MirrorAttr",
106 new SketchPlugin_MirrorAttrValidator);
107 aFactory->registerValidator("SketchPlugin_CoincidenceAttr",
108 new SketchPlugin_CoincidenceAttrValidator);
109 aFactory->registerValidator("SketchPlugin_CopyValidator",
110 new SketchPlugin_CopyValidator);
111 aFactory->registerValidator("SketchPlugin_SolverErrorValidator",
112 new SketchPlugin_SolverErrorValidator);
113 aFactory->registerValidator("SketchPlugin_FilletVertexValidator",
114 new SketchPlugin_FilletVertexValidator);
115 aFactory->registerValidator("SketchPlugin_SplitValidator",
116 new SketchPlugin_SplitValidator);
117 aFactory->registerValidator("SketchPlugin_TrimValidator",
118 new SketchPlugin_TrimValidator);
119 aFactory->registerValidator("SketchPlugin_MiddlePointAttr",
120 new SketchPlugin_MiddlePointAttrValidator);
121 aFactory->registerValidator("SketchPlugin_ArcTangentPoint",
122 new SketchPlugin_ArcTangentPointValidator);
123 aFactory->registerValidator("SketchPlugin_ArcTransversalPoint",
124 new SketchPlugin_ArcTransversalPointValidator);
125 aFactory->registerValidator("SketchPlugin_IntersectionValidator",
126 new SketchPlugin_IntersectionValidator);
127 aFactory->registerValidator("SketchPlugin_ProjectionValidator",
128 new SketchPlugin_ProjectionValidator);
129 aFactory->registerValidator("SketchPlugin_DifferentReference",
130 new SketchPlugin_DifferentReferenceValidator);
131 aFactory->registerValidator("SketchPlugin_DifferentPointReference",
132 new SketchPlugin_DifferentPointReferenceValidator);
133 aFactory->registerValidator("SketchPlugin_CirclePassedPointValidator",
134 new SketchPlugin_CirclePassedPointValidator);
135 aFactory->registerValidator("SketchPlugin_ThirdPointValidator",
136 new SketchPlugin_ThirdPointValidator);
137 aFactory->registerValidator("SketchPlugin_ArcEndPointValidator",
138 new SketchPlugin_ArcEndPointValidator);
139 aFactory->registerValidator("SketchPlugin_ArcEndPointIntersectionValidator",
140 new SketchPlugin_ArcEndPointIntersectionValidator);
141 aFactory->registerValidator("SketchPlugin_HasNoConstraint", new SketchPlugin_HasNoConstraint);
142 aFactory->registerValidator("SketchPlugin_ReplicationReference",
143 new SketchPlugin_ReplicationReferenceValidator);
144 aFactory->registerValidator("SketchPlugin_SketchFeatureValidator",
145 new SketchPlugin_SketchFeatureValidator);
146 aFactory->registerValidator("SketchPlugin_MultiRotationAngleValidator",
147 new SketchPlugin_MultiRotationAngleValidator);
149 // register this plugin
150 ModelAPI_Session::get()->registerPlugin(this);
152 Config_PropManager::registerProp("Visualization", "sketch_entity_color",
153 "Sketch entity color",
154 Config_Prop::Color, SKETCH_ENTITY_COLOR);
156 Config_PropManager::registerProp("Visualization", "sketch_external_color",
157 "Sketch external entity color",
158 Config_Prop::Color, SKETCH_EXTERNAL_COLOR);
160 Config_PropManager::registerProp("Visualization", "sketch_auxiliary_color",
161 "Sketch auxiliary entity color",
162 Config_Prop::Color, SKETCH_AUXILIARY_COLOR);
164 Config_PropManager::registerProp("Visualization", "sketch_overconstraint_color",
165 "Sketch overconstraint color",
166 Config_Prop::Color, SKETCH_OVERCONSTRAINT_COLOR);
168 Config_PropManager::registerProp("Visualization", "sketch_fully_constrained_color",
169 "Sketch fully constrained color",
170 Config_Prop::Color, SKETCH_FULLY_CONSTRAINED_COLOR);
172 // register sketcher properties
173 #ifdef SET_PLANES_COLOR_IN_PREFERENCES
174 Config_PropManager::registerProp("Visualization", "yz_plane_color", "YZ plane color",
175 Config_Prop::Color, YZ_PLANE_COLOR);
176 Config_PropManager::registerProp("Visualization", "xz_plane_color", "XZ plane color",
177 Config_Prop::Color, XZ_PLANE_COLOR);
178 Config_PropManager::registerProp("Visualization", "xy_plane_color", "XY plane color",
179 Config_Prop::Color, XY_PLANE_COLOR);
184 FeaturePtr SketchPlugin_Plugin::createFeature(std::string theFeatureID)
186 if (theFeatureID == SketchPlugin_Sketch::ID()) {
187 return FeaturePtr(new SketchPlugin_Sketch);
188 } else if (theFeatureID == SketchPlugin_Point::ID()) {
189 return FeaturePtr(new SketchPlugin_Point);
190 } else if (theFeatureID == SketchPlugin_IntersectionPoint::ID()) {
191 return FeaturePtr(new SketchPlugin_IntersectionPoint);
192 } else if (theFeatureID == SketchPlugin_Line::ID()) {
193 return FeaturePtr(new SketchPlugin_Line);
194 } else if (theFeatureID == SketchPlugin_Circle::ID()) {
195 return FeaturePtr(new SketchPlugin_Circle);
196 } else if (theFeatureID == SketchPlugin_Arc::ID()) {
197 return FeaturePtr(new SketchPlugin_Arc);
198 } else if (theFeatureID == SketchPlugin_Projection::ID()) {
199 return FeaturePtr(new SketchPlugin_Projection);
200 } else if (theFeatureID == SketchPlugin_ConstraintCoincidence::ID()) {
201 return FeaturePtr(new SketchPlugin_ConstraintCoincidence);
202 } else if (theFeatureID == SketchPlugin_ConstraintCoincidenceInternal::ID()) {
203 return FeaturePtr(new SketchPlugin_ConstraintCoincidenceInternal);
204 } else if (theFeatureID == SketchPlugin_ConstraintCollinear::ID()) {
205 return FeaturePtr(new SketchPlugin_ConstraintCollinear);
206 } else if (theFeatureID == SketchPlugin_ConstraintDistance::ID()) {
207 return FeaturePtr(new SketchPlugin_ConstraintDistance);
208 } else if (theFeatureID == SketchPlugin_ConstraintDistanceHorizontal::ID()) {
209 return FeaturePtr(new SketchPlugin_ConstraintDistanceHorizontal);
210 } else if (theFeatureID == SketchPlugin_ConstraintDistanceVertical::ID()) {
211 return FeaturePtr(new SketchPlugin_ConstraintDistanceVertical);
212 } else if (theFeatureID == SketchPlugin_ConstraintLength::ID()) {
213 return FeaturePtr(new SketchPlugin_ConstraintLength);
214 } else if (theFeatureID == SketchPlugin_ConstraintParallel::ID()) {
215 return FeaturePtr(new SketchPlugin_ConstraintParallel);
216 } else if (theFeatureID == SketchPlugin_ConstraintPerpendicular::ID()) {
217 return FeaturePtr(new SketchPlugin_ConstraintPerpendicular);
218 } else if (theFeatureID == SketchPlugin_ConstraintRadius::ID()) {
219 return FeaturePtr(new SketchPlugin_ConstraintRadius);
220 } else if (theFeatureID == SketchPlugin_ConstraintRigid::ID()) {
221 return FeaturePtr(new SketchPlugin_ConstraintRigid);
222 } else if (theFeatureID == SketchPlugin_ConstraintHorizontal::ID()) {
223 return FeaturePtr(new SketchPlugin_ConstraintHorizontal);
224 } else if (theFeatureID == SketchPlugin_ConstraintVertical::ID()) {
225 return FeaturePtr(new SketchPlugin_ConstraintVertical);
226 } else if (theFeatureID == SketchPlugin_ConstraintEqual::ID()) {
227 return FeaturePtr(new SketchPlugin_ConstraintEqual);
228 } else if (theFeatureID == SketchPlugin_ConstraintTangent::ID()) {
229 return FeaturePtr(new SketchPlugin_ConstraintTangent);
230 } else if (theFeatureID == SketchPlugin_ConstraintMiddle::ID()) {
231 return FeaturePtr(new SketchPlugin_ConstraintMiddle);
232 } else if (theFeatureID == SketchPlugin_ConstraintMirror::ID()) {
233 return FeaturePtr(new SketchPlugin_ConstraintMirror);
234 } else if (theFeatureID == SketchPlugin_Fillet::ID()) {
235 return FeaturePtr(new SketchPlugin_Fillet);
236 } else if (theFeatureID == SketchPlugin_MultiTranslation::ID()) {
237 return FeaturePtr(new SketchPlugin_MultiTranslation);
238 } else if (theFeatureID == SketchPlugin_MultiRotation::ID()) {
239 return FeaturePtr(new SketchPlugin_MultiRotation);
240 } else if (theFeatureID == SketchPlugin_ConstraintAngle::ID()) {
241 return FeaturePtr(new SketchPlugin_ConstraintAngle);
242 } else if (theFeatureID == SketchPlugin_Split::ID()) {
243 return FeaturePtr(new SketchPlugin_Split);
244 } else if (theFeatureID == SketchPlugin_Trim::ID()) {
245 return FeaturePtr(new SketchPlugin_Trim);
246 } else if (theFeatureID == SketchPlugin_MacroArc::ID()) {
247 return FeaturePtr(new SketchPlugin_MacroArc);
248 } else if (theFeatureID == SketchPlugin_MacroCircle::ID()) {
249 return FeaturePtr(new SketchPlugin_MacroCircle);
250 } else if (theFeatureID == SketchPlugin_Ellipse::ID()) {
251 return FeaturePtr(new SketchPlugin_Ellipse);
252 } else if (theFeatureID == SketchPlugin_MacroEllipse::ID()) {
253 return FeaturePtr(new SketchPlugin_MacroEllipse);
254 } else if (theFeatureID == SketchPlugin_SketchDrawer::ID()) {
255 return FeaturePtr(new SketchPlugin_SketchDrawer);
257 // feature of such kind is not found
262 void SketchPlugin_Plugin::processEvent(const std::shared_ptr<Events_Message>& theMessage)
264 const Events_ID kRequestEvent =
265 Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
266 if (theMessage->eventID() == kRequestEvent) {
267 std::shared_ptr<ModelAPI_FeatureStateMessage> aStateMessage =
268 std::dynamic_pointer_cast<ModelAPI_FeatureStateMessage>(theMessage);
269 Events_Loop::loop()->send(getFeaturesState(aStateMessage->feature()), false);
273 std::shared_ptr<ModelAPI_FeatureStateMessage> SketchPlugin_Plugin
274 ::getFeaturesState(const std::shared_ptr<ModelAPI_Feature>& theFeature) const
276 const Events_ID kResponseEvent = Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_RESPONSE);
277 std::shared_ptr<ModelAPI_FeatureStateMessage> aMsg(
278 new ModelAPI_FeatureStateMessage(kResponseEvent, this));
280 bool aHasSketchPlane = false;
281 std::shared_ptr<SketchPlugin_Sketch> aSketchFeature =
282 std::dynamic_pointer_cast<SketchPlugin_Sketch>(theFeature);
283 if (aSketchFeature.get()) {
284 std::shared_ptr<ModelAPI_Data> aData = aSketchFeature->data();
286 std::shared_ptr<GeomDataAPI_Dir> aNormal =
287 std::dynamic_pointer_cast<GeomDataAPI_Dir>(
288 aData->attribute(SketchPlugin_Sketch::NORM_ID()));
289 // it is important to check whether the normal attribute is initialized
290 // because it is possible that normal values are filled when the plane is checked on validity
291 aHasSketchPlane = aNormal && aNormal->isInitialized() &&
292 !(aNormal->x() == 0 && aNormal->y() == 0 && aNormal->z() == 0);
294 aMsg->setState(SketchPlugin_Point::ID(), aHasSketchPlane);
295 aMsg->setState(SketchPlugin_IntersectionPoint::ID(), aHasSketchPlane);
296 aMsg->setState(SketchPlugin_Line::ID(), aHasSketchPlane);
297 aMsg->setState(SketchPlugin_Circle::ID(), aHasSketchPlane);
298 aMsg->setState(SketchPlugin_Arc::ID(), aHasSketchPlane);
299 aMsg->setState(SketchPlugin_Ellipse::ID(), aHasSketchPlane);
300 aMsg->setState(SketchPlugin_Projection::ID(), aHasSketchPlane);
301 aMsg->setState(SketchPlugin_ConstraintCoincidence::ID(), aHasSketchPlane);
302 aMsg->setState(SketchPlugin_ConstraintCoincidenceInternal::ID(), aHasSketchPlane);
303 aMsg->setState(SketchPlugin_ConstraintCollinear::ID(), aHasSketchPlane);
304 aMsg->setState(SketchPlugin_ConstraintDistance::ID(), aHasSketchPlane);
305 aMsg->setState(SketchPlugin_ConstraintLength::ID(), aHasSketchPlane);
306 aMsg->setState(SketchPlugin_ConstraintParallel::ID(), aHasSketchPlane);
307 aMsg->setState(SketchPlugin_ConstraintPerpendicular::ID(), aHasSketchPlane);
308 aMsg->setState(SketchPlugin_ConstraintRadius::ID(), aHasSketchPlane);
309 aMsg->setState(SketchPlugin_ConstraintRigid::ID(), aHasSketchPlane);
310 aMsg->setState(SketchPlugin_ConstraintHorizontal::ID(), aHasSketchPlane);
311 aMsg->setState(SketchPlugin_ConstraintVertical::ID(), aHasSketchPlane);
312 aMsg->setState(SketchPlugin_ConstraintEqual::ID(), aHasSketchPlane);
313 aMsg->setState(SketchPlugin_ConstraintTangent::ID(), aHasSketchPlane);
314 aMsg->setState(SketchPlugin_ConstraintMiddle::ID(), aHasSketchPlane);
315 aMsg->setState(SketchPlugin_ConstraintMirror::ID(), aHasSketchPlane);
316 aMsg->setState(SketchPlugin_Fillet::ID(), aHasSketchPlane);
317 aMsg->setState(SketchPlugin_ConstraintAngle::ID(), aHasSketchPlane);
318 aMsg->setState(SketchPlugin_MultiRotation::ID(), aHasSketchPlane);
319 aMsg->setState(SketchPlugin_MultiTranslation::ID(), aHasSketchPlane);
320 aMsg->setState(SketchPlugin_Split::ID(), aHasSketchPlane);
321 aMsg->setState(SketchPlugin_Trim::ID(), aHasSketchPlane);
322 aMsg->setState(SketchPlugin_MacroArc::ID(), aHasSketchPlane);
323 aMsg->setState(SketchPlugin_MacroCircle::ID(), aHasSketchPlane);
324 aMsg->setState(SketchPlugin_MacroEllipse::ID(), aHasSketchPlane);
325 aMsg->setState(SketchPlugin_ConstraintDistanceHorizontal::ID(), aHasSketchPlane);
326 aMsg->setState(SketchPlugin_ConstraintDistanceVertical::ID(), aHasSketchPlane);
327 // SketchRectangle is a python feature, so its ID is passed just as a string
328 aMsg->setState("SketchRectangle", aHasSketchPlane);