-// 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_
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";
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 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
{
virtual ~ModelAPI_ObjectDeletedMessage();
public:
- /// Returns the document that has been updated
- virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
-
/// Returns the groups where the objects were deleted
- virtual const std::set<std::string>& groups() const = 0;
+ virtual const std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> >&
+ groups() const = 0;
/// Creates the new empty message of this kind
virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
/// 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<Events_MessageGroup>& theJoined) = 0;
};
/// 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<ObjectPtr>& 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<ModelAPI_Document>& theDoc,
const std::string& theGroup) const = 0;
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
{
int myDOF;
};
-/// Message sent when feature or attrubute has been moved.
+/// 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;
/// 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)
- MODELAPI_EXPORT void setMovedAttribute(const AttributePtr& theMovedAttribute);
+ /// \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 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);
