XGUI_Workshop.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 XGUI_WORKSHOP_H
#define XGUI_WORKSHOP_H
 
#include "XGUI.h"
 
#include <ModelAPI_Document.h>
#include <ModelAPI_Feature.h>
#include <ModelAPI_ResultBody.h>
 
#include <ModuleBase_ActionInfo.h>
#include <ModuleBase_ActionType.h>
#include <ModuleBase_Definitions.h>
 
#include <SelectMgr_ListOfFilter.hxx>
 
#include <QIcon>
#include <QObject>
#include <QKeySequence>
#include <QMap>
#include <QTemporaryDir>
 
#ifndef HAVE_SALOME
class AppElements_Command;
class AppElements_MainWindow;
class AppElements_Workbench;
#endif
 
class Config_DataModelReader;
 
class XGUI_ActionsMgr;
class XGUI_ActiveControlMgr;
class XGUI_ContextMenuMgr;
class XGUI_Displayer;
class XGUI_ErrorDialog;
class XGUI_ErrorMgr;
class XGUI_FacesPanel;
class XGUI_MenuMgr;
class XGUI_ModuleConnector;
class XGUI_ObjectsBrowser;
class XGUI_OperationMgr;
class XGUI_PropertyPanel;
class XGUI_SalomeConnector;
class XGUI_SalomeViewer;
class XGUI_SelectionActivate;
class XGUI_SelectionMgr;
class XGUI_ViewerProxy;
class XGUI_WorkshopListener;
class XGUI_InspectionPanel;
class XGUI_SketchConstraintsBrowser;
 
class ModuleBase_IModule;
class ModuleBase_IViewer;
class ModuleBase_Operation;
 
class QAction;
class QDockWidget;
class QMainWindow;
class QWidget;
 
class XGUI_EXPORT XGUI_Workshop : public QObject
{
Q_OBJECT
 public:
  XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
  virtual ~XGUI_Workshop();
 
  QDockWidget* createConstraintsBrowser(QWidget* theParent);
 
  void removeConstrBrowser() { mySkConstBrwsr = NULL; }
 
  void startApplication();
 
  void activateModule();
 
  void deactivateModule();
 
#ifndef HAVE_SALOME
  AppElements_MainWindow* mainWindow() const { return myMainWindow; }
 
  AppElements_Workbench* addWorkbench(const QString& theName);
#endif
 
  XGUI_SelectionMgr* selector() const { return mySelector; }
 
  XGUI_SelectionActivate* selectionActivate() const { return mySelectionActivate; }
 
  XGUI_Displayer* displayer() const { return myDisplayer; }
 
  XGUI_OperationMgr* operationMgr() const { return myOperationMgr; }
 
  XGUI_ErrorMgr* errorMgr() const { return myErrorMgr; }
 
  XGUI_ActionsMgr* actionsMgr() const { return myActionsMgr; }
 
  XGUI_ActiveControlMgr* activeControlMgr() const { return myActiveControlMgr; }
 
  XGUI_MenuMgr* menuMgr() const { return myMenuMgr; }
 
  XGUI_PropertyPanel* propertyPanel() const { return myPropertyPanel; }
 
  XGUI_InspectionPanel* inspectionPanel() const { return myInspectionPanel; }
 
  XGUI_FacesPanel* facesPanel() const { return myFacesPanel; }
 
  XGUI_ContextMenuMgr* contextMenuMgr() const { return myContextMenuMgr; }
 
  XGUI_SalomeConnector* salomeConnector() const { return mySalomeConnector; }
 
  ModuleBase_IViewer* salomeViewer() const;
 
  bool isSalomeMode() const { return mySalomeConnector != 0; }
 
  XGUI_ObjectsBrowser* objectBrowser() const { return myObjectBrowser; }
 
  XGUI_SketchConstraintsBrowser* constraintsBrowser() const { return mySkConstBrwsr; }
 
  void salomeViewerSelectionChanged();
 
