ModelAPI_Events.h

// Copyright (C) 2014-2025  CEA, EDF
//
// 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_
 
#include <ModelAPI.h>
#include <ModelAPI_Object.h>
#include <ModelAPI_Feature.h>
#include <ModelAPI_Attribute.h>
#include <Events_MessageGroup.h>
#include <Events_Loop.h>
 
#include <memory>
#include <string>
#include <set>
#include <map>
 
 
class ModelAPI_Document;
class ModelAPI_ResultParameter;
class GeomAPI_Pnt2d;
class GeomAPI_Shape;
 
#if defined __GNUC__ || defined __clang__
#define MAYBE_UNUSED __attribute__((unused))
#else
#define MAYBE_UNUSED
#endif
 
MAYBE_UNUSED static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
MAYBE_UNUSED static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
MAYBE_UNUSED static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
MAYBE_UNUSED static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
MAYBE_UNUSED static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
MAYBE_UNUSED static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
MAYBE_UNUSED static const char * EVENT_PLUGIN_LOADED = "PluginLoaded";
MAYBE_UNUSED static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
MAYBE_UNUSED static const char * EVENT_DOCUMENTS_CLOSED = "AllDocumentsClosed";
 
MAYBE_UNUSED static const char * EVENT_ORDER_UPDATED = "OrderUpdated";
MAYBE_UNUSED static const char * EVENT_UPDATE_SELECTION = "UpdateSelection";
 
MAYBE_UNUSED static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
MAYBE_UNUSED static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
 
MAYBE_UNUSED static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
MAYBE_UNUSED static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
 
MAYBE_UNUSED static const char * EVENT_EMPTY_AIS_PRESENTATION = "EmptyAISPresentation";
MAYBE_UNUSED static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresentation";
MAYBE_UNUSED static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked";
MAYBE_UNUSED static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested";
MAYBE_UNUSED static const char * EVENT_AUTOMATIC_RECOMPUTATION_DISABLE
                                                         = "DisableAutomaticRecomputation";
MAYBE_UNUSED static const char * EVENT_AUTOMATIC_RECOMPUTATION_ENABLE
                                                         = "EnableAutomaticRecomputation";
 
MAYBE_UNUSED static const char * EVENT_SOLVER_FAILED = "SolverFailed";
MAYBE_UNUSED static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired";
 
MAYBE_UNUSED static const char * EVENT_SKETCH_FULLY_CONSTRAINED = "SketchFullyConstrainted";
MAYBE_UNUSED static const char * EVENT_SKETCH_UNDER_CONSTRAINED = "SketchUnderConstrainted";
MAYBE_UNUSED static const char * EVENT_SKETCH_OVER_CONSTRAINED  = "SketchOverConstrainted";
 
MAYBE_UNUSED static const char * EVENT_STABILITY_CHANGED = "StabilityChanged";
 
MAYBE_UNUSED static const char * EVENT_SKETCH_PREPARED = "SketchPrepared";
 
MAYBE_UNUSED static const char * EVENT_GET_DOF_OBJECTS = "GetDoFObjects";
 
MAYBE_UNUSED static const char * EVENT_DOF_OBJECTS = "DoFObjects";
 
MAYBE_UNUSED static const char * EVENT_VISUAL_ATTRIBUTES = "UpdateVisualAttributes";
 
MAYBE_UNUSED static const char * EVENT_OPERATION_SHAPES_FAILED = "OperationShapesFailed";
 
MAYBE_UNUSED static const char * EVENT_CHECK_CONSTRAINTS = "CheckConstrains";
 
MAYBE_UNUSED static const char * EVENT_REMOVE_CONSTRAINTS = "RemoveConstrains";
 
MAYBE_UNUSED static const char * EVENT_FEATURE_LICENSE_VALID = "FeaturesLicenseValid";
 
MAYBE_UNUSED static const char * EVENT_CREATE_PART_ON_START = "CreatePartOnStart";
 
 
class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
{
 protected:
  ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
  virtual ~ModelAPI_ObjectUpdatedMessage();
 
 public:
  virtual const std::set<ObjectPtr>& objects() const = 0;
 
  virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
 
  virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
};
 
class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
{
protected:
  ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
  virtual ~ModelAPI_ObjectDeletedMessage();
 
public:
  virtual const std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> >&
    groups() const = 0;
 
  virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
 
  virtual const Events_ID messageId() = 0;
 
  virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
};
 
class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
{
protected:
  ModelAPI_OrderUpdatedMessage(const Events_ID theID, const void* theSender = 0);
  virtual ~ModelAPI_OrderUpdatedMessage();
 
public:
  virtual std::shared_ptr<ModelAPI_Feature> reordered() = 0;
 
