SHAPERGUI.h

// Copyright (C) 2014-2025  CEA, EDF
//
// 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 SHAPERGUI_H
#define SHAPERGUI_H
 
#include "SHAPER_SHAPERGUI.h"
#include "SHAPERGUI_SalomeViewer.h"
 
#include <LightApp_Module.h>
#include <XGUI_SalomeConnector.h>
 
#include <ModuleBase_ActionInfo.h>
 
#include <QList>
#include <QMap>
#include <future>
 
class XGUI_Workshop;
class SHAPERGUI_OCCSelector;
class OCCViewer_Viewer;
class CAM_Study;
class QtxInfoPanel;
class ModuleBase_Operation;
 
class SHAPERGUI_EXPORT SHAPERGUI : public LightApp_Module, public XGUI_SalomeConnector
{
Q_OBJECT
 public:
  SHAPERGUI();
  virtual ~SHAPERGUI();
 
  //----- LightAPP_Module interface ---------------
 
  virtual void initialize(CAM_Application* theApp);
 
  virtual void windows(QMap<int, int>& theWndMap) const;
 
  virtual void viewManagers(QStringList& theList) const;
 
  virtual void selectionChanged();
 
  //--- XGUI connector interface -----
 
  virtual QAction* addFeature(
    const QString& theWorkBenchID,
    const QString& theWorkBenchName,
    const QString& theToolBarName,
    const QString& theActionIdLastToken,
    const QString& theActionTitle,
    const QString& theActionToolTip,
    const QString& theActionStatusTip,
    const QIcon& theActionIcon,
    const QKeySequence& theKS,
    const bool theIsCheckable,
    const bool theAddSeparator
  );
 
  virtual QAction* addFeature(const QString& theWBName, const QString& theTBName,
                              const QString& theIdLastToken, const QString& theTitle,
                              const QString& theTip, const QIcon& theIcon,
                              const QKeySequence& theKeys/* = QKeySequence()*/,
                              const bool theIsCheckable /* = false*/, const bool theAddSeparator/* = false*/,
                              const QString& theStatusTip /* = ""*/);
 
  virtual QAction* addFeature(const QString& theWBName, const ActionInfo& theInfo, const bool theAddSeparator);
 
  virtual QAction* addFeatureOfNested(const QString& theWBName,
                                    const ActionInfo& theInfo,
                                    const QList<QAction*>& theNestedActions);
 
  virtual bool isFeatureOfNested(const QAction* theAction);
 
  virtual QAction* addDesktopCommand(const QString& theId, const QString& theTitle,
    const QString& theTip, const QIcon& theIcon,
    const QKeySequence& theKeys, bool isCheckable,
    const char* theMenuSourceText, const QString& theSubMenu = QString(),
    const int theMenuPosition = 10,
    const int theSuibMenuPosition = -1) Standard_OVERRIDE;
 
  virtual void addDesktopMenuSeparator(const char* theMenuSourceText,
                                       const int theMenuPosition = 10);
 
  virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle );
 
  virtual void createFeatureActions();
 
  virtual QMainWindow* desktop() const;
 
  virtual void setFeatureInfo(const QString& theFeatureId,
                              const std::shared_ptr<Config_FeatureMessage>& theMessage);
 
  virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theFeatureId);
 
  virtual ModuleBase_IViewer* viewer() const
  {
    return myProxyViewer;
  }
 
  virtual QList<QAction*> commandList() const;
 
  virtual void contextMenuPopup(const QString& theClient, QMenu* theMenu, QString& theTitle);
 
  virtual void createPreferences();
 
  virtual void preferencesChanged(const QString& theSection, const QString& theParam);
 
  //            If 0, default value is used, it is 3000
  virtual void putInfo(const QString& theInfo, const int theMSecs = 0);
 
  XGUI_Workshop* workshop() const { return myWorkshop; }
 
  void setIsOpened(bool theOpened) { myIsOpened = theOpened; }
 
  virtual void updateModuleVisibilityState();
 
  QIntList shaperActions() const { return myActionsList; }
 
  QMap<QString, QIntList> shaperToolbars() const { return myToolbars; }
 
  QIntList getFreeCommands() const;
 
  QMap<QString, QIntList> defaultToolbars() const
  { return (myDefaultToolbars.size() == 0)? myToolbars : myDefaultToolbars; }
 
  void resetToolbars();
 
  void publishToStudy();
 
  virtual void updateInfoPanel();
 