  XGUI_ViewerProxy* viewer() const { return myViewerProxy; }
 
  XGUI_ModuleConnector* moduleConnector() const { return myModuleConnector; }
 
  QMainWindow* desktop() const;
 
  virtual bool prepareForDisplay(const std::set<ObjectPtr>& theObjects) const;
 
  void deleteObjects();
 
  void editConstraints();
 
  void deactivateCosntraint();
 
  void cleanHistory();
 
  bool canMoveFeature();
 
  void moveObjects(const bool theSplit);
 
  void recoverFeature();
 
  bool canBeShaded(const ObjectPtr& theObject) const;
 
  bool canChangeProperty(const QString& theActionName) const;
 
  void changeColor(const QMap<ResultPtr, QList<GeomShapePtr>>& theSelectedObjects);
 
  void changeAutoColor(const QMap<ResultPtr, QList<GeomShapePtr>>& theSelectedObjects);
 
  void changeDeflection(const QObjectPtrList& theObjects);
 
  void changeTransparency(const QObjectPtrList& theObjects);
 
  void changeIsoLines(const QObjectPtrList& theObjects);
 
  void showObjects(const QObjectPtrList& theList, bool isVisible);
 
  void showOnlyObjects(const QObjectPtrList& theList);
 
  void setDisplayMode(const QObjectPtrList& theList, int theMode);
 
  void toggleEdgesDirection(const QObjectPtrList& theList);
 
  void toggleBringToFront(const QObjectPtrList& theList);
 
  void setViewerSelectionMode(int theMode);
 
  void activateObjectsSelection(const QObjectPtrList& theList);
 
  ModuleBase_IModule* module() const { return myModule; }
 
  QString currentDataFile() const { return myCurrentFile; }
 
  void setCurrentDataFile(const QString& theDir) { myCurrentFile = theDir; }
 
  void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
 
  bool abortAllOperations();
 
  void operationStarted(ModuleBase_Operation* theOperation);
 
  bool deleteFeatures(const QObjectPtrList& theFeatures);
 
  void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
 
  bool isFeatureOfNested(const FeaturePtr& theFeature);
 
  void setStatusBarMessage(const QString& theMessage);
 
#ifdef HAVE_SALOME
  void synchronizeViewer();
 
  void synchronizeGroupInViewer(const DocumentPtr& theDoc,
                                bool theUpdateViewer);
 
  void synchronizeResultTree(const ResultBodyPtr& theRes, bool theUpdateViewer);
 
#endif
  void fillPropertyPanel(ModuleBase_Operation* theOperation);
 
  void connectToPropertyPanel(const bool isToConnect);
 
  QIntList viewerSelectionModes() const { return myViewerSelMode; }
 
  void highlightResults(const QObjectPtrList& theObjects);
 
  void highlightFeature(const QObjectPtrList& theObjects);
 
  const Config_DataModelReader* dataModelXMLReader() const { return myDataModelXMLReader; }
 
  static QString MOVE_TO_END_COMMAND;
  static QString MOVE_TO_END_SPLIT_COMMAND;
 
  void openFile(const QString& theDirectory);
 
  void updateAutoComputeState();
 
  void deactivateCurrentSelector();
 
  void updateColorScaleVisibility();
 
  void updateGroupsText();
 
  void showHelpPage(const QString& thePage) const;
 
  void setBackupState(bool theDoBackup=true);
 
  bool backupState() const    { return myDoBackup; }
 
  void setWaitForBackup(bool theDoWait=true);
 
  bool waitForBackup() const  { return myWaitForBackup; }
 
signals:
  void salomeViewerSelection();
 
  void commandStatusUpdated();
 
  void applicationStarted();
 
  void updateUndoHistory(const QList<ActionInfo>&);
 
  void updateRedoHistory(const QList<ActionInfo>&);
 
 public slots:
  void updateCommandStatus();
 
  void updateHistory();
 
  bool onSave();
 
  bool onSaveAs();
 
