X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IWorkshop.h;h=f9ba91551daa9c56523cab08e07d95819c2f171b;hb=fc72d43b677baa05ae7fd317346fd8b723b799ed;hp=12e9aef22040c91a4a762d8028dcb794291c48b7;hpb=979ad873ba8ebe5ec3c8e6eae08f359b94768766;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IWorkshop.h b/src/ModuleBase/ModuleBase_IWorkshop.h index 12e9aef22..f9ba91551 100644 --- a/src/ModuleBase/ModuleBase_IWorkshop.h +++ b/src/ModuleBase/ModuleBase_IWorkshop.h @@ -1,70 +1,179 @@ -// File: ModuleBase_IWorkshop.h -// Created: 2 June 2014 -// Author: Vitaly Smetannikov +// Copyright (C) 2014-2023 CEA/DEN, EDF R&D +// +// 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 ModuleBase_IWorkshop_H #define ModuleBase_IWorkshop_H #include "ModuleBase.h" #include "ModuleBase_Definitions.h" +#include #include #include +#include #include class ModuleBase_IModule; class ModuleBase_ISelection; class ModuleBase_IViewer; +class ModuleBase_IPropertyPanel; +class ModuleBase_IErrorMgr; class ModuleBase_Operation; +class ModuleBase_ISelectionActivate; +class ModuleBase_ViewerPrs; +class QMainWindow; /** - * Class which provides access to Workshop object serveces + * \ingroup GUI + * Class which provides access to Workshop object services */ class MODULEBASE_EXPORT ModuleBase_IWorkshop : public QObject { Q_OBJECT public: - ModuleBase_IWorkshop(QObject* theParent) - : QObject(theParent) - {} + /// Constructor + /// \param theParent parent object + ModuleBase_IWorkshop(QObject* theParent); virtual ~ModuleBase_IWorkshop() {} + /// Return current selection instance virtual ModuleBase_ISelection* selection() const = 0; - /// Activate sub-shapes selection (opens local context) - /// Types has to be dined according to TopAbs_ShapeEnum - virtual void activateSubShapesSelection(const QIntList& theTypes) = 0; - - /// Deactivate sub-shapes selection (closes local context) - virtual void deactivateSubShapesSelection() = 0; - //! Returns instance of loaded module virtual ModuleBase_IModule* module() const = 0; //! Returns current viewer virtual ModuleBase_IViewer* viewer() const = 0; + //! Returns property panel + virtual ModuleBase_IPropertyPanel* propertyPanel() const = 0; + + //! Returns error manager + virtual ModuleBase_IErrorMgr* errorMgr() const = 0; + + /// A filter to process an attribute validators + /// \return a filter + Handle(ModuleBase_FilterValidated) validatorFilter(); + + /// A selection activate in 3D View handler + virtual ModuleBase_ISelectionActivate* selectionActivate() const = 0; + //! Returns currently active operation virtual ModuleBase_Operation* currentOperation() const = 0; - //! Returns AIS opbject by data object + //! Returns true if the operation with id theId can be started + virtual bool canStartOperation(QString theId, bool& isCommitted) = 0; + + //! Performs the operation launch + //! \param theOperation an operation to be launched + virtual void processLaunchOperation(ModuleBase_Operation* theOperation) = 0; + + //! Returns started operation by the operation identifier + //! \param theId an operation id + //! \return an operation instance or NULL + virtual ModuleBase_Operation* findStartedOperation(const QString& theId) = 0; + + //! Returns true if the operation with id theId can be stopped + //! \param theOperation a stopped operation + //! \return boolean result + virtual bool canStopOperation(ModuleBase_Operation* theOperation) = 0; + + //! Commits if possible or aborts the given operation. + //! \param theOperation an aborted operation + /// \param isCommitted boolean value if the operation was committed otherwise it was aborted + virtual void stopOperation(ModuleBase_Operation* theOperation, + bool& isCommitted) = 0; + + //! Returns AIS object by data object + //! \param theObject a data object virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const = 0; //! Returns data object by AIS + //! \param theAIS a presentation virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0; - //! Select features clearing previous selection. + //! Returns true if the object is displayed + //! \param theObject a data object + virtual bool isVisible(const ObjectPtr& theObject) const = 0; + + //! Returns list of currently displayed objects + virtual QObjectPtrList displayedObjects() const = 0; + + //! Select features clearing previous selection. //! If the list is empty then selection will be cleared - virtual void setSelected(const QList& theFeatures) = 0; + //! \param theValues a list of presentations + virtual void setSelected(const QList>& theValues) = 0; + + //! Shows the message in the status bar + //! \param theMessage a message + virtual void setStatusBarMessage(const QString& theMessage) = 0; + + /// Update of commands status + virtual void updateCommandStatus() = 0; + + /// Returns feature info according to given feature ID + /// \param theId a feature Id + virtual std::shared_ptr featureInfo(const QString& theId) const = 0; + + /// Returns main window of the application + virtual QMainWindow* desktop() const = 0; + + /// Returns true if SHIFT is pressed + /// \return boolean value + virtual bool hasSHIFTPressed() const = 0; + + virtual void deactivateCurrentSelector() = 0; + + //! Temporary enable or disable viewer update. Returns previous state of updating + //! \param isEnabled new state of the viewer update + virtual bool enableUpdateViewer(bool isEnabled) = 0; + + //! The methods applys current defined selection modes to given AIS presentation. + //! The AIS presentation has to be already displayed. After activation viewer has to be updated + //! \param theAIS the object which has to be activated + virtual void applyCurrentSelectionModes(const AISObjectPtr& theAIS) = 0; + + //! Undo last command + virtual void undo() = 0; + + //! Set enabled state of cancel button in property panel + virtual void setCancelEnabled(bool toEnable) = 0; + + //! Returns current state of cancel button + virtual bool isCancelEnabled() const = 0; + + //! Show help of a current operation + virtual void showHelpPage(const QString& thePage) const = 0; signals: + /// Signal selection changed. void selectionChanged(); - void operationStarted(ModuleBase_Operation*); - void operationStopped(ModuleBase_Operation*); + /// Signal which is emited after activation of property panel + void propertyPanelActivated(); + +protected: + /// A filter to process an attribute validators + Handle(ModuleBase_FilterValidated) myValidatorFilter; }; #endif