src/SHAPERGUI/SHAPERGUI.h

   1 // Copyright (C) 2014-2020  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SHAPERGUI_H
  21 #define SHAPERGUI_H
  22
  23 #include "SHAPER_SHAPERGUI.h"
  24 #include "SHAPERGUI_SalomeViewer.h"
  25
  26 #include <LightApp_Module.h>
  27 #include <XGUI_SalomeConnector.h>
  28
  29 #include <ModuleBase_ActionInfo.h>
  30
  31 #include <QList>
  32 #include <QMap>
  33
  34 class XGUI_Workshop;
  35 class SHAPERGUI_OCCSelector;
  36 class OCCViewer_Viewer;
  37 class CAM_Study;
  38
  39 /**
  40  * \ingroup Salome
  41  * An implementation of SALOME connector class for implementation of
  42  * XGUI functionality as a module of SALOME
  43  */
  44 class SHAPERGUI_EXPORT SHAPERGUI : public LightApp_Module, public XGUI_SalomeConnector
  45 {
  46 Q_OBJECT
  47  public:
  48   SHAPERGUI();
  49   virtual ~SHAPERGUI();
  50
  51   //----- LightAPP_Module interface ---------------
  52
  53   /// \brief Initializing of the module
  54   /// \param theApp application instance
  55   virtual void initialize(CAM_Application* theApp);
  56
  57   /// \brief Definition of module standard windows
  58   virtual void windows(QMap<int, int>& theWndMap) const;
  59
  60   /// \brief Definition of module viewer
  61   virtual void viewManagers(QStringList& theList) const;
  62
  63   /// \brief The method is called on selection changed event
  64   virtual void selectionChanged();
  65
  66   //--- XGUI connector interface -----
  67
  68   virtual QAction* addFeature(const QString& theWBName, const QString& theTBName,
  69                               const QString& theId, const QString& theTitle,
  70                               const QString& theTip, const QIcon& theIcon,
  71                               const QKeySequence& theKeys/* = QKeySequence()*/,
  72                               bool isCheckable /*= false*/, const bool isAddSeparator/* = false*/,
  73                               const QString& theStatusTip);
  74
  75   //! Add feature (QAction) in the \a theWBName toolbar with given \a theInfo about action
  76   virtual QAction* addFeature(const QString& theWBName,
  77                               const ActionInfo& theInfo, const bool isAddSeparator);
  78
  79   /// Add a nested feature
  80   /// \param theWBName a workbench name
  81   /// \param theInfo the action  parameters
  82   /// \param theNestedActions a list of nested actions
  83   virtual QAction* addFeatureOfNested(const QString& theWBName,
  84                                     const ActionInfo& theInfo,
  85                                     const QList<QAction*>& theNestedActions);
  86
  87   //! Returns true if the feature action is a nested action, in other words,
  88   //! it is created by addNestedFeature().
  89   //! \param theAction - an action of a feature
  90   //! returns boolean result
  91   virtual bool isFeatureOfNested(const QAction* theAction);
  92
  93   virtual QAction* addDesktopCommand(const QString& theId, const QString& theTitle,
  94     const QString& theTip, const QIcon& theIcon,
  95     const QKeySequence& theKeys, bool isCheckable,
  96     const char* theMenuSourceText, const QString& theSubMenu = QString(),
  97     const int theMenuPosition = 10,
  98     const int theSuibMenuPosition = -1) Standard_OVERRIDE;
  99
 100   virtual void addDesktopMenuSeparator(const char* theMenuSourceText,
 101                                        const int theMenuPosition = 10);
 102
 103   /// Add an action to a tool bar
 104   /// \param theAction an ation to add
 105   /// \param theToolBarTitle a name of tool bar
 106   virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle );
 107
 108   /// Creates menu/tool bar actions for loaded features stored in the menu manager
 109   virtual void createFeatureActions();
 110
 111   virtual QMainWindow* desktop() const;
 112
 113   //! Stores XML information for the feature kind
 114   //! \param theFeatureId a feature kind
 115   //! \param theMessage a container of the feature XML properties
 116   virtual void setFeatureInfo(const QString& theFeatureId,
 117                               const std::shared_ptr<Config_FeatureMessage>& theMessage);
 118
 119   //! Returns XML information for the feature kind
 120   //! \param theFeatureId a feature kind
 121   //! \return theMessage a container of the feature XML properties
 122   virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theFeatureId);
 123
 124   //! Returns interface to Salome viewer
 125   virtual ModuleBase_IViewer* viewer() const
 126   {
 127     return myProxyViewer;
 128   }
 129
 130   //! Returns list of defined actions (just by SHAPER module)
 131   virtual QList<QAction*> commandList() const;
 132
 133   /// Redefinition of virtual function.
 134   /// \param theClient name of pop-up client
 135   /// \param theMenu popup menu instance
 136   /// \param theTitle menu title.
 137   virtual void contextMenuPopup(const QString& theClient, QMenu* theMenu, QString& theTitle);
 138
 139   /// Redefinition of virtual function for preferences creation.
 140   virtual void createPreferences();
 141
 142   /// Redefinition of virtual function for preferences changed event.
 143   virtual void preferencesChanged(const QString& theSection, const QString& theParam);
 144
 145   //! Shows the given text in status bar as a permanent text
 146   //! \theInfo a string value
 147   //! \theMsecs interval of msec milliseconds when the message will be hidden, if -1, it stays.
 148   //            If 0, default value is used, it is 3000
 149   virtual void putInfo(const QString& theInfo, const int theMSecs = 0);
 150
 151   /// \return Workshop class instance
 152   XGUI_Workshop* workshop() const { return myWorkshop; }
 153
 154   /// \brief Set flag about opened document state
 155   void setIsOpened(bool theOpened) { myIsOpened = theOpened; }
 156
 157   virtual void updateModuleVisibilityState();
 158
 159   /// Returns list of the module commands
 160   QIntList shaperActions() const { return myActionsList; }
 161
 162   /// Returns structure of tool bars
 163   QMap<QString, QIntList> shaperToolbars() const { return myToolbars; }
 164
 165   /// Returns free commands which are not in toolbars in the module
 166   QIntList getFreeCommands() const;
 167
 168   /// Returns structure of default tool bars
 169   QMap<QString, QIntList> defaultToolbars() const
 170   { return (myDefaultToolbars.size() == 0)? myToolbars : myDefaultToolbars; }
 171
 172   void resetToolbars();
 173
 174   void publishToStudy();
 175
 176  public slots:
 177   /// \brief The method is redefined to connect to the study viewer before the data
 178   /// model is filled by opened file. This file open will flush redisplay signals for,
 179   /// objects which should be visualized
 180   //virtual void connectToStudy(CAM_Study* theStudy);
 181
 182    /// \brief The method is called on the module activation
 183    /// \param theStudy current study
 184   virtual bool activateModule(SUIT_Study* theStudy);
 185
 186    /// \brief The method is called on the module activation
 187    /// \param theStudy current study
 188   virtual bool deactivateModule(SUIT_Study* theStudy);
 189
 190  protected slots:
 191    /// Redefinition of virtual function
 192    /// \param theMgr view manager
 193   virtual void onViewManagerAdded(SUIT_ViewManager* theMgr);
 194
 195    /// Redefinition of virtual function
 196    /// \param theMgr view manager
 197   virtual void onViewManagerRemoved(SUIT_ViewManager* theMgr);
 198
 199   /// Set preferences to default
 200   void onDefaultPreferences();
 201
 202   /// Hide object browser if it was created during loading script
 203   void onScriptLoaded();
 204
 205   /// Save application functionality with additional processing of aborting the current operation
 206   void onSaveDocByShaper();
 207
 208   /// Save application functionality with additional processing of aborting the current operation
 209   void onSaveAsDocByShaper();
 210
 211   /// Obtains the current application and updates its actions
 212   void onUpdateCommandStatus();
 213
 214  protected:
 215    /// Create data model
 216   CAM_DataModel* createDataModel();
 217
 218   /// Create popup menu manager
 219   virtual QtxPopupMgr* popupMgr();
 220
 221   /// Abort all operations
 222   virtual bool abortAllOperations();
 223
 224 private slots:
 225   void onWhatIs(bool isToggled);
 226
 227   void onEditToolbars();
 228
 229  private:
 230    /// Create selector for OCC Viewer
 231    /// \param theMgr view manager
 232   SHAPERGUI_OCCSelector* createSelector(SUIT_ViewManager* theMgr);
 233
 234   void registerCommandToolbar(const QString& theToolName, int theCommandId);
 235
 236   int getNextCommandId() const;
 237
 238   // Update current toolbars
 239   void updateToolbars(const QMap<QString, QIntList>& theNewToolbars);
 240
 241   void saveToolbarsConfig();
 242   void loadToolbarsConfig();
 243
 244
 245   void hideInternalWindows();
 246
 247   /// List of registered nested actions
 248   QStringList myNestedActionsList;
 249
 250   /// Reference to workshop
 251   XGUI_Workshop* myWorkshop;
 252
 253   /// OCC viewer selector instance
 254   SHAPERGUI_OCCSelector* mySelector;
 255
 256   /// Proxy viewer for connection to OCC Viewer in SALOME
 257   SHAPERGUI_SalomeViewer* myProxyViewer;
 258
 259   /// Map of feature kind to a container of XML properties for the feature
 260   QMap<QString, std::shared_ptr<Config_FeatureMessage> > myFeaturesInfo;
 261
 262   /// Flag of opened document state
 263   bool myIsOpened;
 264
 265   // the next parameters should be restored after this module deactivation
 266
 267   /// The application value of the preferences parameter
 268   bool myIsStorePositions;
 269
 270   /// The application value
 271   bool myIsEditEnabled;
 272
 273   /// Popup manager
 274   QtxPopupMgr* myPopupMgr;
 275
 276   QAction* myWhatIsAction;
 277
 278   bool myIsInspectionVisible;
 279   QDockWidget* myInspectionPanel;
 280   bool myIsFacesPanelVisible;
 281
 282   /// List of registered actions
 283   QIntList myActionsList;
 284   QMap<QString, QIntList> myToolbars;
 285   QMap<QString, QIntList> myDefaultToolbars;
 286   bool myIsToolbarsModified;
 287
 288   std::vector<int> myOldSelectionColor;
 289   Handle(Graphic3d_AspectMarker3d) myHighlightPointAspect;
 290
 291   double myAxisArrowRate;
 292 };
 293
 294 #endif