+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
#ifndef PartSet_Module_H
#define PartSet_Module_H
#include "PartSet.h"
+#include "PartSet_Filters.h"
+#include "PartSet_SketcherMgr.h"
+
+#include <ModuleBase_IModule.h>
+#include <ModuleBase_Definitions.h>
+#include <ModelAPI_Feature.h>
+#include <ModelAPI_Attribute.h>
+#include <ModelAPI_CompositeFeature.h>
-#include <XGUI_Module.h>
-#include <XGUI_Command.h>
+//#include <StdSelect_FaceFilter.hxx>
+#include <TopoDS_Shape.hxx>
#include <QMap>
+#include <QMenu>
#include <QObject>
#include <string>
-#include <boost/shared_ptr.hpp>
+#include <memory>
-class QMouseEvent;
-class QKeyEvent;
-class PartSet_Listener;
-class ModelAPI_Feature;
+class ModuleBase_Operation;
+class ModuleBase_IViewWindow;
-class PARTSET_EXPORT PartSet_Module: public QObject, public XGUI_Module
+class QAction;
+
+/**
+* \ingroup Modules
+* Implementation of Partset module
+*/
+class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule
{
Q_OBJECT
+/// Enumeration to specify the restart operation properties.
+enum RestartingMode {
+ RM_None, /// the operation should not be restarted
+ RM_Forbided, /// the operation should not be restarted after there is no active widget
+ RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization
+ RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature
+};
+
public:
- PartSet_Module(XGUI_Workshop* theWshop);
+ /// Constructor
+ /// \param theWshop a pointer to a workshop
+ PartSet_Module(ModuleBase_IWorkshop* theWshop);
virtual ~PartSet_Module();
- /// Returns the module workshop
- /// \returns a workshop instance
- XGUI_Workshop* workshop() const;
+ /// Creates custom widgets for property panel
+ virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
+ Config_WidgetAPI* theWidgetApi, std::string theParentId);
+
+ /// Call back forlast tuning of property panel before operation performance
+ virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
+
+
+ /// Realizes some functionality by an operation start
+ /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
+ /// \param theOperation a started operation
+ virtual void operationStarted(ModuleBase_Operation* theOperation);
- virtual void createFeatures();
- virtual void featureCreated(XGUI_Command* theFeature);
- virtual QStringList nestedFeatures(QString theFeature);
- std::string featureFile(const std::string&);
+ /// Realizes some functionality by an operation commit
+ /// Restarts sketcher operation automatically of it is necessary
+ /// \param theOperation a committed operation
+ virtual void operationCommitted(ModuleBase_Operation* theOperation);
- /// Creates an operation and send it to loop
- /// \param theCmdId the operation name
- virtual void launchOperation(const QString& theCmdId);
+ /// Realizes some functionality by an operation abort
+ /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
+ /// \param theOperation an aborted operation
+ virtual void operationAborted(ModuleBase_Operation* theOperation);
- /// Displays or erase the current operation preview, if it has it.
- /// \param theF
- /// \param isDisplay the state whether the presentation should be displayed or erased
- void visualizePreview(boost::shared_ptr<ModelAPI_Feature> theFeature, bool isDisplay);
+ /// Realizes some functionality by an operation stop
+ /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters
+ /// \param theOperation a stopped operation
+ virtual void operationStopped(ModuleBase_Operation* theOperation);
- /// Updates current operation preview, if it has it.
- /// \param theCmdId the operation name
- void updateCurrentPreview(const std::string& theCmdId);
+ /// Returns action according to the given ID
+ /// \param theId an action identifier, it should be uniqued in the bounds of the module
+ QAction* action(const QString& theId) const;
+
+ /// Returns True if there are available Undos and the sketch manager allows undo
+ /// \return the boolean result
+ virtual bool canUndo() const;
+
+ //! Returns True if there are available Redos and the sketch manager allows redo
+ /// \return the boolean result
+ virtual bool canRedo() const;
+
+ /// Returns whether the object can be displayed at the bounds of the active operation.
+ /// Display only current operation results for usual operation and ask the sketcher manager
+ /// if it is a sketch operation
+ /// \param theObject a model object
+ virtual bool canDisplayObject(const ObjectPtr& theObject) const;
+ /// Add menu atems for viewer into the given menu
+ /// \param theMenu a popup menu to be shown in the viewer
+ virtual void addViewerItems(QMenu* theMenu) const;
public slots:
- void onFeatureTriggered();
- /// SLOT, that is called after the operation is stopped. Switched off the modfications performed
- /// by the operation start
- void onOperationStopped(ModuleBase_Operation* theOperation);
-
- /// SLOT, that is called by mouse press in the viewer.
- /// The mouse released point is sent to the current operation to be processed.
- /// \param theEvent the mouse event
- void onMousePressed(QMouseEvent* theEvent);
- /// SLOT, that is called by mouse release in the viewer.
- /// The mouse released point is sent to the current operation to be processed.
- /// \param theEvent the mouse event
- void onMouseReleased(QMouseEvent* theEvent);
- /// SLOT, that is called by mouse move in the viewer.
- /// The mouse moved point is sent to the current operation to be processed.
- /// \param theEvent the mouse event
- void onMouseMoved(QMouseEvent* theEvent);
-
- /// SLOT, that is called by the key in the viewer is clicked.
- /// \param theEvent the mouse event
- void onKeyRelease(QKeyEvent*);
-
- /// SLOT, to apply to the current viewer the operation
- /// \param theX the X projection value
- /// \param theY the Y projection value
- /// \param theZ the Z projection value
- void onPlaneSelected(double theX, double theY, double theZ);
-
- void onLaunchOperation(std::string theName, boost::shared_ptr<ModelAPI_Feature> theFeature);
-
- /// SLOT, to switch on/off the multi selection in the viewer
- /// \param theEnabled the enabled state
- void onMultiSelectionEnabled(bool theEnabled);
-
- /// SLOT, to switch on/off the selection in the viewer
- /// \param theEnabled the enabled state
- void onSelectionEnabled(bool theEnabled);
-
- /// SLOT, to visualize the feature in another local context mode
- /// \param theFeature the feature to be put in another local context mode
- /// \param theMode the mode appeared on the feature
- void onFeatureConstructed(boost::shared_ptr<ModelAPI_Feature> theFeature,
- int theMode);
-protected:
- /// Creates a new operation
- /// \param theCmdId the operation name
- ModuleBase_Operation* createOperation(const std::string& theCmdId);
-
- /// Sends the operation
- /// \param theOperation the operation
- void sendOperation(ModuleBase_Operation* theOperation);
-
-private:
- XGUI_Workshop* myWorkshop;
- PartSet_Listener* myListener;
-
- std::map<std::string, std::string> myFeaturesInFiles;
+ /// SLOT, that is called by no more widget signal emitted by property panel
+ /// Set a specific flag to restart the sketcher operation
+ void onNoMoreWidgets();
+
+ /// Processes the context menu action click
+ /// \param isChecked a state of toggle if the action is checkable
+ void onAction(bool isChecked);
+
+protected slots:
+ /// Called when previous operation is finished
+ virtual void onSelectionChanged();
+
+ /// SLOT, that is called by key release in the viewer.
+ /// \param theWnd a view window
+ /// \param theEvent the key event
+ void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
+
+ /// SLOT, that is called by enter key released
+ /// Set a specific type of restarting the current operation
+ void onEnterReleased();
+
+ /// SLOT, that is called by the current operation filling with the preselection.
+ /// It commits the operation of it is can be committed
+ void onOperationActivatedByPreselection();
+
+ protected:
+ /// Register validators for this module
+ virtual void registerValidators();
+
+ /// Register selection filters for this module
+ virtual void registerFilters();
+
+ /// Register properties of this module
+ virtual void registerProperties();
+
+ private slots:
+ /// Processing of vertex selected
+ void onVertexSelected();
+
+ private:
+ /// Breaks sequense of automatically resterted operations
+ void breakOperationSequence();
+
+ /// Create all actions for context menus. It is called on creation of module
+ /// Put the created actions into an internal map
+ void createActions();
+
+ /// Add action to the internal map
+ /// \param theId - string ID of the item
+ /// \param theAction - action to add
+ void addAction(const QString& theId, QAction* theAction);
+
+ //! Delete features
+ virtual bool deleteObjects();
+
+ private:
+ QString myLastOperationId;
+ FeaturePtr myLastFeature;
+
+ // Automatical restarting mode flag
+ RestartingMode myRestartingMode;
+
+ /// A filter which provides selection within a current document or whole PartSet
+ Handle(PartSet_GlobalFilter) myDocumentShapeFilter;
+
+ PartSet_SketcherMgr* mySketchMgr;
+
+ QMap<QString, QAction*> myActions; // the popup menu actions
};
#endif