  void onUndo(int times = 1);
 
  void onRedo(int times = 1);
 
  void onWidgetStateChanged(int thePreviousState);
 
  void onValuesChanged();
 
  void onWidgetObjectUpdated();
 
  void showPanel(QDockWidget* theDockWidget);
 
  void hidePanel(QDockWidget* theDockWidget);
 
  void showObjectBrowser();
 
  void hideObjectBrowser();
 
  void showConstraintsBrowser();
 
  void hideConstraintsBrowser();
 
  void closeDocument();
 
  void onOpen();
 
  void onNew();
 
  void onImportPart();
 
  void onImportShape();
 
  void onImportImage();
 
  void onExportPart();
 
  void onExportShape();
 
#ifndef HAVE_SALOME
  void onExit();
 
  void onPreferences();
#endif
 
  void onAutoApply();
 
  void onTrihedronVisibilityChanged(bool theState);
 
  void onTransparencyValueChanged();
 
 protected:
  void setGrantedFeatures(ModuleBase_Operation* theOperation);
 
private:
  void displayDocumentResults(DocumentPtr theDoc);
 
  void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
 
  void insertFeatureFolder();
 
  void insertToFolder(bool isBefore);
 
  void moveOutFolder(bool isBefore);
 
 private slots:
  virtual void onOperationResumed(ModuleBase_Operation* theOperation);
 
  virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 
  virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
 
  void onOperationAborted(ModuleBase_Operation* theOperation);
 
  void onContextMenuCommand(const QString& theId, bool isChecked);
 
  void onStartWaiting();
 
  void onAcceptActionClicked();
 
  void onAcceptPlusActionClicked();
 
  void onPreviewActionClicked();
 
  void onHelpActionClicked() const;
 
  void onDockSizeChanged();
 
 private:
  void initMenu();
 
  void registerValidators() const;
 
  ModuleBase_IModule* loadModule(const QString& theModule);
 
  bool createModule();
 
  QDockWidget* createObjectBrowser(QWidget* theParent);
 
  // Creates Dock widgets: Object browser and Property panel
  void createDockWidgets();
 
  void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
 
  QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
 
  void processUndoRedo(const ModuleBase_ActionType theActionType, int theTimes);
 
  void clearTemporaryDir();
 
  void setNormalView(bool toInvert = false);
 
private:
#ifndef HAVE_SALOME
  AppElements_MainWindow* myMainWindow; 
#endif
 
  XGUI_SketchConstraintsBrowser* mySkConstBrwsr; // ~~!!!!~~
  ModuleBase_IModule* myModule; 
  XGUI_ErrorMgr* myErrorMgr; 
  XGUI_ObjectsBrowser* myObjectBrowser; 
  XGUI_PropertyPanel* myPropertyPanel; 
  XGUI_FacesPanel* myFacesPanel; 
  XGUI_SelectionMgr* mySelector; 
  XGUI_SelectionActivate* mySelectionActivate; 
  XGUI_Displayer* myDisplayer; 
  XGUI_OperationMgr* myOperationMgr;  
  XGUI_ActionsMgr* myActionsMgr; 
  XGUI_ActiveControlMgr* myActiveControlMgr; 
  XGUI_MenuMgr* myMenuMgr; 
  XGUI_SalomeConnector* mySalomeConnector; 
  XGUI_ErrorDialog* myErrorDlg; 
  XGUI_ViewerProxy* myViewerProxy; 
  XGUI_ContextMenuMgr* myContextMenuMgr; 
  XGUI_ModuleConnector* myModuleConnector; 
  XGUI_WorkshopListener* myEventsListener; 
  QString myCurrentFile; 
  QIntList myViewerSelMode; 
  Config_DataModelReader* myDataModelXMLReader; 
  XGUI_InspectionPanel* myInspectionPanel; 
  QTemporaryDir myTmpDir; 
  bool myDoBackup; 
  bool myWaitForBackup; 
};
 
#endif