  virtual const Events_ID messageId() = 0;
};
 
class MODELAPI_EXPORT ModelAPI_EventCreator
{
public:
  virtual ~ModelAPI_EventCreator() {}
 
  virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
                           const bool isGroupped = true) const = 0;
  virtual void sendUpdated(const std::list<ObjectPtr>& theObjects, const Events_ID& theEvent,
    const bool isGroupped = true) const = 0;
  virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
                           const std::string& theGroup) const = 0;
  virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const = 0;
 
  static const ModelAPI_EventCreator* get();
 
  static void set(const ModelAPI_EventCreator* theCreator);
};
 
class ModelAPI_FeatureStateMessage : public Events_Message
{
public:
  MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
 
  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
  MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
  // For response
  MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
  MODELAPI_EXPORT bool state(const  std::string& theFeatureId, bool theDefault = false) const;
  MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
  MODELAPI_EXPORT std::list<std::string> features() const;
 
 private:
  std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
  std::map<std::string, bool> myFeatureState;
};
 
class ModelAPI_DocumentCreatedMessage : public Events_Message
{
  DocumentPtr myDocument;
 
 public:
  MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage();
  MODELAPI_EXPORT static Events_ID eventId()
  {
    static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated");
    return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID);
  }
 
  MODELAPI_EXPORT DocumentPtr document() const;
  MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
};
 
class ModelAPI_AttributeEvalMessage : public Events_Message
{
  AttributePtr myAttribute;
 
 public:
  MODELAPI_EXPORT static Events_ID& eventId()
  {
    static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest");
    static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID);
    return anId;
  }
 
  MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender)
  {
    std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
      std::shared_ptr<ModelAPI_AttributeEvalMessage>(
      new ModelAPI_AttributeEvalMessage(eventId(), theSender));
    aMessage->setAttribute(theAttribute);
    Events_Loop::loop()->send(aMessage);
  }
 
  MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage();
 
  MODELAPI_EXPORT AttributePtr attribute() const;
  MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute);
};
 
class ModelAPI_ParameterEvalMessage : public Events_Message
{
  FeaturePtr myParam; 
  bool myIsProcessed; 
  std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
  double myResult; 
  std::string myError; 
 
 public:
  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;
  }
 
  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;
  }
 
  MODELAPI_EXPORT ModelAPI_ParameterEvalMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_ParameterEvalMessage();
 
  MODELAPI_EXPORT FeaturePtr parameter() const;
  MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
  MODELAPI_EXPORT void setResults(
    const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
    const double theResult, const std::string& theError);
  MODELAPI_EXPORT bool isProcessed();
  MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
  MODELAPI_EXPORT const double& result() const;
  MODELAPI_EXPORT const std::string& error() const;
};
 
class ModelAPI_ImportParametersMessage : public Events_Message
{
  std::string myFilename; 
  std::string myError; 
 
public:
  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;
  }
 
  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;
  }
 
  MODELAPI_EXPORT ModelAPI_ImportParametersMessage(const Events_ID theID,
                                                   const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_ImportParametersMessage();
 
  MODELAPI_EXPORT std::string filename() const;
  MODELAPI_EXPORT void setFilename(std::string theFilename);
};
 
class ModelAPI_BuildEvalMessage : public Events_Message
{
  FeaturePtr myParam; 
  bool myIsProcessed; 
  std::string myError; 
  std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
 
 public:
  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;
  }
 
  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;
  }
 
  MODELAPI_EXPORT ModelAPI_BuildEvalMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_BuildEvalMessage();
 
  MODELAPI_EXPORT FeaturePtr parameter() const;
  MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
  MODELAPI_EXPORT void setResults(
                       const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
                       const std::string& theError);
  MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
  MODELAPI_EXPORT bool isProcessed();
 
  MODELAPI_EXPORT const std::string& error() const;
};
 
class ModelAPI_ComputePositionsMessage : public Events_Message
{
  std::wstring myExpression; 
  std::wstring myParamName; 
  std::list<std::pair<int, int> > myPositions; 
 
public:
  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;
  }
 
  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;
  }
 
  MODELAPI_EXPORT ModelAPI_ComputePositionsMessage(
    const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_ComputePositionsMessage();
 
  MODELAPI_EXPORT const std::wstring& expression() const;
  MODELAPI_EXPORT const std::wstring& parameter() const;
  MODELAPI_EXPORT void set(const std::wstring& theExpression, const std::wstring& theParameter);
  MODELAPI_EXPORT void setPositions(const std::list<std::pair<int, int> >& thePositions);
  MODELAPI_EXPORT const std::list<std::pair<int, int> >& positions() const;
};
 