signals:
  void backupDone(QString aName, int aResult);
 
public slots:
  //virtual void connectToStudy(CAM_Study* theStudy);
 
  virtual bool activateModule(SUIT_Study* theStudy);
 
  virtual bool deactivateModule(SUIT_Study* theStudy);
 
 protected slots:
  virtual void onViewManagerAdded(SUIT_ViewManager* theMgr);
 
  virtual void onViewManagerRemoved(SUIT_ViewManager* theMgr);
 
  void onDefaultPreferences();
 
  void onScriptLoaded();
 
  void onSaveDocByShaper();
 
  void onSaveAsDocByShaper();
 
  void onBackupDoc();
 
  void onBackupDone(QString aName, int aResult);
 
  void onUpdateCommandStatus();
 
  virtual void logShaperGUIEvent();
 
 protected:
  CAM_DataModel* createDataModel();
 
  virtual QtxPopupMgr* popupMgr();
 
  virtual bool abortAllOperations();
 
  int backupDoc();
 
private slots:
  void onWhatIs(bool isToggled);
 
  void onEditToolbars();
 
  void onOperationCommitted(ModuleBase_Operation*);
  void onOperationAborted(ModuleBase_Operation*);
 
 private:
  SHAPERGUI_OCCSelector* createSelector(SUIT_ViewManager* theMgr);
 
  void registerCommandToolbar(const QString& theToolName, int theCommandId);
 
  int getNextCommandId() const;
 
  // Update current toolbars
  void updateToolbars(const QMap<QString, QIntList>& theNewToolbars);
 
  void saveToolbarsConfig();
  void loadToolbarsConfig();
 
  void fillPartSetInfoPanel(QtxInfoPanel* theInfoPanel);
 
  void fillPartInfoPanel(QtxInfoPanel* theInfoPanel);
 
  void fillSketcherInfoPanel(QtxInfoPanel* theInfoPanel);
 
  void addActionsToInfoGroup(QtxInfoPanel* theInfoPanel, const QString& theGroup, const QSet<QString>& theActions);
 
  void hideInternalWindows();
 
  // Check, whether we are waiting for a backup => if yes, do it now
  void checkForWaitingBackup();
 
  QStringList myNestedActionsList;
 
  XGUI_Workshop* myWorkshop;
 
  SHAPERGUI_OCCSelector* mySelector;
 
  SHAPERGUI_SalomeViewer* myProxyViewer;
 
  QMap<QString, std::shared_ptr<Config_FeatureMessage> > myFeaturesInfo;
 
  bool myIsOpened;
 
  // the next parameter should be restored after this module deactivation
  bool myIsEditEnabled;
 
  QtxPopupMgr* myPopupMgr;
 
  QAction* myWhatIsAction;
 
  bool myIsInspectionVisible;
  QDockWidget* myInspectionPanel;
  bool myIsFacesPanelVisible;
 
  QIntList myActionsList;
  QMap<QString, QIntList> myToolbars;
  QMap<QString, QIntList> myDefaultToolbars;
  bool myIsToolbarsModified;
 
  std::vector<int> myOldSelectionColor;
  Handle(Graphic3d_AspectMarker3d) myHighlightPointAspect;
 
  double myAxisArrowRate;
 
  QTimer*          myBackupTimer;      // The timer which triggers the automatic backup
  std::future<int> myBackupResult;     // The result (success/failure) of the backup
  QString          myBackupError;      // The backup error message in case of a failure
  QString          myBackupFolder;     // The root folder where the backups are saved
  QString          myLastBackupFolder; // The folder of the last backup
};
 
#endif