-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+// 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 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>
//#include <StdSelect_FaceFilter.hxx>
#include <TopoDS_Shape.hxx>
#include <SelectMgr_ListOfFilter.hxx>
+#include <SelectMgr_Filter.hxx>
#include <QMap>
#include <QMenu>
#include <QObject>
#include <QModelIndex>
-#include <string>
-
+#include <map>
#include <memory>
+#include <string>
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 PartSet_RootNode;
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();
/// 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 theFeature a feature of the started operation
+ /// \param theXmlRepr an XML representation of the operation
/// \param theWidgets a list of created widgets
/// \return boolean result, false by default
- virtual bool createWidgets(ModuleBase_Operation* theOperation,
+ virtual bool createWidgets(const FeaturePtr& theFeature, const QString& theXmlRepr,
QList<ModuleBase_ModelWidget*>& theWidgets) const;
- /// Launching of a edit operation on the feature
+ /// Launching of a edit operation on the feature
/// \param theFeature feature for editing
virtual void editFeature(FeaturePtr theFeature);
/// Creates an operation and send it to loop
/// \param theCmdId the operation name
- /// \param isUpdatePropertyPanel if false, the property panel filling might be postponed
- virtual void launchOperation(const QString& theCmdId, const bool isUpdatePropertyPanel = true);
+ /// \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 activeSelectionModes(QIntList& theModes);
/// Appends specific selection modes for the module to the list of types
- /// \param theTypes a selection modes to be extended
- virtual void customSubShapesSelectionModes(QIntList& theTypes);
+ /// \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 theFilterTypes container of available selection filters
+ /// \param theSelectionFilters [out] container to be extend by elements
+ virtual void moduleSelectionFilters(const QIntList& theFilterTypes,
+ 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
PartSet_SketcherMgr* sketchMgr() const { return mySketchMgr; }
/// Returns sketch reentrant manager
- PartSet_SketcherReetntrantMgr* sketchReentranceMgr() const { 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
/// \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(std::shared_ptr<ModelAPI_Result> theResult,
- AISObjectPtr thePrs,
- std::shared_ptr<GeomAPI_ICustomPrs> theCustomPrs);
+ //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,
/// should be updated(e.g. only highlighted elements)
/// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
/// \returns true if the object is modified
- virtual bool customizeObject(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
- const bool theUpdateViewer);
+ virtual bool customizeFeature(ObjectPtr theObject, const ModuleBase_CustomizeFlag& theFlag,
+ const bool theUpdateViewer);
+
+ /// Disable displaying of custom mode
+ /// \param theMode a mode to disable
+ virtual void disableCustomMode(ModuleBase_CustomizeFlag theMode);
+
+ /// Enables disabled custom mode
+ virtual void enableCustomModes();
/// This method is called on object browser creation for customisation of module specific features
/// \param theObjectBrowser a pinter on Object Browser widget
/// 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);
+ virtual AISObjectPtr createPresentation(const ObjectPtr& theResult);
+
+ /// Customize presentation according to objects attributes
+ /// \param theObject an object for presentation
+ /// \param thePrs a presentation object
+ virtual void customizePresentation(const ObjectPtr& theObject, const AISObjectPtr& thePrs) const;
//! 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<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
/// \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 root tree node which represents a data model
+ virtual ModuleBase_ITreeNode* rootNode() const;
+
+ /// Returns the workshop
+ XGUI_Workshop* getWorkshop() const;
+
+ /// Reads description of features from XML file
+ virtual void createFeatures();
+
+ /// add texture
+ static void setTexture(const AISObjectPtr& thePrs, const ResultPtr& theResult);
+
+public slots:
/// Slolt called on object display
/// \param theObject a data object
/// \param theAIS a presentation object
/// Called on transformation in current viewer
/// \param theTrsfType type of tranformation
- void onViewTransformed(int theTrsfType = 2);
+ virtual void onViewTransformed(int theTrsfType = 2);
+
+ /// Called on remove conflicting constraints
+ void onRemoveConflictingConstraints();
protected slots:
/// Called when previous operation is finished
void onChoiceChanged(ModuleBase_ModelWidget* theWidget, int theIndex);
protected:
+ /// 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);
+
/// Sets the constraints states in internal map. If the feature kind is a dimensional constraint
/// other dimensions are shown.
/// \param theFeatureKindId a feature kind
/// Register validators for this module
virtual void registerValidators();
- /// Register selection filters for this module
- virtual void registerFilters();
-
- /// Register properties of this module
- virtual void registerProperties();
-
/// 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);
- /// 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 operationStartedInternal(ModuleBase_Operation* theOperation);
+ /// 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&);
//! Delete features
virtual bool deleteObjects();
- /// Returns the workshop
- XGUI_Workshop* getWorkshop() const;
-
void setDefaultConstraintShown();
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;
+
+ PartSet_RootNode* myRoot;
};
#endif