class ModelAPI_ObjectRenamedMessage : public Events_Message
{
  ObjectPtr myObject;
  std::wstring myOldName;
  std::wstring myNewName;
 
 public:
  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;
  }
 
  MODELAPI_EXPORT static void send(ObjectPtr theObject,
                                   const std::wstring& theOldName,
                                   const std::wstring& theNewName,
                                   const void* theSender);
 
  MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
 
  MODELAPI_EXPORT ObjectPtr object() const;
  MODELAPI_EXPORT void setObject(ObjectPtr theObject);
  MODELAPI_EXPORT std::wstring oldName() const;
  MODELAPI_EXPORT void setOldName(const std::wstring& theOldName);
  MODELAPI_EXPORT std::wstring newName() const;
  MODELAPI_EXPORT void setNewName(const std::wstring& theNewName);
};
 
class ModelAPI_ReplaceParameterMessage : public Events_Message
{
  ObjectPtr myObject;
 
 public:
  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;
  }
 
  MODELAPI_EXPORT static void send(ObjectPtr theObject,
                                   const void* theSender);
 
  MODELAPI_EXPORT
    ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
 
  MODELAPI_EXPORT ObjectPtr object() const;
  MODELAPI_EXPORT void setObject(ObjectPtr theObject);
};
 
class ModelAPI_SolverFailedMessage : public Events_Message
{
public:
  MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
 
  MODELAPI_EXPORT void setObjects(const std::set<ObjectPtr>& theObjects);
  MODELAPI_EXPORT const std::set<ObjectPtr>& objects() const;
 
  void dof(const int theDOF) { myDOF = theDOF; }
  const int& dof() const { return myDOF; }
 
private:
  std::set<ObjectPtr> myObjects;
  int myDOF;
};
 
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);
 
  MODELAPI_EXPORT void setMovedObject(const ObjectPtr& theMovedObject);
  MODELAPI_EXPORT void setMovedAttribute(const AttributePtr& theMovedAttribute,
                                         const int thePointIndex = -1);
 
  ObjectPtr movedObject() const
  { return myMovedObject; }
  AttributePtr movedAttribute() const
  { return myMovedAttribute; }
  int movedPointIndex() const
  { return myMovedPointIndex; }
 
  MODELAPI_EXPORT void setOriginalPosition(double theX, double theY);
  MODELAPI_EXPORT void setOriginalPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  const std::shared_ptr<GeomAPI_Pnt2d>& originalPosition() const
  { return myOriginalPosition; }
 
  MODELAPI_EXPORT void setCurrentPosition(double theX, double theY);
  MODELAPI_EXPORT void setCurrentPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  const std::shared_ptr<GeomAPI_Pnt2d>& currentPosition() const
  { return myCurrentPosition; }
};
 
class ModelAPI_ShapesFailedMessage : public Events_Message
{
public:
  MODELAPI_EXPORT ModelAPI_ShapesFailedMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_ShapesFailedMessage();
  MODELAPI_EXPORT static Events_ID eventId()
  {
    return Events_Loop::eventByName(EVENT_OPERATION_SHAPES_FAILED);
  }
 
  MODELAPI_EXPORT void setShapes(const std::list< std::shared_ptr<GeomAPI_Shape> >& theVertices);
  MODELAPI_EXPORT const std::list< std::shared_ptr<GeomAPI_Shape> >& shapes() const;
 
private:
  std::list< std::shared_ptr<GeomAPI_Shape> > myShapes;
};
 
class ModelAPI_CheckConstraintsMessage : public Events_Message
{
public:
  MODELAPI_EXPORT ModelAPI_CheckConstraintsMessage(
    const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_CheckConstraintsMessage();
 
  MODELAPI_EXPORT const std::set<ObjectPtr>& constraints() const;
 
  MODELAPI_EXPORT void setConstraints(const std::set<ObjectPtr>& theConstraints);
 
private:
  std::set<ObjectPtr> myConstraints;
};
 
 
class ModelAPI_FeaturesLicenseValidMessage : public Events_Message
{
public:
  MODELAPI_EXPORT
  ModelAPI_FeaturesLicenseValidMessage(const Events_ID theID, const void* theSender = 0);
  MODELAPI_EXPORT virtual ~ModelAPI_FeaturesLicenseValidMessage();
  MODELAPI_EXPORT static Events_ID eventId()
  {
    return Events_Loop::eventByName(EVENT_FEATURE_LICENSE_VALID);
  }
 
  MODELAPI_EXPORT void setFeatures(const std::set<std::string>& theFeatures);
  MODELAPI_EXPORT const std::set<std::string>& features() const;
 
private:
  std::set<std::string> myFeatures;
};
 
#endif