1 // Copyright (C) 2014-2022 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 MODELAPI_EVENTS_H_
21 #define MODELAPI_EVENTS_H_
24 #include <ModelAPI_Object.h>
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_Attribute.h>
27 #include <Events_MessageGroup.h>
28 #include <Events_Loop.h>
36 class ModelAPI_Document;
37 class ModelAPI_ResultParameter;
41 #if defined __GNUC__ || defined __clang__
42 #define MAYBE_UNUSED __attribute__((unused))
47 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
48 MAYBE_UNUSED static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
49 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
50 MAYBE_UNUSED static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
51 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
52 MAYBE_UNUSED static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
53 /// Event ID that name of feature is changed (comes with Model_ObjectRenamedMessage)
54 MAYBE_UNUSED static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
55 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
56 MAYBE_UNUSED static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
57 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
58 MAYBE_UNUSED static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
59 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
60 MAYBE_UNUSED static const char * EVENT_PLUGIN_LOADED = "PluginLoaded";
61 /// The active document becomes another one
62 MAYBE_UNUSED static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
64 /// Event ID that order of objects in group is changed,
65 /// so, tree must be fully recreated (movement of feature)
66 MAYBE_UNUSED static const char * EVENT_ORDER_UPDATED = "OrderUpdated";
67 /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
68 MAYBE_UNUSED static const char * EVENT_UPDATE_SELECTION = "UpdateSelection";
70 /// Request for the enabled/disabled actions behavior for some specific features
71 MAYBE_UNUSED static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
72 /// Reply for the enabled/disabled actions behavior for some specific features
73 MAYBE_UNUSED static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
75 /// To block the viewer updates
76 MAYBE_UNUSED static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
77 /// To unblock the viewer updates
78 MAYBE_UNUSED static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
80 /// To inform that there is an empty presentation in the viewer
81 MAYBE_UNUSED static const char * EVENT_EMPTY_AIS_PRESENTATION = "EmptyAISPresentation";
82 /// To inform that there is an empty operation for presentation in the viewer
83 MAYBE_UNUSED static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresentation";
85 MAYBE_UNUSED static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked";
86 /// To preview the current feature in the viewer (to compute the result)
87 MAYBE_UNUSED static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested";
88 /// To block automatic recomputation of any feature (by the GUI button press)
89 MAYBE_UNUSED static const char * EVENT_AUTOMATIC_RECOMPUTATION_DISABLE
90 = "DisableAutomaticRecomputation";
91 /// To unblock block automatic recomputation (default state: the GUI button unpressed)
92 MAYBE_UNUSED static const char * EVENT_AUTOMATIC_RECOMPUTATION_ENABLE
93 = "EnableAutomaticRecomputation";
95 /// Event ID that solver has conflicting constraints (comes with ModelAPI_SolverFailedMessage)
96 MAYBE_UNUSED static const char * EVENT_SOLVER_FAILED = "SolverFailed";
97 /// Event ID that the problem in solver disappeared
98 MAYBE_UNUSED static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired";
100 /// Event Id that sketch has DoF = 0
101 MAYBE_UNUSED static const char * EVENT_SKETCH_FULLY_CONSTRAINED = "SketchFullyConstrainted";
102 /// Event Id that sketch has DoF > 0
103 MAYBE_UNUSED static const char * EVENT_SKETCH_UNDER_CONSTRAINED = "SketchUnderConstrainted";
104 /// Event Id that sketch has DoF < 0
105 MAYBE_UNUSED static const char * EVENT_SKETCH_OVER_CONSTRAINED = "SketchOverConstrainted";
107 /// Event ID that informs that some object has changed the stability
108 MAYBE_UNUSED static const char * EVENT_STABILITY_CHANGED = "StabilityChanged";
110 /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
111 MAYBE_UNUSED static const char * EVENT_SKETCH_PREPARED = "SketchPrepared";
113 /// Event ID that provides a request for list of non-fixed objects necessary for DoF = 0
114 MAYBE_UNUSED static const char * EVENT_GET_DOF_OBJECTS = "GetDoFObjects";
116 /// Event ID that provides a request for list of non-fixed objects necessary for DoF = 0
117 MAYBE_UNUSED static const char * EVENT_DOF_OBJECTS = "DoFObjects";
119 /// Event ID that requests updates visual attributes for presentations
120 MAYBE_UNUSED static const char * EVENT_VISUAL_ATTRIBUTES = "UpdateVisualAttributes";
122 /// Event ID that 1D-fillet failed (comes with ModelAPI_ShapesFailedMessage)
123 MAYBE_UNUSED static const char * EVENT_OPERATION_SHAPES_FAILED = "OperationShapesFailed";
125 MAYBE_UNUSED static const char * EVENT_CHECK_CONSTRAINTS = "CheckConstrains";
127 MAYBE_UNUSED static const char * EVENT_REMOVE_CONSTRAINTS = "RemoveConstrains";
129 /// Event ID that license of specified features is checked and valid
130 MAYBE_UNUSED static const char * EVENT_FEATURE_LICENSE_VALID = "FeaturesLicenseValid";
132 /// To send preferences information: create part on init or not
133 MAYBE_UNUSED static const char * EVENT_CREATE_PART_ON_START = "CreatePartOnStart";
136 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
137 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
140 /// Creates an empty message
141 ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
142 /// The virtual destructor
143 virtual ~ModelAPI_ObjectUpdatedMessage();
146 /// Returns the feature that has been updated
147 virtual const std::set<ObjectPtr>& objects() const = 0;
149 //! Creates a new empty group (to store it in the loop before flush)
150 virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
152 //! Allows to join the given message with the current one
153 virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
156 /// Message that feature was deleted (used for Object Browser update)
157 class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
160 /// Creates an empty message
161 ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
162 /// The virtual destructor
163 virtual ~ModelAPI_ObjectDeletedMessage();
166 /// Returns the groups where the objects were deleted
167 virtual const std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> >&
170 /// Creates the new empty message of this kind
171 virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
173 /// Returns the identifier of the kind of a message
174 virtual const Events_ID messageId() = 0;
176 /// Appends to this message the given one.
177 virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
180 /// Message that order changed (used for Object Browser update)
181 class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
184 /// Creates a message:
185 ModelAPI_OrderUpdatedMessage(const Events_ID theID, const void* theSender = 0);
186 /// The virtual destructor
187 virtual ~ModelAPI_OrderUpdatedMessage();
190 /// Returns the document that has been updated
191 virtual std::shared_ptr<ModelAPI_Feature> reordered() = 0;
193 /// Returns the identifier of the kind of a message
194 virtual const Events_ID messageId() = 0;
197 /// Allows to create ModelAPI messages
198 class MODELAPI_EXPORT ModelAPI_EventCreator
201 virtual ~ModelAPI_EventCreator() {}
203 /// creates created, updated or moved messages and sends to the loop
204 virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
205 const bool isGroupped = true) const = 0;
206 /// creates created, updated or moved messages with the objects collection and sends to the loop
207 virtual void sendUpdated(const std::list<ObjectPtr>& theObjects, const Events_ID& theEvent,
208 const bool isGroupped = true) const = 0;
209 /// creates deleted message and sends to the loop
210 virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
211 const std::string& theGroup) const = 0;
212 /// creates reordered message and sends to the loop
213 virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const = 0;
215 /// returns the creator instance
216 static const ModelAPI_EventCreator* get();
218 /// sets the creator instance
219 static void set(const ModelAPI_EventCreator* theCreator);
222 /// Contains the state information about the feature: is it enabled or disabled.
223 class ModelAPI_FeatureStateMessage : public Events_Message
226 /// Creates an empty message
227 MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
228 /// The virtual destructor
229 MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
231 /// Returns the feature this message is related to
232 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
233 /// Stores the feature this message is related to
234 MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
236 /// Returns true if feature has specific state
237 MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
238 /// Returns true if feature is enabled
239 MODELAPI_EXPORT bool state(const std::string& theFeatureId, bool theDefault = false) const;
240 /// Stores the feature state
241 MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
242 /// Returns all feature IDs with states
243 MODELAPI_EXPORT std::list<std::string> features() const;
247 std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
249 std::map<std::string, bool> myFeatureState;
252 /// Message that document (Part, PartSet) was created
253 class ModelAPI_DocumentCreatedMessage : public Events_Message
255 DocumentPtr myDocument;
258 /// Creates an empty message
259 MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0);
260 /// The virtual destructor
261 MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage();
262 /// Static. Returns EventID of the message.
263 MODELAPI_EXPORT static Events_ID eventId()
265 static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated");
266 return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID);
269 /// Returns a document stored in the message
270 MODELAPI_EXPORT DocumentPtr document() const;
271 /// Sets a document to the message
272 MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
275 /// Message that attribute text should be evaluated in the attribute value
276 class ModelAPI_AttributeEvalMessage : public Events_Message
278 AttributePtr myAttribute;
281 /// Static. Returns EventID of the message.
282 MODELAPI_EXPORT static Events_ID& eventId()
284 static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest");
285 static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID);
289 /// Useful method that creates and sends the AttributeEvalMessage event
290 MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender)
292 std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
293 std::shared_ptr<ModelAPI_AttributeEvalMessage>(
294 new ModelAPI_AttributeEvalMessage(eventId(), theSender));
295 aMessage->setAttribute(theAttribute);
296 Events_Loop::loop()->send(aMessage);
299 /// Creates an empty message
300 MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0);
301 /// The virtual destructor
302 MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage();
304 /// Returns a document stored in the message
305 MODELAPI_EXPORT AttributePtr attribute() const;
306 /// Sets an attribute to the message
307 MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute);
310 /// Message that parameter feature expression should be evaluated: value and error producing
311 class ModelAPI_ParameterEvalMessage : public Events_Message
313 FeaturePtr myParam; ///< parameters that should be evaluated
314 bool myIsProcessed; ///< true if results were set
315 /// result of processing, list of parameters in expression found
316 std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
317 double myResult; ///< result of processing, the computed value of the expression
318 std::string myError; ///< error of processing, empty if there is no error
321 /// Static. Returns EventID of the message.
322 MODELAPI_EXPORT static Events_ID& eventId()
324 static const char * MY_PARAMETER_EVALUATION_EVENT_ID("ParameterEvaluationRequest");
325 static Events_ID anId = Events_Loop::eventByName(MY_PARAMETER_EVALUATION_EVENT_ID);
329 /// Useful method that creates and sends the event.
330 /// Returns the message, processed, with the resulting fields filled.
331 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ParameterEvalMessage>
332 send(FeaturePtr theParameter, const void* theSender)
334 std::shared_ptr<ModelAPI_ParameterEvalMessage> aMessage =
335 std::shared_ptr<ModelAPI_ParameterEvalMessage>(
336 new ModelAPI_ParameterEvalMessage(eventId(), theSender));
337 aMessage->setParameter(theParameter);
338 Events_Loop::loop()->send(aMessage);
342 /// Creates an empty message
343 MODELAPI_EXPORT ModelAPI_ParameterEvalMessage(const Events_ID theID, const void* theSender = 0);
344 /// The virtual destructor
345 MODELAPI_EXPORT virtual ~ModelAPI_ParameterEvalMessage();
347 /// Returns a parameter stored in the message
348 MODELAPI_EXPORT FeaturePtr parameter() const;
349 /// Sets a parameter to the message
350 MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
351 /// Sets the results of processing
352 MODELAPI_EXPORT void setResults(
353 const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
354 const double theResult, const std::string& theError);
355 /// Returns true if the expression is processed
356 MODELAPI_EXPORT bool isProcessed();
357 /// Returns the results of processing: list of parameters found in the expression
358 MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
359 /// Returns the expression result
360 MODELAPI_EXPORT const double& result() const;
361 /// Returns the interpreter error (empty if no error)
362 MODELAPI_EXPORT const std::string& error() const;
365 class ModelAPI_ImportParametersMessage : public Events_Message
367 std::string myFilename; ///< filename where where parameters are stored
368 std::string myError; ///< error of processing, empty if there is no error
371 /// Static. Returns EventID of the message.
372 MODELAPI_EXPORT static Events_ID& eventId()
374 static const char* MY_PARAMETER_EVALUATION_EVENT_ID("ImportParametersMessage");
375 static Events_ID anId = Events_Loop::eventByName(MY_PARAMETER_EVALUATION_EVENT_ID);
379 /// Useful method that creates and sends the event.
380 /// Returns the message, processed, with the resulting fields filled.
381 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ImportParametersMessage>
382 send(std::string theParameter, const void* theSender)
384 std::shared_ptr<ModelAPI_ImportParametersMessage> aMessage =
385 std::shared_ptr<ModelAPI_ImportParametersMessage>(
386 new ModelAPI_ImportParametersMessage(eventId(), theSender));
387 aMessage->setFilename(theParameter);
388 Events_Loop::loop()->send(aMessage);
392 /// Creates an empty message
393 MODELAPI_EXPORT ModelAPI_ImportParametersMessage(const Events_ID theID,
394 const void* theSender = 0);
395 /// The virtual destructor
396 MODELAPI_EXPORT virtual ~ModelAPI_ImportParametersMessage();
398 /// Returns a filename stored in the message
399 MODELAPI_EXPORT std::string filename() const;
400 /// Sets a filename to the message
401 MODELAPI_EXPORT void setFilename(std::string theFilename);
404 class ModelAPI_BuildEvalMessage : public Events_Message
406 FeaturePtr myParam; ///< parameters that should be evaluated
407 bool myIsProcessed; ///< true if results were set
408 std::string myError; ///< error of processing, empty if there is no error
409 /// result of processing, list of parameters in expression found
410 std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
413 /// Static. Returns EventID of the message.
414 MODELAPI_EXPORT static Events_ID& eventId()
416 static const char * MY_BUILD_EVALUATION_EVENT_ID("BuildEvaluationRequest");
417 static Events_ID anId = Events_Loop::eventByName(MY_BUILD_EVALUATION_EVENT_ID);
421 /// Useful method that creates and sends the event.
422 /// Returns the message, processed, with the resulting fields filled.
423 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_BuildEvalMessage>
424 send(FeaturePtr theParameter, const void* theSender)
426 std::shared_ptr<ModelAPI_BuildEvalMessage> aMessage =
427 std::shared_ptr<ModelAPI_BuildEvalMessage>(
428 new ModelAPI_BuildEvalMessage(eventId(), theSender));
429 aMessage->setParameter(theParameter);
430 Events_Loop::loop()->send(aMessage);
434 /// Creates an empty message
435 MODELAPI_EXPORT ModelAPI_BuildEvalMessage(const Events_ID theID, const void* theSender = 0);
436 /// The virtual destructor
437 MODELAPI_EXPORT virtual ~ModelAPI_BuildEvalMessage();
439 /// Returns a parameter stored in the message
440 MODELAPI_EXPORT FeaturePtr parameter() const;
441 /// Sets a parameter to the message
442 MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
443 /// Sets the results of processing
444 MODELAPI_EXPORT void setResults(
445 const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
446 const std::string& theError);
447 /// Returns the results of processing: list of parameters found in the expression
448 MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
449 /// Returns true if the expression is processed
450 MODELAPI_EXPORT bool isProcessed();
452 /// Returns the interpreter error (empty if no error)
453 MODELAPI_EXPORT const std::string& error() const;
456 /// Message to ask compute the positions of parameters in the expression
457 class ModelAPI_ComputePositionsMessage : public Events_Message
459 std::wstring myExpression; ///< the expression string
460 std::wstring myParamName; ///< name of the parameter to be searched
461 std::list<std::pair<int, int> > myPositions; ///< computation result: start-end position indices
464 /// Static. Returns EventID of the message.
465 MODELAPI_EXPORT static Events_ID& eventId()
467 static const char * MY_COMPUTE_POSITIOND_EVENT_ID("ComputePositionsRequest");
468 static Events_ID anId = Events_Loop::eventByName(MY_COMPUTE_POSITIOND_EVENT_ID);
472 /// Useful method that creates and sends the AttributeEvalMessage event
473 /// Returns the message, processed, with the resulting fields filled
474 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ComputePositionsMessage>
475 send(const std::wstring& theExpression, const std::wstring& theParameter, const void* theSender)
477 std::shared_ptr<ModelAPI_ComputePositionsMessage> aMessage =
478 std::shared_ptr<ModelAPI_ComputePositionsMessage>(
479 new ModelAPI_ComputePositionsMessage(eventId(), theSender));
480 aMessage->set(theExpression, theParameter);
481 Events_Loop::loop()->send(aMessage);
485 /// Creates an empty message
486 MODELAPI_EXPORT ModelAPI_ComputePositionsMessage(
487 const Events_ID theID, const void* theSender = 0);
488 /// The virtual destructor
489 MODELAPI_EXPORT virtual ~ModelAPI_ComputePositionsMessage();
491 /// Returns an expression stored in the message
492 MODELAPI_EXPORT const std::wstring& expression() const;
493 /// Returns a parameter name stored in the message
494 MODELAPI_EXPORT const std::wstring& parameter() const;
495 /// Sets an expression and parameter needed for computation
496 MODELAPI_EXPORT void set(const std::wstring& theExpression, const std::wstring& theParameter);
497 /// Sets the results of processing
498 MODELAPI_EXPORT void setPositions(const std::list<std::pair<int, int> >& thePositions);
499 /// Returns the results of processing: position start and end indices
500 MODELAPI_EXPORT const std::list<std::pair<int, int> >& positions() const;
503 /// Message that the object is renamed
504 class ModelAPI_ObjectRenamedMessage : public Events_Message
507 std::wstring myOldName;
508 std::wstring myNewName;
511 /// Static. Returns EventID of the message.
512 MODELAPI_EXPORT static Events_ID& eventId()
514 static const char * MY_OBJECT_RENAMED_EVENT_ID("ObjectRenamed");
515 static Events_ID anId = Events_Loop::eventByName(MY_OBJECT_RENAMED_EVENT_ID);
519 /// Useful method that creates and sends the AttributeEvalMessage event
520 MODELAPI_EXPORT static void send(ObjectPtr theObject,
521 const std::wstring& theOldName,
522 const std::wstring& theNewName,
523 const void* theSender);
525 /// Creates an empty message
526 MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
527 /// The virtual destructor
528 MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
530 /// Returns an object
531 MODELAPI_EXPORT ObjectPtr object() const;
533 MODELAPI_EXPORT void setObject(ObjectPtr theObject);
534 /// Returns an old name
535 MODELAPI_EXPORT std::wstring oldName() const;
537 MODELAPI_EXPORT void setOldName(const std::wstring& theOldName);
538 /// Returns a new name
539 MODELAPI_EXPORT std::wstring newName() const;
541 MODELAPI_EXPORT void setNewName(const std::wstring& theNewName);
544 /// Message that the parameter should be replaced with its value
545 class ModelAPI_ReplaceParameterMessage : public Events_Message
550 /// Static. Returns EventID of the message.
551 MODELAPI_EXPORT static Events_ID& eventId()
553 static const char * MY_EVENT_ID("ReplaceParameter");
554 static Events_ID anId = Events_Loop::eventByName(MY_EVENT_ID);
558 /// Useful method that creates and sends the AttributeEvalMessage event
559 MODELAPI_EXPORT static void send(ObjectPtr theObject,
560 const void* theSender);
562 /// Creates an empty message
564 ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
565 /// The virtual destructor
566 MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
568 /// Returns an object
569 MODELAPI_EXPORT ObjectPtr object() const;
571 MODELAPI_EXPORT void setObject(ObjectPtr theObject);
574 /// Message that sends the sketch solver and sketcher GUI processes to show in the property panel
575 class ModelAPI_SolverFailedMessage : public Events_Message
578 /// Creates an message
579 MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
580 /// Default destructor
581 MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
583 /// Sets list of conflicting constraints
584 MODELAPI_EXPORT void setObjects(const std::set<ObjectPtr>& theObjects);
585 /// Returns list of conflicting constraints
586 MODELAPI_EXPORT const std::set<ObjectPtr>& objects() const;
588 /// Sets degrees of freedom
589 void dof(const int theDOF) { myDOF = theDOF; }
590 /// Returns degrees of freedom
591 const int& dof() const { return myDOF; }
594 std::set<ObjectPtr> myObjects;
598 /// Message sent when feature or attribute has been moved.
599 /// Stores the moving object/attribute, original and new positions of mouse.
600 class ModelAPI_ObjectMovedMessage : public Events_Message
602 ObjectPtr myMovedObject;
603 AttributePtr myMovedAttribute;
604 int myMovedPointIndex;
606 std::shared_ptr<GeomAPI_Pnt2d> myOriginalPosition;
607 std::shared_ptr<GeomAPI_Pnt2d> myCurrentPosition;
610 MODELAPI_EXPORT ModelAPI_ObjectMovedMessage(const void* theSender = 0);
612 /// Set object which is being moved (if the message already contains attribute it will be cleared)
613 MODELAPI_EXPORT void setMovedObject(const ObjectPtr& theMovedObject);
614 /// Set attribute which is being moved (if the message already contains object it will be cleared)
615 /// \param[in] theMovedAttribute moved attribute
616 /// \param[in] thePointIndex index of the point if the moved attribute is an array of points
617 MODELAPI_EXPORT void setMovedAttribute(const AttributePtr& theMovedAttribute,
618 const int thePointIndex = -1);
620 /// Return moved object
621 ObjectPtr movedObject() const
622 { return myMovedObject; }
623 /// Return moved attribute
624 AttributePtr movedAttribute() const
625 { return myMovedAttribute; }
626 /// Return index of the moved point
627 int movedPointIndex() const
628 { return myMovedPointIndex; }
630 /// Set original mouse position
631 MODELAPI_EXPORT void setOriginalPosition(double theX, double theY);
632 /// Set original mouse position
633 MODELAPI_EXPORT void setOriginalPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
634 /// Return original mouse position
635 const std::shared_ptr<GeomAPI_Pnt2d>& originalPosition() const
636 { return myOriginalPosition; }
638 /// Set current mouse position
639 MODELAPI_EXPORT void setCurrentPosition(double theX, double theY);
640 /// Set current mouse position
641 MODELAPI_EXPORT void setCurrentPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
642 /// Return current mouse position
643 const std::shared_ptr<GeomAPI_Pnt2d>& currentPosition() const
644 { return myCurrentPosition; }
647 /// Message that sends the failed vertices of 1D-fillet to highlight them in 3D viewer
648 class ModelAPI_ShapesFailedMessage : public Events_Message
651 /// Creates an message
652 MODELAPI_EXPORT ModelAPI_ShapesFailedMessage(const Events_ID theID, const void* theSender = 0);
653 /// Default destructor
654 MODELAPI_EXPORT virtual ~ModelAPI_ShapesFailedMessage();
655 /// Static. Returns EventID of the message.
656 MODELAPI_EXPORT static Events_ID eventId()
658 return Events_Loop::eventByName(EVENT_OPERATION_SHAPES_FAILED);
661 /// Sets list of failed vertices
662 MODELAPI_EXPORT void setShapes(const std::list< std::shared_ptr<GeomAPI_Shape> >& theVertices);
663 /// Returns list of failed vertices
664 MODELAPI_EXPORT const std::list< std::shared_ptr<GeomAPI_Shape> >& shapes() const;
667 std::list< std::shared_ptr<GeomAPI_Shape> > myShapes;
670 ///Message that sends the constraints to check or remove
671 class ModelAPI_CheckConstraintsMessage : public Events_Message
674 /// Creates an empty message
675 MODELAPI_EXPORT ModelAPI_CheckConstraintsMessage(
676 const Events_ID theID, const void* theSender = 0);
677 /// The virtual destructor
678 MODELAPI_EXPORT virtual ~ModelAPI_CheckConstraintsMessage();
680 ///Get list of constrains
681 MODELAPI_EXPORT const std::set<ObjectPtr>& constraints() const;
683 ///Set list of constrains
684 MODELAPI_EXPORT void setConstraints(const std::set<ObjectPtr>& theConstraints);
687 std::set<ObjectPtr> myConstraints;
691 /// Message that sends the features which license is checked and valid
692 class ModelAPI_FeaturesLicenseValidMessage : public Events_Message
695 /// Creates an message
697 ModelAPI_FeaturesLicenseValidMessage(const Events_ID theID, const void* theSender = 0);
698 /// Default destructor
699 MODELAPI_EXPORT virtual ~ModelAPI_FeaturesLicenseValidMessage();
700 /// Static. Returns EventID of the message.
701 MODELAPI_EXPORT static Events_ID eventId()
703 return Events_Loop::eventByName(EVENT_FEATURE_LICENSE_VALID);
706 /// Sets list of features with valid license
707 MODELAPI_EXPORT void setFeatures(const std::set<std::string>& theFeatures);
708 /// Returns list of features with valid license
709 MODELAPI_EXPORT const std::set<std::string>& features() const;
712 std::set<std::string> myFeatures;