Salome HOME
Define Selection validator interface.
[modules/shaper.git] / src / PartSet / PartSet_Module.h
1 #ifndef PartSet_Module_H
2 #define PartSet_Module_H
3
4 #include "PartSet.h"
5
6 #include <ModuleBase_IModule.h>
7 #include <ModuleBase_Definitions.h>
8 #include <XGUI_Command.h>
9 #include <ModelAPI_Feature.h>
10
11 #include <QMap>
12 #include <QObject>
13
14 #include <string>
15
16 #include <boost/shared_ptr.hpp>
17
18 class QMouseEvent;
19 class QKeyEvent;
20 class PartSet_Listener;
21 class ModelAPI_Feature;
22 class XGUI_ViewerPrs;
23 class ModuleBase_Operation;
24
25 class PARTSET_EXPORT PartSet_Module: public ModuleBase_IModule
26 {
27 Q_OBJECT
28
29 public:
30   PartSet_Module(XGUI_Workshop* theWshop);
31   virtual ~PartSet_Module();
32
33   /// Returns the module workshop
34   /// \returns a workshop instance
35   XGUI_Workshop* workshop() const;
36
37   /// Reads description of features from XML file 
38   virtual void createFeatures();
39
40   /// Called on creation of menu item in desktop
41   virtual void featureCreated(QAction* theFeature);
42
43   /// Returnc list of nested commands for the given feature
44   virtual QStringList nestedFeatures(QString theFeature);
45   std::string featureFile(const std::string&);
46
47   /// Creates an operation and send it to loop
48   /// \param theCmdId the operation name
49   virtual void launchOperation(const QString& theCmdId);
50
51   /// Called when it is necessary to update a command state (enable or disable it)
52   //virtual bool isFeatureEnabled(const QString& theCmdId) const;
53
54   /// Displays or erase the current operation preview, if it has it.
55   /// \param theFeature the feature instance to be displayed
56   /// \param isDisplay the state whether the presentation should be displayed or erased
57   /// \param isUpdateViewer the flag whether the viewer should be updated
58   void visualizePreview(FeaturePtr theFeature, bool isDisplay,
59                         const bool isUpdateViewer = true);
60
61   /// Activates the feature in the displayer
62   /// \param theFeature the feature instance to be displayed
63   /// \param isUpdateViewer the flag whether the viewer should be updated
64   void activateFeature(FeaturePtr theFeature,
65                        const bool isUpdateViewer);
66
67   /// Updates current operation preview, if it has it.
68   /// \param theCmdId the operation name
69   void updateCurrentPreview(const std::string& theCmdId);
70
71   /// Creates custom widgets for property panel
72   virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent, 
73     Config_WidgetAPI* theWidgetApi, QList<ModuleBase_ModelWidget*>& theModelWidgets);
74
75
76 public slots:
77   void onFeatureTriggered();
78   /// SLOT, that is called after the operation is started. Connect on the focus activated signal
79   void onOperationStarted();
80   /// SLOT, that is called after the operation is stopped. Switched off the modfications performed
81   /// by the operation start
82   void onOperationStopped(ModuleBase_Operation* theOperation);
83   /// SLOT, that is called afetr the popup menu action clicked.
84   void onContextMenuCommand(const QString& theId, bool isChecked);
85   /// SLOT, that is called by mouse press in the viewer.
86   /// The mouse released point is sent to the current operation to be processed.
87   /// \param theEvent the mouse event
88   void onMousePressed(QMouseEvent* theEvent);
89   /// SLOT, that is called by mouse release in the viewer.
90   /// The mouse released point is sent to the current operation to be processed.
91   /// \param theEvent the mouse event
92   void onMouseReleased(QMouseEvent* theEvent);
93   /// SLOT, that is called by mouse move in the viewer.
94   /// The mouse moved point is sent to the current operation to be processed.
95   /// \param theEvent the mouse event
96   void onMouseMoved(QMouseEvent* theEvent);
97
98   /// SLOT, that is called by the key in the viewer is clicked.
99   /// \param theEvent the mouse event
100   void onKeyRelease(QKeyEvent* theEvent);
101
102   /// SLOT, that is called by the mouse double click in the viewer.
103   /// \param theEvent the mouse event
104   void onMouseDoubleClick(QMouseEvent* theEvent);
105
106   /// SLOT, to apply to the current viewer the operation
107   /// \param theX the X projection value
108   /// \param theY the Y projection value
109   /// \param theZ the Z projection value
110   void onPlaneSelected(double theX, double theY, double theZ);
111
112   /// SLOT, to fit all current viewer
113   void onFitAllView();
114
115   void onLaunchOperation(std::string theName, FeaturePtr theFeature);
116
117   /// SLOT, to switch on/off the multi selection in the viewer
118   /// \param theEnabled the enabled state
119   void onMultiSelectionEnabled(bool theEnabled);
120
121   /// SLOT, to stop or start selection mode for the features
122   /// \param theFeatures a list of features to be disabled
123   /// \param theToStop the boolean state whether it it stopped or non stopped
124   void onStopSelection(const QFeatureList& theFeatures, const bool isStop);
125
126   /// SLOT, to set selection
127   /// \param theFeatures a list of features to be selected
128   void onSetSelection(const QFeatureList& theFeatures);
129
130   /// SLOT, to close the viewer local context
131   void onCloseLocalContext();
132
133   /// SLOT, to visualize the feature in another local context mode
134   /// \param theFeature the feature to be put in another local context mode
135   /// \param theMode the mode appeared on the feature
136   void onFeatureConstructed(FeaturePtr theFeature,
137                             int theMode);
138
139   /// Slot which reacts to the point 2d set to the feature. Creates a constraint
140   /// \param the feature
141   /// \param the attribute of the feature
142   void onStorePoint2D(FeaturePtr theFeature, const std::string& theAttribute);
143
144 protected:
145   /// Creates a new operation
146   /// \param theCmdId the operation name
147   /// \param theFeatureKind a kind of feature to get the feature xml description
148   ModuleBase_Operation* createOperation(const std::string& theCmdId,
149                                         const std::string& theFeatureKind = "");
150
151   /// Sends the operation
152   /// \param theOperation the operation
153   void sendOperation(ModuleBase_Operation* theOperation);
154
155 protected:
156   //! Edits the feature
157   void editFeature(FeaturePtr theFeature);
158
159 private:
160   XGUI_Workshop* myWorkshop;
161   PartSet_Listener* myListener;
162
163   std::map<std::string, std::string> myFeaturesInFiles;
164 };
165
166 #endif