+/// Message that parameter feature expression should be evaluated: value and error producing
+class ModelAPI_ParameterEvalMessage : public Events_Message
+{
+ FeaturePtr myParam; ///< parameters that should be evaluated
+ bool myIsProcessed; ///< true if results were set
+ /// result of processing, list of parameters in expression found
+ std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
+ double myResult; ///< result of processing, the computed value of the expression
+ std::string myError; ///< error of processing, empty if there is no error
+
+ public:
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID& eventId()
+ {
+ static const char * MY_PARAMETER_EVALUATION_EVENT_ID("ParameterEvaluationRequest");
+ static Events_ID anId = Events_Loop::eventByName(MY_PARAMETER_EVALUATION_EVENT_ID);
+ return anId;
+ }
+
+ /// Useful method that creates and sends the event.
+ /// Returns the message, processed, with the resulting fields filled.
+ MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ParameterEvalMessage>
+ send(FeaturePtr theParameter, const void* theSender)
+ {
+ std::shared_ptr<ModelAPI_ParameterEvalMessage> aMessage =
+ std::shared_ptr<ModelAPI_ParameterEvalMessage>(
+ new ModelAPI_ParameterEvalMessage(eventId(), theSender));
+ aMessage->setParameter(theParameter);
+ Events_Loop::loop()->send(aMessage);
+ return aMessage;
+ }
+
+ /// Creates an empty message
+ MODELAPI_EXPORT ModelAPI_ParameterEvalMessage(const Events_ID theID, const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_ParameterEvalMessage();
+
+ /// Returns a parameter stored in the message
+ MODELAPI_EXPORT FeaturePtr parameter() const;
+ /// Sets a parameter to the message
+ MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
+ /// Sets the results of processing
+ MODELAPI_EXPORT void setResults(
+ const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
+ const double theResult, const std::string& theError);
+ /// Returns true if the expression is processed
+ MODELAPI_EXPORT bool isProcessed();
+ /// Returns the results of processing: list of parameters found in the expression
+ MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
+ /// Returns the expression result
+ MODELAPI_EXPORT const double& result() const;
+ /// Returns the interpreter error (empty if no error)
+ MODELAPI_EXPORT const std::string& error() const;
+};
+
+class ModelAPI_ImportParametersMessage : public Events_Message
+{
+ std::string myFilename; ///< filename where where parameters are stored
+ std::string myError; ///< error of processing, empty if there is no error
+
+public:
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID& eventId()
+ {
+ static const char* MY_PARAMETER_EVALUATION_EVENT_ID("ImportParametersMessage");
+ static Events_ID anId = Events_Loop::eventByName(MY_PARAMETER_EVALUATION_EVENT_ID);
+ return anId;
+ }
+
+ /// Useful method that creates and sends the event.
+ /// Returns the message, processed, with the resulting fields filled.
+ MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ImportParametersMessage>
+ send(std::string theParameter, const void* theSender)
+ {
+ std::shared_ptr<ModelAPI_ImportParametersMessage> aMessage =
+ std::shared_ptr<ModelAPI_ImportParametersMessage>(
+ new ModelAPI_ImportParametersMessage(eventId(), theSender));
+ aMessage->setFilename(theParameter);
+ Events_Loop::loop()->send(aMessage);
+ return aMessage;
+ }
+
+ /// Creates an empty message
+ MODELAPI_EXPORT ModelAPI_ImportParametersMessage(const Events_ID theID,
+ const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_ImportParametersMessage();
+
+ /// Returns a filename stored in the message
+ MODELAPI_EXPORT std::string filename() const;
+ /// Sets a filename to the message
+ MODELAPI_EXPORT void setFilename(std::string theFilename);
+};
+
+class ModelAPI_BuildEvalMessage : public Events_Message
+{
+ FeaturePtr myParam; ///< parameters that should be evaluated
+ bool myIsProcessed; ///< true if results were set
+ std::string myError; ///< error of processing, empty if there is no error
+ /// result of processing, list of parameters in expression found
+ std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
+
+ public:
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID& eventId()
+ {
+ static const char * MY_BUILD_EVALUATION_EVENT_ID("BuildEvaluationRequest");
+ static Events_ID anId = Events_Loop::eventByName(MY_BUILD_EVALUATION_EVENT_ID);
+ return anId;
+ }
+
+ /// Useful method that creates and sends the event.
+ /// Returns the message, processed, with the resulting fields filled.
+ MODELAPI_EXPORT static std::shared_ptr<ModelAPI_BuildEvalMessage>
+ send(FeaturePtr theParameter, const void* theSender)
+ {
+ std::shared_ptr<ModelAPI_BuildEvalMessage> aMessage =
+ std::shared_ptr<ModelAPI_BuildEvalMessage>(
+ new ModelAPI_BuildEvalMessage(eventId(), theSender));
+ aMessage->setParameter(theParameter);
+ Events_Loop::loop()->send(aMessage);
+ return aMessage;
+ }
+
+ /// Creates an empty message
+ MODELAPI_EXPORT ModelAPI_BuildEvalMessage(const Events_ID theID, const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_BuildEvalMessage();
+
+ /// Returns a parameter stored in the message
+ MODELAPI_EXPORT FeaturePtr parameter() const;
+ /// Sets a parameter to the message
+ MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
+ /// Sets the results of processing
+ MODELAPI_EXPORT void setResults(
+ const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
+ const std::string& theError);
+ /// Returns the results of processing: list of parameters found in the expression
+ MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
+ /// Returns true if the expression is processed
+ MODELAPI_EXPORT bool isProcessed();
+
+ /// Returns the interpreter error (empty if no error)
+ MODELAPI_EXPORT const std::string& error() const;
+};
+
+/// Message to ask compute the positions of parameters in the expression
+class ModelAPI_ComputePositionsMessage : public Events_Message
+{
+ std::wstring myExpression; ///< the expression string
+ std::wstring myParamName; ///< name of the parameter to be searched
+ std::list<std::pair<int, int> > myPositions; ///< computation result: start-end position indices
+
+public:
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID& eventId()
+ {
+ static const char * MY_COMPUTE_POSITIOND_EVENT_ID("ComputePositionsRequest");
+ static Events_ID anId = Events_Loop::eventByName(MY_COMPUTE_POSITIOND_EVENT_ID);
+ return anId;
+ }
+
+ /// Useful method that creates and sends the AttributeEvalMessage event
+ /// Returns the message, processed, with the resulting fields filled
+ MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ComputePositionsMessage>
+ send(const std::wstring& theExpression, const std::wstring& theParameter, const void* theSender)
+ {
+ std::shared_ptr<ModelAPI_ComputePositionsMessage> aMessage =
+ std::shared_ptr<ModelAPI_ComputePositionsMessage>(
+ new ModelAPI_ComputePositionsMessage(eventId(), theSender));
+ aMessage->set(theExpression, theParameter);
+ Events_Loop::loop()->send(aMessage);
+ return aMessage;
+ }
+
+ /// Creates an empty message
+ MODELAPI_EXPORT ModelAPI_ComputePositionsMessage(
+ const Events_ID theID, const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_ComputePositionsMessage();
+
+ /// Returns an expression stored in the message
+ MODELAPI_EXPORT const std::wstring& expression() const;
+ /// Returns a parameter name stored in the message
+ MODELAPI_EXPORT const std::wstring& parameter() const;
+ /// Sets an expression and parameter needed for computation
+ MODELAPI_EXPORT void set(const std::wstring& theExpression, const std::wstring& theParameter);
+ /// Sets the results of processing
+ MODELAPI_EXPORT void setPositions(const std::list<std::pair<int, int> >& thePositions);
+ /// Returns the results of processing: position start and end indices
+ MODELAPI_EXPORT const std::list<std::pair<int, int> >& positions() const;
+};
+
+/// Message that the object is renamed
+class ModelAPI_ObjectRenamedMessage : public Events_Message
+{
+ ObjectPtr myObject;
+ std::wstring myOldName;
+ std::wstring myNewName;
+
+ public:
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID& eventId()
+ {
+ static const char * MY_OBJECT_RENAMED_EVENT_ID("ObjectRenamed");
+ static Events_ID anId = Events_Loop::eventByName(MY_OBJECT_RENAMED_EVENT_ID);
+ return anId;
+ }
+
+ /// Useful method that creates and sends the AttributeEvalMessage event
+ MODELAPI_EXPORT static void send(ObjectPtr theObject,
+ const std::wstring& theOldName,
+ const std::wstring& theNewName,
+ const void* theSender);
+
+ /// Creates an empty message
+ MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
+
+ /// Returns an object
+ MODELAPI_EXPORT ObjectPtr object() const;
+ /// Sets an object
+ MODELAPI_EXPORT void setObject(ObjectPtr theObject);
+ /// Returns an old name
+ MODELAPI_EXPORT std::wstring oldName() const;
+ /// Sets an old name
+ MODELAPI_EXPORT void setOldName(const std::wstring& theOldName);
+ /// Returns a new name
+ MODELAPI_EXPORT std::wstring newName() const;
+ /// Sets a new name
+ MODELAPI_EXPORT void setNewName(const std::wstring& theNewName);
+};
+
+/// Message that the parameter should be replaced with its value
+class ModelAPI_ReplaceParameterMessage : public Events_Message
+{
+ ObjectPtr myObject;
+
+ public:
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID& eventId()
+ {
+ static const char * MY_EVENT_ID("ReplaceParameter");
+ static Events_ID anId = Events_Loop::eventByName(MY_EVENT_ID);
+ return anId;
+ }
+
+ /// Useful method that creates and sends the AttributeEvalMessage event
+ MODELAPI_EXPORT static void send(ObjectPtr theObject,
+ const void* theSender);
+
+ /// Creates an empty message
+ MODELAPI_EXPORT
+ ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
+
+ /// Returns an object
+ MODELAPI_EXPORT ObjectPtr object() const;
+ /// Sets an object
+ MODELAPI_EXPORT void setObject(ObjectPtr theObject);
+};
+
+/// Message that sends the sketch solver and sketcher GUI processes to show in the property panel
+class ModelAPI_SolverFailedMessage : public Events_Message
+{
+public:
+ /// Creates an message
+ MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
+ /// Default destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
+
+ /// Sets list of conflicting constraints
+ MODELAPI_EXPORT void setObjects(const std::set<ObjectPtr>& theObjects);
+ /// Returns list of conflicting constraints
+ MODELAPI_EXPORT const std::set<ObjectPtr>& objects() const;
+
+ /// Sets degrees of freedom
+ void dof(const int theDOF) { myDOF = theDOF; }
+ /// Returns degrees of freedom
+ const int& dof() const { return myDOF; }
+
+private:
+ std::set<ObjectPtr> myObjects;
+ int myDOF;
+};
+
+/// Message sent when feature or attribute has been moved.
+/// Stores the moving object/attribute, original and new positions of mouse.
+class ModelAPI_ObjectMovedMessage : public Events_Message
+{
+ ObjectPtr myMovedObject;
+ AttributePtr myMovedAttribute;
+ int myMovedPointIndex;
+
+ std::shared_ptr<GeomAPI_Pnt2d> myOriginalPosition;
+ std::shared_ptr<GeomAPI_Pnt2d> myCurrentPosition;
+
+public:
+ MODELAPI_EXPORT ModelAPI_ObjectMovedMessage(const void* theSender = 0);
+
+ /// Set object which is being moved (if the message already contains attribute it will be cleared)
+ MODELAPI_EXPORT void setMovedObject(const ObjectPtr& theMovedObject);
+ /// Set attribute which is being moved (if the message already contains object it will be cleared)
+ /// \param[in] theMovedAttribute moved attribute
+ /// \param[in] thePointIndex index of the point if the moved attribute is an array of points
+ MODELAPI_EXPORT void setMovedAttribute(const AttributePtr& theMovedAttribute,
+ const int thePointIndex = -1);
+
+ /// Return moved object
+ ObjectPtr movedObject() const
+ { return myMovedObject; }
+ /// Return moved attribute
+ AttributePtr movedAttribute() const
+ { return myMovedAttribute; }
+ /// Return index of the moved point
+ int movedPointIndex() const
+ { return myMovedPointIndex; }
+
+ /// Set original mouse position
+ MODELAPI_EXPORT void setOriginalPosition(double theX, double theY);
+ /// Set original mouse position
+ MODELAPI_EXPORT void setOriginalPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
+ /// Return original mouse position
+ const std::shared_ptr<GeomAPI_Pnt2d>& originalPosition() const
+ { return myOriginalPosition; }
+
+ /// Set current mouse position
+ MODELAPI_EXPORT void setCurrentPosition(double theX, double theY);
+ /// Set current mouse position
+ MODELAPI_EXPORT void setCurrentPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
+ /// Return current mouse position
+ const std::shared_ptr<GeomAPI_Pnt2d>& currentPosition() const
+ { return myCurrentPosition; }
+};
+
+/// Message that sends the failed vertices of 1D-fillet to highlight them in 3D viewer
+class ModelAPI_ShapesFailedMessage : public Events_Message
+{
+public:
+ /// Creates an message
+ MODELAPI_EXPORT ModelAPI_ShapesFailedMessage(const Events_ID theID, const void* theSender = 0);
+ /// Default destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_ShapesFailedMessage();
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID eventId()
+ {
+ return Events_Loop::eventByName(EVENT_OPERATION_SHAPES_FAILED);
+ }
+
+ /// Sets list of failed vertices
+ MODELAPI_EXPORT void setShapes(const std::list< std::shared_ptr<GeomAPI_Shape> >& theVertices);
+ /// Returns list of failed vertices
+ MODELAPI_EXPORT const std::list< std::shared_ptr<GeomAPI_Shape> >& shapes() const;
+
+private:
+ std::list< std::shared_ptr<GeomAPI_Shape> > myShapes;
+};
+
+///Message that sends the constraints to check or remove
+class ModelAPI_CheckConstraintsMessage : public Events_Message
+{
+public:
+ /// Creates an empty message
+ MODELAPI_EXPORT ModelAPI_CheckConstraintsMessage(
+ const Events_ID theID, const void* theSender = 0);
+ /// The virtual destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_CheckConstraintsMessage();
+
+ ///Get list of constrains
+ MODELAPI_EXPORT const std::set<ObjectPtr>& constraints() const;
+
+ ///Set list of constrains
+ MODELAPI_EXPORT void setConstraints(const std::set<ObjectPtr>& theConstraints);
+
+private:
+ std::set<ObjectPtr> myConstraints;
+};
+
+
+/// Message that sends the features which license is checked and valid
+class ModelAPI_FeaturesLicenseValidMessage : public Events_Message
+{
+public:
+ /// Creates an message
+ MODELAPI_EXPORT
+ ModelAPI_FeaturesLicenseValidMessage(const Events_ID theID, const void* theSender = 0);
+ /// Default destructor
+ MODELAPI_EXPORT virtual ~ModelAPI_FeaturesLicenseValidMessage();
+ /// Static. Returns EventID of the message.
+ MODELAPI_EXPORT static Events_ID eventId()
+ {
+ return Events_Loop::eventByName(EVENT_FEATURE_LICENSE_VALID);
+ }
+
+ /// Sets list of features with valid license
+ MODELAPI_EXPORT void setFeatures(const std::set<std::string>& theFeatures);
+ /// Returns list of features with valid license
+ MODELAPI_EXPORT const std::set<std::string>& features() const;
+
+private:
+ std::set<std::string> myFeatures;
+};
+