+// 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>
+//
+
// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
#ifndef ModuleBase_IModule_H
#include <GeomAPI_Shape.h>
#include <GeomAPI_ICustomPrs.h>
+#include <SelectMgr_ListOfFilter.hxx>
+
#include <QString>
#include <QObject>
#include <QMap>
class QKeyEvent;
class QMenu;
class Config_WidgetAPI;
+
class ModuleBase_ModelWidget;
class ModuleBase_Operation;
+class ModuleBase_ViewerPrs;
+class ModuleBase_ITreeNode;
class ModuleBase_IWorkshop;
+
class ModelAPI_Result;
+class Events_Message;
-class Handle_AIS_InteractiveObject;
+class AIS_InteractiveObject;
/**
* \ingroup GUI
virtual ~ModuleBase_IModule() {}
- /// 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() {};
+ virtual void storeSelection() {}
/// Restores the current selection
- virtual void restoreSelection() {};
+ virtual void restoreSelection() {}
- /// Reads description of features from XML file
+ /// Reads description of features from XML file
virtual void createFeatures();
/// Called on creation of menu item in desktop
virtual void actionCreated(QAction*);
- /// 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
- 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);
/// Executes feature as a modal dialog box
/// \param theCmdId the operation name
/// Creates custom widgets for property panel
/// \param theType a type of widget
/// \param theParent the parent object
- /// \param theWidgetApi the widget configuration. The attribute of the model widget is obtained from
- virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
+ /// \param theWidgetApi the widget configuration.
+ /// The attribute of the model widget is obtained from
+ virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
+ QWidget* theParent,
Config_WidgetAPI* theWidgetApi)
{
return 0;
/// It is called as on clearing of property panel as on filling with new widgets
virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}
- /// Have an opportunity to create widgets for the current operation instead of standard creation in workshop
+ /// Have an opportunity to create widgets for the current operation
+ /// instead of standard creation in workshop
/// \param theOperation a started operation
/// \param theWidgets a list of created widgets
/// \return boolean result, false by default
/// \param theObject a model object
virtual bool canDisplayObject(const ObjectPtr& theObject) const;
+ /// Returns whether the started operation may use preselection of the previous one
+ /// Cases are: previous operation is null, edit operation, previuos and started operations
+ /// kinds are the same
+ /// \param thePreviousOperationKind a kind of previous operation
+ /// \param theStartedOperationKind a kind of a started 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) = 0;
+
+ /// 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) = 0;
+
+ /// Returns types of registered module selection filters
+ /// \param theSelectionFilters [out] container of type value
+ virtual QIntList selectionFilters() { return QIntList(); }
+
+ /// Returns selection filter
+ /// \param theType selection filter type
+ /// \param theFilter instance of filter
+ virtual Handle(SelectMgr_Filter) selectionFilter(const int theType) = 0;
/// 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 { return false; };
+ virtual bool isCustomPrsActivated(const ModuleBase_CustomizeFlag& theFlag) const
+ { return false; };
/// Activate custom presentation for the object. Default realization is empty.
/// \param theFeature a feature instance
const bool theUpdateViewer) {}
/// Modifies the given presentation in the custom way.
- virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult, AISObjectPtr thePrs,
+ virtual bool customisePresentation(std::shared_ptr<ModelAPI_Result> theResult,
+ AISObjectPtr thePrs,
+ GeomCustomPrsPtr theCustomPrs) { return false; };
+
+ /// 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) { return false; };
/// Update the object presentable properties such as color, lines width and other
/// Create specific for the module presentation
/// \param theResult an object for presentation
/// \return created presentation or NULL(default value)
- virtual Handle_AIS_InteractiveObject createPresentation(
+ virtual Handle(AIS_InteractiveObject) createPresentation(
const std::shared_ptr<ModelAPI_Result>& theResult);
//! Returns data object by AIS
virtual AttributePtr findAttribute(const ObjectPtr& theObject,
const GeomShapePtr& theGeomShape) = 0;
+ /// Returns reentrant message if it was accepted
+ virtual std::shared_ptr<Events_Message> reentrantMessage() = 0;
+
+ /// Put current selection into reentrant message
+ /// \param theMessage a message of reentrant operation
+ virtual void setReentrantPreSelection(const std::shared_ptr<Events_Message>& theMessage) = 0;
+
/// Returns XML information by the feature index
/// \param theFeatureId a feature id
/// \param theXmlCfg XML configuration
void getXMLRepresentation(const std::string& theFeatureId, std::string& theXmlCfg,
std::string& theDescription);
-signals:
- /// Signal which is emitted when operation is launched
- void operationLaunched();
+ /// Returns root tree node which represents a data model
+ virtual ModuleBase_ITreeNode* rootNode() const = 0;
+signals:
/// Segnal emitted when an operation is resumed
/// \param theOp a resumed operation
void resumed(ModuleBase_Operation* theOp);
/// 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() {}
