1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef MODELAPI_EVENTS_H_
22 #define MODELAPI_EVENTS_H_
25 #include <ModelAPI_Object.h>
26 #include <ModelAPI_Feature.h>
27 #include <ModelAPI_Attribute.h>
28 #include <Events_MessageGroup.h>
29 #include <Events_Loop.h>
37 class ModelAPI_Document;
38 class ModelAPI_ResultParameter;
40 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
41 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
42 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
43 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
44 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
45 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
46 /// Event ID that name of feature is changed (comes with Model_ObjectRenamedMessage)
47 static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
48 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
49 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
50 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
51 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
52 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
53 static const char * EVENT_PLUGIN_LOADED = "PluginLoaded";
54 /// The active document becomes another one
55 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
57 /// Event ID that order of objects in group is changed,
58 /// so, tree must be fully rectreated (movement of feature)
59 static const char * EVENT_ORDER_UPDATED = "OrderUpdated";
60 /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
61 static const char * EVENT_UPDATE_SELECTION = "UpdateSelection";
63 /// Request for the enabled/disabled actions behavior for some specific features
64 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
65 /// Reply for the enabled/disabled actions behavior for some specific features
66 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
68 /// To block the viewer updates
69 static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
70 /// To unblock the viewer updates
71 static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
73 /// To inform that there is an empty presentation in the viewer
74 static const char * EVENT_EMPTY_AIS_PRESENTATION = "EmptyAISPresentation";
75 /// To inform that there is an empty operation for presentation in the viewer
76 static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresentation";
78 static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked";
79 /// To preview the current feature in the viewer (to compute the result)
80 static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested";
82 /// Event ID that solver has conflicting constraints (comes with ModelAPI_SolverFailedMessage)
83 static const char * EVENT_SOLVER_FAILED = "SolverFailed";
84 /// Event ID that the problem in solver disappeared
85 static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired";
87 /// Event Id that sketch has DoF = 0
88 static const char * EVENT_SKETCH_FULLY_CONSTRAINED = "SketchFullyConstrainted";
89 /// Event Id that sketch has DoF > 0
90 static const char * EVENT_SKETCH_UNDER_CONSTRAINED = "SketchUnderConstrainted";
91 /// Event Id that sketch has DoF < 0
92 static const char * EVENT_SKETCH_OVER_CONSTRAINED = "SketchOverConstrainted";
94 /// Event ID that informs that some object has changed the stability
95 static const char * EVENT_STABILITY_CHANGED = "StabilityChanged";
97 /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
98 static const char * EVENT_SKETCH_PREPARED = "SketchPrepared";
100 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
101 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
104 /// Creates an empty message
105 ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
106 /// The virtual destructor
107 virtual ~ModelAPI_ObjectUpdatedMessage();
110 /// Returns the feature that has been updated
111 virtual const std::set<ObjectPtr>& objects() const = 0;
113 //! Creates a new empty group (to store it in the loop before flush)
114 virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
116 //! Allows to join the given message with the current one
117 virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
120 /// Message that feature was deleted (used for Object Browser update)
121 class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
124 /// Creates an empty message
125 ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
126 /// The virtual destructor
127 virtual ~ModelAPI_ObjectDeletedMessage();
130 /// Returns the document that has been updated
131 virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
133 /// Returns the groups where the objects were deleted
134 virtual const std::set<std::string>& groups() const = 0;
136 /// Creates the new empty message of this kind
137 virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
139 /// Returns the identifier of the kind of a message
140 virtual const Events_ID messageId() = 0;
142 /// Appenad to this message the given one.
143 virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
146 /// Message that order changed (used for Object Browser update)
147 class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
150 /// Creates a message:
151 ModelAPI_OrderUpdatedMessage(const Events_ID theID, const void* theSender = 0);
152 /// The virtual destructor
153 virtual ~ModelAPI_OrderUpdatedMessage();
156 /// Returns the document that has been updated
157 virtual std::shared_ptr<ModelAPI_Feature> reordered() = 0;
159 /// Returns the identifier of the kind of a message
160 virtual const Events_ID messageId() = 0;
163 /// Allows to create ModelAPI messages
164 class MODELAPI_EXPORT ModelAPI_EventCreator
167 /// creates created, updated or moved messages and sends to the loop
168 virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
169 const bool isGroupped = true) const = 0;
170 /// creates deleted message and sends to the loop
171 virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
172 const std::string& theGroup) const = 0;
173 /// creates reordered message and sends to the loop
174 virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const = 0;
176 /// returns the creator instance
177 static const ModelAPI_EventCreator* get();
179 /// sets the creator instance
180 static void set(const ModelAPI_EventCreator* theCreator);
183 // TODO(sbh): Move this message into a separate package, like "GuiAPI"
184 /// Contains the state information about the feature: is it enabled or disabled.
185 class ModelAPI_FeatureStateMessage : public Events_Message
188 /// Creates an empty message
189 MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
190 /// The virtual destructor
191 MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
193 /// Returns the feature this message is related to
194 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
195 /// Stores the feature this message is related to
196 MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
198 /// Returns true if feature has specific state
199 MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
200 /// Returns true if feature is enabled
201 MODELAPI_EXPORT bool state(const std::string& theFeatureId, bool theDefault = false) const;
202 /// Stores the feature state
203 MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
204 /// Returns all feature IDs with states
205 MODELAPI_EXPORT std::list<std::string> features() const;
209 std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
211 std::map<std::string, bool> myFeatureState;
214 /// Message that document (Part, PartSet) was created
215 class ModelAPI_DocumentCreatedMessage : public Events_Message
217 DocumentPtr myDocument;
220 /// Creates an empty message
221 MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0);
222 /// The virtual destructor
223 MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage();
224 /// Static. Returns EventID of the message.
225 MODELAPI_EXPORT static Events_ID eventId()
227 static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated");
228 return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID);
231 /// Returns a document stored in the message
232 MODELAPI_EXPORT DocumentPtr document() const;
233 /// Sets a document to the message
234 MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
237 /// Message that attribute text should be evaluated in the attribute value
238 class ModelAPI_AttributeEvalMessage : public Events_Message
240 AttributePtr myAttribute;
243 /// Static. Returns EventID of the message.
244 MODELAPI_EXPORT static Events_ID& eventId()
246 static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest");
247 static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID);
251 /// Useful method that creates and sends the AttributeEvalMessage event
252 MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender)
254 std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
255 std::shared_ptr<ModelAPI_AttributeEvalMessage>(
256 new ModelAPI_AttributeEvalMessage(eventId(), theSender));
257 aMessage->setAttribute(theAttribute);
258 Events_Loop::loop()->send(aMessage);
261 /// Creates an empty message
262 MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0);
263 /// The virtual destructor
264 MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage();
266 /// Returns a document stored in the message
267 MODELAPI_EXPORT AttributePtr attribute() const;
268 /// Sets an attribute to the message
269 MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute);
272 /// Message that parameter feature expression should be evaluated: value and error producing
273 class ModelAPI_ParameterEvalMessage : public Events_Message
275 FeaturePtr myParam; ///< parameters that should be evaluated
276 bool myIsProcessed; ///< true if results were set
277 /// result of processing, list of parameters in expression found
278 std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
279 double myResult; ///< result of processing, the computed value of the expression
280 std::string myError; ///< error of processing, empty if there is no error
283 /// Static. Returns EventID of the message.
284 MODELAPI_EXPORT static Events_ID& eventId()
286 static const char * MY_PARAMETER_EVALUATION_EVENT_ID("ParameterEvaluationRequest");
287 static Events_ID anId = Events_Loop::eventByName(MY_PARAMETER_EVALUATION_EVENT_ID);
291 /// Useful method that creates and sends the event.
292 /// Returns the message, processed, with the resulting fields filled.
293 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ParameterEvalMessage>
294 send(FeaturePtr theParameter, const void* theSender)
296 std::shared_ptr<ModelAPI_ParameterEvalMessage> aMessage =
297 std::shared_ptr<ModelAPI_ParameterEvalMessage>(
298 new ModelAPI_ParameterEvalMessage(eventId(), theSender));
299 aMessage->setParameter(theParameter);
300 Events_Loop::loop()->send(aMessage);
304 /// Creates an empty message
305 MODELAPI_EXPORT ModelAPI_ParameterEvalMessage(const Events_ID theID, const void* theSender = 0);
306 /// The virtual destructor
307 MODELAPI_EXPORT virtual ~ModelAPI_ParameterEvalMessage();
309 /// Returns a parameter stored in the message
310 MODELAPI_EXPORT FeaturePtr parameter() const;
311 /// Sets a parameter to the message
312 MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
313 /// Sets the results of processing
314 MODELAPI_EXPORT void setResults(
315 const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
316 const double theResult, const std::string& theError);
317 /// Returns true if the expression is processed
318 MODELAPI_EXPORT bool isProcessed();
319 /// Returns the results of processing: list of parameters found in the expression
320 MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
321 /// Returns the expression result
322 MODELAPI_EXPORT const double& result() const;
323 /// Returns the interpreter error (empty if no error)
324 MODELAPI_EXPORT const std::string& error() const;
328 /// Message to ask compute the positions of parameters in the expression
329 class ModelAPI_ComputePositionsMessage : public Events_Message
331 std::string myExpression; ///< the expression string
332 std::string myParamName; ///< name of the parameter to be searched
333 std::list<std::pair<int, int> > myPositions; ///< computation result: start-end position indices
336 /// Static. Returns EventID of the message.
337 MODELAPI_EXPORT static Events_ID& eventId()
339 static const char * MY_COMPUTE_POSITIOND_EVENT_ID("ComputePositionsRequest");
340 static Events_ID anId = Events_Loop::eventByName(MY_COMPUTE_POSITIOND_EVENT_ID);
344 /// Useful method that creates and sends the AttributeEvalMessage event
345 /// Returns the message, processed, with the resulting fields filled
346 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ComputePositionsMessage>
347 send(const std::string& theExpression, const std::string& theParameter, const void* theSender)
349 std::shared_ptr<ModelAPI_ComputePositionsMessage> aMessage =
350 std::shared_ptr<ModelAPI_ComputePositionsMessage>(
351 new ModelAPI_ComputePositionsMessage(eventId(), theSender));
352 aMessage->set(theExpression, theParameter);
353 Events_Loop::loop()->send(aMessage);
357 /// Creates an empty message
358 MODELAPI_EXPORT ModelAPI_ComputePositionsMessage(
359 const Events_ID theID, const void* theSender = 0);
360 /// The virtual destructor
361 MODELAPI_EXPORT virtual ~ModelAPI_ComputePositionsMessage();
363 /// Returns an expression stored in the message
364 MODELAPI_EXPORT const std::string& expression() const;
365 /// Returns a parameter name stored in the message
366 MODELAPI_EXPORT const std::string& parameter() const;
367 /// Sets an expression and parameter needed for computation
368 MODELAPI_EXPORT void set(const std::string& theExpression, const std::string& theParameter);
369 /// Sets the results of processing
370 MODELAPI_EXPORT void setPositions(const std::list<std::pair<int, int> >& thePositions);
371 /// Returns the results of processing: position start and end indices
372 MODELAPI_EXPORT const std::list<std::pair<int, int> >& positions() const;
375 /// Message that the object is renamed
376 class ModelAPI_ObjectRenamedMessage : public Events_Message
379 std::string myOldName;
380 std::string myNewName;
383 /// Static. Returns EventID of the message.
384 MODELAPI_EXPORT static Events_ID& eventId()
386 static const char * MY_OBJECT_RENAMED_EVENT_ID("ObjectRenamed");
387 static Events_ID anId = Events_Loop::eventByName(MY_OBJECT_RENAMED_EVENT_ID);
391 /// Useful method that creates and sends the AttributeEvalMessage event
392 MODELAPI_EXPORT static void send(ObjectPtr theObject,
393 const std::string& theOldName,
394 const std::string& theNewName,
395 const void* theSender);
397 /// Creates an empty message
398 MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
399 /// The virtual destructor
400 MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
402 /// Returns an object
403 MODELAPI_EXPORT ObjectPtr object() const;
405 MODELAPI_EXPORT void setObject(ObjectPtr theObject);
406 /// Returns an old name
407 MODELAPI_EXPORT std::string oldName() const;
409 MODELAPI_EXPORT void setOldName(const std::string& theOldName);
410 /// Returns a new name
411 MODELAPI_EXPORT std::string newName() const;
413 MODELAPI_EXPORT void setNewName(const std::string& theNewName);
416 /// Message that the parameter should be replaced with its value
417 class ModelAPI_ReplaceParameterMessage : public Events_Message
422 /// Static. Returns EventID of the message.
423 MODELAPI_EXPORT static Events_ID& eventId()
425 static const char * MY_EVENT_ID("ReplaceParameter");
426 static Events_ID anId = Events_Loop::eventByName(MY_EVENT_ID);
430 /// Useful method that creates and sends the AttributeEvalMessage event
431 MODELAPI_EXPORT static void send(ObjectPtr theObject,
432 const void* theSender);
434 /// Creates an empty message
436 ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
437 /// The virtual destructor
438 MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
440 /// Returns an object
441 MODELAPI_EXPORT ObjectPtr object() const;
443 MODELAPI_EXPORT void setObject(ObjectPtr theObject);
446 /// Message that sends the sketch solver and sketcher GUI processes to show in the property panel
447 class ModelAPI_SolverFailedMessage : public Events_Message
450 /// Creates an message
451 MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
452 /// Default destructor
453 MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
455 /// Sets list of conflicting constraints
456 MODELAPI_EXPORT void setObjects(const std::set<ObjectPtr>& theObjects);
457 /// Returns list of conflicting constraints
458 MODELAPI_EXPORT const std::set<ObjectPtr>& objects() const;
460 /// Sets degrees of freedom
461 void dof(const int theDOF) { myDOF = theDOF; }
462 /// Returns degrees of freedom
463 const int& dof() const { return myDOF; }
466 std::set<ObjectPtr> myObjects;