-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+// Copyright (C) 2014-2017 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<mailto:webmaster.salome@opencascade.com>
+//
#ifndef PartSet_Module_H
#define PartSet_Module_H
#include "PartSet.h"
#include "PartSet_Tools.h"
#include "PartSet_OverconstraintListener.h"
+#include "PartSet_SketcherMgr.h"
#include <ModuleBase_IModule.h>
#include <ModuleBase_Definitions.h>
class ModuleBase_Operation;
class ModuleBase_IViewWindow;
+class ModuleBase_ViewerPrs;
+
class XGUI_Workshop;
class PartSet_MenuMgr;
class PartSet_CustomPrs;
class PartSet_SketcherMgr;
-class PartSet_SketcherReetntrantMgr;
+class PartSet_SketcherReentrantMgr;
+class ModelAPI_Result;
class QAction;
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_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
};
PartSet_Module(ModuleBase_IWorkshop* theWshop);
virtual ~PartSet_Module();
- // 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();
-
// Stores the current selection
virtual void storeSelection();
/// Creates custom widgets for property panel
virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
- Config_WidgetAPI* theWidgetApi, std::string theParentId);
+ Config_WidgetAPI* theWidgetApi);
/// 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
/// Call back forlast tuning of property panel before operation performance
virtual void propertyPanelDefined(ModuleBase_Operation* theOperation);
- /// If there is found selected attribute, widgets are created and contains only a widget for the attribute
+ /// If there is found selected attribute, widgets are created and contains
+ /// only a widget for the attribute
/// It is important for Property Panel filling by sketch point attribute
/// \param theOperation a started operation
/// \param theWidgets a list of created widgets
virtual bool createWidgets(ModuleBase_Operation* theOperation,
QList<ModuleBase_ModelWidget*>& theWidgets) const;
+ /// Launching of a edit operation on the feature
+ /// \param theFeature feature for editing
+ virtual void editFeature(FeaturePtr theFeature);
+
+ /// Returns true if the operation can be committed. Result in default implementation is true.
+ /// \return boolean value
+ virtual bool canCommitOperation() const;
+
/// Creates an operation and send it to loop
/// \param theCmdId the operation name
- virtual void launchOperation(const QString& theCmdId);
+ /// \param isStartAfterCommitOnly operation is launched if there is no active operation or
+ /// it is committed
+ virtual void launchOperation(const QString& theCmdId,
+ const bool& isStartAfterCommitOnly);
/// Realizes some functionality by an operation start
/// Displays all sketcher sub-Objects, hides sketcher result, appends selection filters
/// \param theObject a model object
virtual bool canDisplayObject(const ObjectPtr& theObject) const;
+ /// Returns parent result if accepted, true if the started operation is a nested operation
+ /// of the previous operation
+ /// \param thePreviousOperationKind a kind of previous operation
+ /// \param theStartedOperationKind a kind of a new operation
+ virtual bool canUsePreselection(const QString& thePreviousOperationKind,
+ const QString& theStartedOperationKind);
+
/// Make some functionality after the objects are hidden in viewer
/// \param theObjects a list of hidden objects
- virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
+ //virtual void processHiddenObject(const std::list<ObjectPtr>& theObjects);
/// Returns true if selection for the object can be activate.
/// For sketch operation allow the selection activation if the operation is edit, for other
/// \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
+ /// Add menu items for viewer into the actions map
/// \param theStdActions a map of standard actions
+ /// \param theParent a parent widget
+ /// \param theMenuActions map of action/menu for the desirable index in the viewer menu
/// \return true if items are added and there is no necessity to provide standard menu
- virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const;
+ virtual bool addViewerMenu(const QMap<QString, QAction*>& theStdActions,
+ QWidget* theParent,
+ QMap<int, QAction*>& theMenuActions) const;
/// Returns a list of modes, where the AIS objects should be activated
/// \param theModes a list of modes
virtual void activeSelectionModes(QIntList& theModes);
+ /// Appends specific selection modes for the module to the list of types
+ /// \param theModesType combination of available selection filters
+ /// \param theModes a selection modes to be extended
+ virtual void moduleSelectionModes(int theModesType, QIntList& theModes);
+
+ /// Appends into container of filters module filters corresponded to the modes type
+ /// \param theModesType combination of available selection filters
+ /// \param theSelectionFilters [out] container to be extend by elements
+ virtual void moduleSelectionFilters(int theModesType,
+ SelectMgr_ListOfFilter& theSelectionFilters);
+
/// 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();
PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
/// Returns sketch reentrant manager
- PartSet_SketcherReetntrantMgr* sketchReentranceMgr() { return mySketchReentrantMgr; }
+ PartSet_SketcherReentrantMgr* sketchReentranceMgr() const { return mySketchReentrantMgr; }
+
+ /// Find object and attribute(if selected) for the given viewer selection
+ /// \param theSelected a viewer selection
+ /// \param theObject a selected model object
+ /// \param theAttribute a selected model attribute
+ virtual void getGeomSelection(const std::shared_ptr<ModuleBase_ViewerPrs>& theSelected,
+ ObjectPtr& theObject, AttributePtr& theAttribute);
/// Returns listener of overconstraint signal
/// \return the listener
PartSet_OverconstraintListener* overconstraintListener() { return myOverconstraintListener; }
+ /// Returns true if the current operation is not reentrant and the current state of the
+ /// application is not in launch operation mode
+ /// \return boolean value
+ bool isSketchNeutralPointActivated() const;
+
/// Performs functionality on closing document
virtual void closeDocument();
/// \param theFeature a feature
void setCustomized(const FeaturePtr& theFeature);
+ /// Return true if the custom presentation is activated
+ /// \param theFlag a flag of level of customization, which means that only part of sub-elements
+ /// \return boolean value
+ virtual bool isCustomPrsActivated(const ModuleBase_CustomizeFlag& theFlag) const;
+
/// Activate custom presentation for the object
/// \param theFeature a feature instance
/// \param theFlag a flag of level of customization, which means that only part of sub-elements
const bool theUpdateViewer);
/// Modifies the given presentation in the custom way.
- virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
+ virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+ AISObjectPtr thePrs,
std::shared_ptr<GeomAPI_ICustomPrs> theCustomPrs);
+ /// Modifies the given presentation in the custom way after usual customize is performed.
+ virtual bool afterCustomisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+ AISObjectPtr thePrs,
+ GeomCustomPrsPtr theCustomPrs);
+
/// 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
/// Returns the viewer Z layer
int getVisualLayerId() const { return myVisualLayerId; }
+ /// Create specific for the module presentation
+ /// \param theResult an object for presentation
+ /// \return created presentation or NULL(default value)
+ virtual Handle(AIS_InteractiveObject) createPresentation(
+ const std::shared_ptr<ModelAPI_Result>& theResult);
+
//! Returns data object by AIS
virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
+ //! Returns true if the presentation can be shown in shading mode
+ //! \param theAIS presentation to be checked
+ //! \return boolean value
+ virtual bool canBeShaded(Handle(AIS_InteractiveObject) theAIS) const;
+
/// Update state of pop-up menu items in viewer
/// \param theStdActions - a map of standard actions
- virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions);
+ virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions);
+
+ /// Returns true if the action should be always enabled
+ /// \param theActionId an action index: Accept or Accept All
+ /// \return boolean value
+ virtual bool isActionEnableStateFixed(const int theActionId) const;
//! 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
/// \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);
/// \return theAttribute
virtual AttributePtr findAttribute(const ObjectPtr& theObject, const GeomShapePtr& theGeomShape);
-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();
+ /// Returns reentrant message if it was accepted
+ virtual std::shared_ptr<Events_Message> reentrantMessage();
+ /// Put current selection into reentrant message
+ /// \param theMessage a message of reentrant operation
+ virtual void setReentrantPreSelection(const std::shared_ptr<Events_Message>& theMessage);
+
+ /// Returns the workshop
+ XGUI_Workshop* getWorkshop() const;
+
+public slots:
/// Slolt called on object display
/// \param theObject a data object
/// \param theAIS a presentation object
/// \param theEvent the key event
void onKeyRelease(ModuleBase_IViewWindow* theWnd, QKeyEvent* theEvent);
- /// SLOT, that is called by the current operation filling with the preselection.
- /// It commits the operation of it is can be committed
- void onOperationActivatedByPreselection();
-
/// A slot called on view window creation
void onViewCreated(ModuleBase_IViewWindow*);
- /// A slot to change property panel title on change of boolean operation type
- /// \param theOperation the operation type
- void onBooleanOperationChange(int theOperation);
+ /// A slot to change property panel title by choice type change if the title information
+ /// exists in the XML definition of this control attribute
+ /// \param theWidget a sender
+ /// \param theIndex the current choice index
+ void onChoiceChanged(ModuleBase_ModelWidget* theWidget, int theIndex);
protected:
- /// Register validators for this module
- virtual void registerValidators();
+ /// Appends specific selection modes for the module to the list of types
+ /// \param theModes a selection modes to be extended
+ virtual void customSubShapesSelectionModes(QIntList& theModes);
- /// Register selection filters for this module
- virtual void registerFilters();
+ /// Sets the constraints states in internal map. If the feature kind is a dimensional constraint
+ /// other dimensions are shown.
+ /// \param theFeatureKindId a feature kind
+ void storeConstraintsState(const std::string& theFeatureKindId);
- /// Register properties of this module
- virtual void registerProperties();
+ /// If the feature kind is a geometrical or dimensional constraint, set visible state for
+ /// all types of constraints
+ /// \param theFeatureKindId a feature kind
+ void updateConstraintsState(const std::string& theFeatureKind);
+
+ /// Register validators for this module
+ virtual void registerValidators();
/// 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);
+ /// Updates reentrant manager state or sketcher operations for the started operation
+ /// \param theOperation the started operation
+ void updateSketcherOnStart(ModuleBase_Operation* theOperation);
+
+ /// Updates presetnations of results and arguments by operation start
+ /// \param theOperation the started operation
+ void updatePresentationsOnStart(ModuleBase_Operation* theOperation);
+
private slots:
void onTreeViewDoubleClick(const QModelIndex&);
void onActiveDocPopup(const QPoint&);
private:
-
//! Delete features
virtual bool deleteObjects();
- /// Returns the workshop
- XGUI_Workshop* getWorkshop() const;
+ void setDefaultConstraintShown();
- private:
+private:
+ bool myIsOperationIsLaunched; /// state of application between launch and stop operation
SelectMgr_ListOfFilter mySelectionFilters;
PartSet_SketcherMgr* mySketchMgr;
- PartSet_SketcherReetntrantMgr* mySketchReentrantMgr;
+ PartSet_SketcherReentrantMgr* mySketchReentrantMgr;
PartSet_MenuMgr* myMenuMgr;
/// A default custom presentation, which is used for references objects of started operation
PartSet_CustomPrs* myCustomPrs;
/// backup of the visible state to restore them by operation stop
QMap<PartSet_Tools::ConstraintVisibleState, bool> myHasConstraintShown;
- QModelIndex aActivePartIndex;
+ /// backup of selection in the viewer, it is used only to store selection before
+ /// redisplay and restore it after
+ PartSet_SketcherMgr::FeatureToSelectionMap myCurrentSelection;
+ QModelIndex myActivePartIndex;
};
#endif
