X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPartSet%2FPartSet_Module.h;h=f074786d33f30c8d1a9be9eaf39cf43253e53767;hb=3205d0f18200948632155bbe7b640bc1e482243d;hp=a3a188ad0347ff9a10f376b7bc06d3f382f84928;hpb=aac9be89c85672f971e93bec0b379bf3858d81f3;p=modules%2Fshaper.git diff --git a/src/PartSet/PartSet_Module.h b/src/PartSet/PartSet_Module.h old mode 100644 new mode 100755 index a3a188ad0..f074786d3 --- a/src/PartSet/PartSet_Module.h +++ b/src/PartSet/PartSet_Module.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + #ifndef PartSet_Module_H #define PartSet_Module_H @@ -5,160 +7,304 @@ #include #include -#include -#include #include -#include +#include +#include + +#include + +//#include +#include +#include #include +#include #include +#include #include -#include +#include -class PartSet_Listener; -class ModelAPI_Feature; -class XGUI_ViewerPrs; -class XGUI_Workshop; class ModuleBase_Operation; -class GeomAPI_AISObject; - -class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule +class ModuleBase_IViewWindow; +class PartSet_MenuMgr; +class PartSet_CustomPrs; +class PartSet_SketcherMgr; +class PartSet_SketcherReetntrantMgr; + +class QAction; + +/** +* \ingroup Modules +* Implementation of Partset module +*/ +class PARTSET_EXPORT PartSet_Module : public ModuleBase_IModule, public Events_Listener { Q_OBJECT - public: - PartSet_Module(ModuleBase_IWorkshop* theWshop); - virtual ~PartSet_Module(); - - /// Reads description of features from XML file - virtual void createFeatures(); - - /// Called on creation of menu item in desktop - virtual void featureCreated(QAction* theFeature); +/// Enumeration to specify the restart operation properties. +enum RestartingMode { + RM_None, /// the operation should not be restarted + RM_Forbided, /// the operation should not be restarted after there is no active widget + RM_LastFeatureUsed, /// the operation is restarted and use the previous feature for own initialization + RM_EmptyFeatureUsed /// the operation is restarted and does not use the previous feature +}; - std::string featureFile(const std::string&); +public: - /// Creates an operation and send it to loop - /// \param theCmdId the operation name - //virtual void launchOperation(const QString& theCmdId); + /// Constructor + /// \param theWshop a pointer to a workshop + PartSet_Module(ModuleBase_IWorkshop* theWshop); + virtual ~PartSet_Module(); - /// Updates current operation preview, if it has it. - /// \param theCmdId the operation name - void updateCurrentPreview(const std::string& theCmdId); + // Add default selection filters of the module to the current viewer + virtual void activateSelectionFilters(); + // Remove default selection filters of the module from the current viewer + virtual void deactivateSelectionFilters(); /// Creates custom widgets for property panel - virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent, - Config_WidgetAPI* theWidgetApi, - QList& theModelWidgets); - - XGUI_Workshop* xWorkshop() const; - - - /// Returns list of selection modes for the given object for sketch operation - static QIntList sketchSelectionModes(ObjectPtr theFeature); + virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, + Config_WidgetAPI* theWidgetApi, std::string theParentId); - public slots: - void onFeatureTriggered(); - /// SLOT, that is called after the operation is started. Connect on the focus activated signal - void onOperationStarted(ModuleBase_Operation* theOperation); - /// SLOT, that is called after the operation is stopped. Switched off the modfications performed - /// by the operation start - void onOperationStopped(ModuleBase_Operation* theOperation); - /// SLOT, that is called afetr the popup menu action clicked. - void onContextMenuCommand(const QString& theId, bool isChecked); + /// Returns the active widget, by default it is the property panel active widget + /// If the internal edit operation is started, this is the first widget of the operation + virtual ModuleBase_ModelWidget* activeWidget() const; - /// SLOT, to apply to the current viewer the operation - /// \param theX the X projection value - /// \param theY the Y projection value - /// \param theZ the Z projection value - void onPlaneSelected(double theX, double theY, double theZ); + /// Call back forlast tuning of property panel before operation performance + virtual void propertyPanelDefined(ModuleBase_Operation* theOperation); - /// SLOT, to fit all current viewer - void onFitAllView(); + /// Creates an operation and send it to loop + /// \param theCmdId the operation name + virtual void launchOperation(const QString& theCmdId); + + /// Realizes some functionality by an operation start + /// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters + /// Activate the operation presentation + /// \param theOperation a started operation + virtual void operationStarted(ModuleBase_Operation* theOperation); + + /// Realizes some functionality by an operation resume + /// Activate the operation presentation + /// \param theOperation a resumed operation + virtual void operationResumed(ModuleBase_Operation* theOperation); + + /// Realizes some functionality by an operation commit + /// Restarts sketcher operation automatically of it is necessary + /// \param theOperation a committed operation + virtual void operationCommitted(ModuleBase_Operation* theOperation); + + /// Realizes some functionality by an operation abort + /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters + /// \param theOperation an aborted operation + virtual void operationAborted(ModuleBase_Operation* theOperation); + + /// Realizes some functionality by an operation stop + /// Hides all sketcher sub-Objects, displays sketcher result and removes selection filters + /// \param theOperation a stopped operation + virtual void operationStopped(ModuleBase_Operation* theOperation); + + /// Returns current operation + virtual ModuleBase_Operation* currentOperation() const; + + /// Returns True if there are available Undos and the sketch manager allows undo + /// \return the boolean result + virtual bool canUndo() const; + + //! Returns True if there are available Redos and the sketch manager allows redo + /// \return the boolean result + virtual bool canRedo() const; + + /// Returnas true if the action can be applyed to the object + /// \param theObject a checked object + /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD" + /// \return the a booean result + virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const; + + /// Returns True if the current operation can be committed. Asks the sketch manager. + /// \return a boolean value + //virtual bool canCommitOperation() const; + + /// Returns whether the object can be erased at the bounds of the active operation. + /// The sub-objects of the current operation can not be erased + /// \param theObject a model object + virtual bool canEraseObject(const ObjectPtr& theObject) const; + + /// Returns whether the object can be displayed at the bounds of the active operation. + /// Display only current operation results for usual operation and ask the sketcher manager + /// if it is a sketch operation + /// \param theObject a model object + virtual bool canDisplayObject(const ObjectPtr& theObject) const; + + /// Returns true if selection for the object can be activate. + /// For sketch operation allow the selection activation if the operation is edit, for other + /// operation uses the default result + /// \param theObject a model object + virtual bool canActivateSelection(const ObjectPtr& theObject) const; + + /// Add menu atems for object browser into the given menu + /// \param theMenu a popup menu to be shown in the object browser + virtual void addObjectBrowserMenu(QMenu* theMenu) const; + + /// Add menu atems for viewer into the given menu + /// \param theMenu a popup menu to be shown in the viewer + /// \param theStdActions a map of standard actions + /// \return true if items are added and there is no necessity to provide standard menu + virtual bool addViewerMenu(QMenu* theMenu, const QMap& theStdActions) const; + + /// Returns a list of modes, where the AIS objects should be activated + /// \param theModes a list of modes + virtual void activeSelectionModes(QIntList& theModes); + + /// Returns whether the mouse enter the viewer's window + /// \return true if items are added and there is no necessity to provide standard menu + bool isMouseOverWindow(); + + /// Returns sketch manager object + PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; } + + /// Returns sketch reentrant manager + PartSet_SketcherReetntrantMgr* sketchReentranceMgr() { return mySketchReentrantMgr; } + + /// Performs functionality on closing document + virtual void closeDocument(); + + /// Clears specific presentations in the viewer + virtual void clearViewer(); + + /// Event Listener method + /// \param theMessage an event message + virtual void processEvent(const std::shared_ptr& theMessage); + + /// Set the object with the object results are customized + /// \param theFeature a feature + void setCustomized(const FeaturePtr& theFeature); + + /** Update the object presentable properties such as color, lines width and other + * If the object is result with the color attribute value set, it is used, + * otherwise the customize is applyed to the object's feature if it is a custom prs + * \param theObject an object instance + * \param theUpdateViewer the parameter whether the viewer should be update immediatelly + * \returns true if the object is modified + */ + virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer); + + /// This method is called on object browser creation for customisation of module specific features + /// \param theObjectBrowser a pinter on Object Browser widget + virtual void customizeObjectBrowser(QWidget* theObjectBrowser); + + /// Returns the viewer Z layer + int getVisualLayerId() const { return myVisualLayerId; } + + //! Returns data object by AIS + virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const; + + /// Update state of pop-up menu items in viewer + /// \param theStdActions - a map of standard actions + virtual void updateViewerMenu(const QMap& theStdActions); + + //! Returns the feature error if the current state of the feature in the module is not correct + //! If the feature is correct, it returns an empty value + //! \return string value + virtual QString getFeatureError(const FeaturePtr& theFeature); + + /// Returns list of granted operation indices + virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const; + + /// Validates the current operation and send the state change to sketch manager + /// \param thePreviousState the previous widget value state + virtual void widgetStateChanged(int thePreviousState); + + /// Returns true if the event is processed. It gives the reentrance manager to process the enter. + /// \param thePreviousAttributeID an index of the previous active attribute + virtual bool processEnter(const std::string& thePreviousAttributeID); + + /// Performs some GUI actions after an operation transaction is opened + /// Default realization is empty + virtual void beforeOperationStarted(ModuleBase_Operation* theOperation); + + /// Performs some GUI actions before an operation transaction is stopped + /// Default realization is empty + virtual void beforeOperationStopped(ModuleBase_Operation* theOperation); + +public slots: + /// Redefines the parent method in order to customize the next case: + /// If the sketch nested operation is active and the presentation is not visualized in the viewer, + /// the operation should be always aborted. + virtual void onFeatureTriggered(); + + /// Slolt called on object display + /// \param theObject a data object + /// \param theAIS a presentation object + virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS); + + /// Slot called on before object erase + /// \param theObject a data object + /// \param theAIS a presentation object + virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS); + + /// Called on transformation in current viewer + /// \param theTrsfType type of tranformation + void onViewTransformed(int theTrsfType = 2); - void onRestartOperation(std::string theName, ObjectPtr theFeature); +protected slots: + /// Called when previous operation is finished + virtual void onSelectionChanged(); - /// SLOT, to switch on/off the multi selection in the viewer - /// \param theEnabled the enabled state - void onMultiSelectionEnabled(bool theEnabled); + /// SLOT, that is called by key release in the viewer. + /// \param theWnd a view window + /// \param theEvent the key event + void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent); - /// SLOT, to stop or start selection mode for the features - /// \param theFeatures a list of features to be disabled - /// \param theToStop the boolean state whether it it stopped or non stopped - void onStopSelection(const QList& theFeatures, const bool isStop); + /// SLOT, that is called by the current operation filling with the preselection. + /// It commits the operation of it is can be committed + void onOperationActivatedByPreselection(); - /// SLOT, to set selection - /// \param theFeatures a list of features to be selected - void onSetSelection(const QList& theFeatures); + /// A slot called on view window creation + void onViewCreated(ModuleBase_IViewWindow*); - /// SLOT, Defines Sketch editing mode - /// \param thePln - plane of current sketch - void setSketchingMode(const gp_Pln& thePln); + /// A slot to change property panel title on change of boolean operation type + /// \param theOperation the operation type + void onBooleanOperationChange(int theOperation); - /// SLOT, to visualize the feature in another local context mode - /// \param theFeature the feature to be put in another local context mode - /// \param theMode the mode appeared on the feature - void onFeatureConstructed(ObjectPtr theFeature, int theMode); +protected: + /// Register validators for this module + virtual void registerValidators(); - /// Slot which reacts to the point 2d set to the feature. Creates a constraint - /// \param the feature - /// \param the attribute of the feature - void onStorePoint2D(ObjectPtr theFeature, const std::string& theAttribute); + /// Register selection filters for this module + virtual void registerFilters(); - /// Called when sketch is launched - void onSketchLaunched(); + /// Register properties of this module + virtual void registerProperties(); -protected slots: - /// Called on selection changed event - virtual void onSelectionChanged(); + /// Connects or disconnects to the value changed signal of the property panel widgets + /// \param theWidget a property contol widget + /// \param isToConnect a boolean value whether connect or disconnect + virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect); - /// SLOT, that is called by mouse press in the viewer. - /// The mouse released point is sent to the current operation to be processed. - /// \param theEvent the mouse event - virtual void onMousePressed(QMouseEvent* theEvent); - - /// SLOT, that is called by mouse release in the viewer. - /// The mouse released point is sent to the current operation to be processed. - /// \param theEvent the mouse event - virtual void onMouseReleased(QMouseEvent* theEvent); - - /// SLOT, that is called by mouse move in the viewer. - /// The mouse moved point is sent to the current operation to be processed. - /// \param theEvent the mouse event - virtual void onMouseMoved(QMouseEvent* theEvent); - - /// SLOT, that is called by the mouse double click in the viewer. - /// \param theEvent the mouse event - virtual void onMouseDoubleClick(QMouseEvent* theEvent); - - /// SLOT, that is called by the key in the viewer is clicked. - /// \param theEvent the mouse event - virtual void onKeyRelease(QKeyEvent* theEvent); - - protected: - /// Creates a new operation - /// \param theCmdId the operation name - /// \param theFeatureKind a kind of feature to get the feature xml description - ModuleBase_Operation* createOperation(const std::string& theCmdId, - const std::string& theFeatureKind = ""); + private slots: + void onTreeViewDoubleClick(const QModelIndex&); + void onActiveDocPopup(const QPoint&); - protected: - //! Edits the feature - void editFeature(FeaturePtr theFeature); + private: - gp_Pln getSketchPlane(FeaturePtr theSketch) const; + //! Delete features + virtual bool deleteObjects(); private: - //XGUI_Workshop* myWorkshop; - PartSet_Listener* myListener; + SelectMgr_ListOfFilter mySelectionFilters; + + PartSet_SketcherMgr* mySketchMgr; + PartSet_SketcherReetntrantMgr* mySketchReentrantMgr; + PartSet_MenuMgr* myMenuMgr; + /// A default custom presentation, which is used for references objects of started operation + PartSet_CustomPrs* myCustomPrs; + int myVisualLayerId; - std::map myFeaturesInFiles; + bool myHasConstraintShown; - Handle(StdSelect_FaceFilter) myPlaneFilter; - Handle(ModuleBase_ShapeInPlaneFilter) mySketchFilter; + QModelIndex aActivePartIndex; }; #endif