1 // Copyright (C) 2014-2022 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #include "SHAPER_SHAPERGUI.h"
24 #include "SHAPERGUI_SalomeViewer.h"
26 #include <LightApp_Module.h>
27 #include <XGUI_SalomeConnector.h>
29 #include <ModuleBase_ActionInfo.h>
35 class SHAPERGUI_OCCSelector;
36 class OCCViewer_Viewer;
42 * An implementation of SALOME connector class for implementation of
43 * XGUI functionality as a module of SALOME
45 class SHAPERGUI_EXPORT SHAPERGUI : public LightApp_Module, public XGUI_SalomeConnector
52 //----- LightAPP_Module interface ---------------
54 /// \brief Initializing of the module
55 /// \param theApp application instance
56 virtual void initialize(CAM_Application* theApp);
58 /// \brief Definition of module standard windows
59 virtual void windows(QMap<int, int>& theWndMap) const;
61 /// \brief Definition of module viewer
62 virtual void viewManagers(QStringList& theList) const;
64 /// \brief The method is called on selection changed event
65 virtual void selectionChanged();
67 //--- XGUI connector interface -----
69 virtual QAction* addFeature(const QString& theWBName, const QString& theTBName,
70 const QString& theId, const QString& theTitle,
71 const QString& theTip, const QIcon& theIcon,
72 const QKeySequence& theKeys/* = QKeySequence()*/,
73 bool isCheckable /*= false*/, const bool isAddSeparator/* = false*/,
74 const QString& theStatusTip);
76 //! Add feature (QAction) in the \a theWBName toolbar with given \a theInfo about action
77 virtual QAction* addFeature(const QString& theWBName,
78 const ActionInfo& theInfo, const bool isAddSeparator);
80 /// Add a nested feature
81 /// \param theWBName a workbench name
82 /// \param theInfo the action parameters
83 /// \param theNestedActions a list of nested actions
84 virtual QAction* addFeatureOfNested(const QString& theWBName,
85 const ActionInfo& theInfo,
86 const QList<QAction*>& theNestedActions);
88 //! Returns true if the feature action is a nested action, in other words,
89 //! it is created by addNestedFeature().
90 //! \param theAction - an action of a feature
91 //! returns boolean result
92 virtual bool isFeatureOfNested(const QAction* theAction);
94 virtual QAction* addDesktopCommand(const QString& theId, const QString& theTitle,
95 const QString& theTip, const QIcon& theIcon,
96 const QKeySequence& theKeys, bool isCheckable,
97 const char* theMenuSourceText, const QString& theSubMenu = QString(),
98 const int theMenuPosition = 10,
99 const int theSuibMenuPosition = -1) Standard_OVERRIDE;
101 virtual void addDesktopMenuSeparator(const char* theMenuSourceText,
102 const int theMenuPosition = 10);
104 /// Add an action to a tool bar
105 /// \param theAction an ation to add
106 /// \param theToolBarTitle a name of tool bar
107 virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle );
109 /// Creates menu/tool bar actions for loaded features stored in the menu manager
110 virtual void createFeatureActions();
112 virtual QMainWindow* desktop() const;
114 //! Stores XML information for the feature kind
115 //! \param theFeatureId a feature kind
116 //! \param theMessage a container of the feature XML properties
117 virtual void setFeatureInfo(const QString& theFeatureId,
118 const std::shared_ptr<Config_FeatureMessage>& theMessage);
120 //! Returns XML information for the feature kind
121 //! \param theFeatureId a feature kind
122 //! \return theMessage a container of the feature XML properties
123 virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theFeatureId);
125 //! Returns interface to Salome viewer
126 virtual ModuleBase_IViewer* viewer() const
128 return myProxyViewer;
131 //! Returns list of defined actions (just by SHAPER module)
132 virtual QList<QAction*> commandList() const;
134 /// Redefinition of virtual function.
135 /// \param theClient name of pop-up client
136 /// \param theMenu popup menu instance
137 /// \param theTitle menu title.
138 virtual void contextMenuPopup(const QString& theClient, QMenu* theMenu, QString& theTitle);
140 /// Redefinition of virtual function for preferences creation.
141 virtual void createPreferences();
143 /// Redefinition of virtual function for preferences changed event.
144 virtual void preferencesChanged(const QString& theSection, const QString& theParam);
146 //! Shows the given text in status bar as a permanent text
147 //! \theInfo a string value
148 //! \theMsecs interval of msec milliseconds when the message will be hidden, if -1, it stays.
149 // If 0, default value is used, it is 3000
150 virtual void putInfo(const QString& theInfo, const int theMSecs = 0);
152 /// \return Workshop class instance
153 XGUI_Workshop* workshop() const { return myWorkshop; }
155 /// \brief Set flag about opened document state
156 void setIsOpened(bool theOpened) { myIsOpened = theOpened; }
158 virtual void updateModuleVisibilityState();
160 /// Returns list of the module commands
161 QIntList shaperActions() const { return myActionsList; }
163 /// Returns structure of tool bars
164 QMap<QString, QIntList> shaperToolbars() const { return myToolbars; }
166 /// Returns free commands which are not in toolbars in the module
167 QIntList getFreeCommands() const;
169 /// Returns structure of default tool bars
170 QMap<QString, QIntList> defaultToolbars() const
171 { return (myDefaultToolbars.size() == 0)? myToolbars : myDefaultToolbars; }
173 void resetToolbars();
175 void publishToStudy();
177 virtual void updateInfoPanel();
180 /// \brief The method is redefined to connect to the study viewer before the data
181 /// model is filled by opened file. This file open will flush redisplay signals for,
182 /// objects which should be visualized
183 //virtual void connectToStudy(CAM_Study* theStudy);
185 /// \brief The method is called on the module activation
186 /// \param theStudy current study
187 virtual bool activateModule(SUIT_Study* theStudy);
189 /// \brief The method is called on the module activation
190 /// \param theStudy current study
191 virtual bool deactivateModule(SUIT_Study* theStudy);
194 /// Redefinition of virtual function
195 /// \param theMgr view manager
196 virtual void onViewManagerAdded(SUIT_ViewManager* theMgr);
198 /// Redefinition of virtual function
199 /// \param theMgr view manager
200 virtual void onViewManagerRemoved(SUIT_ViewManager* theMgr);
202 /// Set preferences to default
203 void onDefaultPreferences();
205 /// Hide object browser if it was created during loading script
206 void onScriptLoaded();
208 /// Save application functionality with additional processing of aborting the current operation
209 void onSaveDocByShaper();
211 /// Save application functionality with additional processing of aborting the current operation
212 void onSaveAsDocByShaper();
214 /// Obtains the current application and updates its actions
215 void onUpdateCommandStatus();
218 /// Create data model
219 CAM_DataModel* createDataModel();
221 /// Create popup menu manager
222 virtual QtxPopupMgr* popupMgr();
224 /// Abort all operations
225 virtual bool abortAllOperations();
228 void onWhatIs(bool isToggled);
230 void onEditToolbars();
233 /// Create selector for OCC Viewer
234 /// \param theMgr view manager
235 SHAPERGUI_OCCSelector* createSelector(SUIT_ViewManager* theMgr);
237 void registerCommandToolbar(const QString& theToolName, int theCommandId);
239 int getNextCommandId() const;
241 // Update current toolbars
242 void updateToolbars(const QMap<QString, QIntList>& theNewToolbars);
244 void saveToolbarsConfig();
245 void loadToolbarsConfig();
247 //! Fill Info Panel in Part set mode
248 void fillPartSetInfoPanel(QtxInfoPanel* theInfoPanel);
250 //! Fill Info Panel in Part mode
251 void fillPartInfoPanel(QtxInfoPanel* theInfoPanel);
253 //! Fill Info Panel in Sketcher mode
254 void fillSketcherInfoPanel(QtxInfoPanel* theInfoPanel);
256 //! Fill Info Panel in Sketcher mode
257 void addActionsToInfoGroup(QtxInfoPanel* theInfoPanel, const QString& theGroup, const QSet<QString>& theActions);
259 void hideInternalWindows();
261 /// List of registered nested actions
262 QStringList myNestedActionsList;
264 /// Reference to workshop
265 XGUI_Workshop* myWorkshop;
267 /// OCC viewer selector instance
268 SHAPERGUI_OCCSelector* mySelector;
270 /// Proxy viewer for connection to OCC Viewer in SALOME
271 SHAPERGUI_SalomeViewer* myProxyViewer;
273 /// Map of feature kind to a container of XML properties for the feature
274 QMap<QString, std::shared_ptr<Config_FeatureMessage> > myFeaturesInfo;
276 /// Flag of opened document state
279 // the next parameters should be restored after this module deactivation
281 /// The application value of the preferences parameter
282 bool myIsStorePositions;
284 /// The application value
285 bool myIsEditEnabled;
288 QtxPopupMgr* myPopupMgr;
290 QAction* myWhatIsAction;
292 bool myIsInspectionVisible;
293 QDockWidget* myInspectionPanel;
294 bool myIsFacesPanelVisible;
296 /// List of registered actions
297 QIntList myActionsList;
298 QMap<QString, QIntList> myToolbars;
299 QMap<QString, QIntList> myDefaultToolbars;
300 bool myIsToolbarsModified;
302 std::vector<int> myOldSelectionColor;
303 Handle(Graphic3d_AspectMarker3d) myHighlightPointAspect;
305 double myAxisArrowRate;