X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Events.h;h=02fdadb0936d97a68e6167a9aa5e4476b4364ac1;hb=d5c7ad3c50f89a2ddc2de1866ffb7f09397f3be2;hp=f162734b18a14c2cf3338af525b20ba430cb9bf2;hpb=423c10234142d14d0d5de89383f2f96a4ec5930f;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Events.h b/src/ModelAPI/ModelAPI_Events.h index f162734b1..02fdadb09 100644 --- a/src/ModelAPI/ModelAPI_Events.h +++ b/src/ModelAPI/ModelAPI_Events.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_Events.h -// Created: 10 Apr 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2019 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef MODELAPI_EVENTS_H_ #define MODELAPI_EVENTS_H_ @@ -21,6 +34,8 @@ class ModelAPI_Document; +class ModelAPI_ResultParameter; +class GeomAPI_Pnt2d; /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage) static const char * EVENT_OBJECT_CREATED = "ObjectCreated"; @@ -40,7 +55,7 @@ static const char * EVENT_PLUGIN_LOADED = "PluginLoaded"; static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged"; /// Event ID that order of objects in group is changed, -/// so, tree must be fully rectreated (movement of feature) +/// so, tree must be fully recreated (movement of feature) static const char * EVENT_ORDER_UPDATED = "OrderUpdated"; /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed static const char * EVENT_UPDATE_SELECTION = "UpdateSelection"; @@ -63,18 +78,38 @@ static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresenta static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked"; /// To preview the current feature in the viewer (to compute the result) static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested"; +/// To block automatic recomputation of any feature (by the GUI button press) +static const char * EVENT_AUTOMATIC_RECOMPUTATION_DISABLE = "DisableAutomaticRecomputation"; +/// To unblock block automatic recomputation (default state: the GUI button unpressed) +static const char * EVENT_AUTOMATIC_RECOMPUTATION_ENABLE = "EnableAutomaticRecomputation"; /// Event ID that solver has conflicting constraints (comes with ModelAPI_SolverFailedMessage) static const char * EVENT_SOLVER_FAILED = "SolverFailed"; /// Event ID that the problem in solver disappeared static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired"; +/// Event Id that sketch has DoF = 0 +static const char * EVENT_SKETCH_FULLY_CONSTRAINED = "SketchFullyConstrainted"; +/// Event Id that sketch has DoF > 0 +static const char * EVENT_SKETCH_UNDER_CONSTRAINED = "SketchUnderConstrainted"; +/// Event Id that sketch has DoF < 0 +static const char * EVENT_SKETCH_OVER_CONSTRAINED = "SketchOverConstrainted"; + /// Event ID that informs that some object has changed the stability static const char * EVENT_STABILITY_CHANGED = "StabilityChanged"; /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed static const char * EVENT_SKETCH_PREPARED = "SketchPrepared"; +/// Event ID that provides a request for list of non-fixed objects necessary for DoF = 0 +static const char * EVENT_GET_DOF_OBJECTS = "GetDoFObjects"; + +/// Event ID that provides a request for list of non-fixed objects necessary for DoF = 0 +static const char * EVENT_DOF_OBJECTS = "DoFObjects"; + +/// Event ID that requests updates visual attributes for presentations +static const char * EVENT_VISUAL_ATTRIBUTES = "UpdateVisualAttributes"; + /// Message that feature was changed (used for Object Browser update): moved, updated and deleted class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup { @@ -105,11 +140,9 @@ protected: virtual ~ModelAPI_ObjectDeletedMessage(); public: - /// Returns the document that has been updated - virtual std::shared_ptr document() const = 0; - /// Returns the groups where the objects were deleted - virtual const std::set& groups() const = 0; + virtual const std::list, std::string> >& + groups() const = 0; /// Creates the new empty message of this kind virtual std::shared_ptr newEmpty() = 0; @@ -117,7 +150,7 @@ public: /// Returns the identifier of the kind of a message virtual const Events_ID messageId() = 0; - /// Appenad to this message the given one. + /// Appends to this message the given one. virtual void Join(const std::shared_ptr& theJoined) = 0; }; @@ -145,6 +178,9 @@ public: /// creates created, updated or moved messages and sends to the loop virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent, const bool isGroupped = true) const = 0; + /// creates created, updated or moved messages with the objects collection and sends to the loop + virtual void sendUpdated(const std::list& theObjects, const Events_ID& theEvent, + const bool isGroupped = true) const = 0; /// creates deleted message and sends to the loop virtual void sendDeleted(const std::shared_ptr& theDoc, const std::string& theGroup) const = 0; @@ -158,7 +194,6 @@ public: static void set(const ModelAPI_EventCreator* theCreator); }; -// TODO(sbh): Move this message into a separate package, like "GuiAPI" /// Contains the state information about the feature: is it enabled or disabled. class ModelAPI_FeatureStateMessage : public Events_Message { @@ -247,6 +282,109 @@ class ModelAPI_AttributeEvalMessage : public Events_Message MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute); }; +/// 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 > 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 + send(FeaturePtr theParameter, const void* theSender) + { + std::shared_ptr aMessage = + std::shared_ptr( + 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 >& 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 >& 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; +}; + + +/// Message to ask compute the positions of parameters in the expression +class ModelAPI_ComputePositionsMessage : public Events_Message +{ + std::string myExpression; ///< the expression string + std::string myParamName; ///< name of the parameter to be searched + std::list > 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 + send(const std::string& theExpression, const std::string& theParameter, const void* theSender) + { + std::shared_ptr aMessage = + std::shared_ptr( + 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::string& expression() const; + /// Returns a parameter name stored in the message + MODELAPI_EXPORT const std::string& parameter() const; + /// Sets an expression and parameter needed for computation + MODELAPI_EXPORT void set(const std::string& theExpression, const std::string& theParameter); + /// Sets the results of processing + MODELAPI_EXPORT void setPositions(const std::list >& thePositions); + /// Returns the results of processing: position start and end indices + MODELAPI_EXPORT const std::list >& positions() const; +}; + /// Message that the object is renamed class ModelAPI_ObjectRenamedMessage : public Events_Message { @@ -342,4 +480,53 @@ private: 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 myOriginalPosition; + std::shared_ptr 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& thePoint); + /// Return original mouse position + const std::shared_ptr& 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& thePoint); + /// Return current mouse position + const std::shared_ptr& currentPosition() const + { return myCurrentPosition; } +}; + #endif