1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 * ModuleBase_OperationFeature.h
6 * Created on: Apr 2, 2014
10 #ifndef ModuleBase_OperationFeature_H
11 #define ModuleBase_OperationFeature_H
13 #include <ModuleBase.h>
14 #include <ModuleBase_Operation.h>
15 #include <ModuleBase_ViewerPrs.h>
17 #include <ModelAPI_Object.h>
18 #include <ModelAPI_CompositeFeature.h>
22 #include <QStringList>
26 class ModuleBase_ModelWidget;
27 class ModuleBase_ISelection;
28 class ModuleBase_IViewer;
29 class ModuleBase_IWorkshop;
34 * \class ModuleBase_OperationFeature
36 * \brief Base class for all operations
38 * Base class for all operations. If you perform an action it is reasonable to create
39 * operation intended for this. This is a base class for all operations which provides
40 * mechanism for correct starting operations, starting operations above already started
41 * ones, committing operations and so on. To create own operation it is reasonable to
42 * inherit it from this class and redefines virtual methods to provide own behavior
43 * Main virtual methods are
44 * - virtual bool isReadyToStart();
45 * - virtual void startOperation();
46 * - virtual void abortOperation();
47 * - virtual void commitOperation();
50 class MODULEBASE_EXPORT ModuleBase_OperationFeature : public ModuleBase_Operation
56 /// Appends to operation's history id, if it is an "edit" operation (myIsEditing == true)
57 static QString EditSuffix() { return "_E"; }
59 /// \param theId the operation identifier
60 /// \param theParent the QObject parent
61 ModuleBase_OperationFeature(const QString& theId = "", QObject* theParent = 0);
63 virtual ~ModuleBase_OperationFeature();
65 /// Returns True id the current operation is launched in editing mode
66 bool isEditOperation() const { return myIsEditing; }
68 /// Change the operation mode from create to edit.
69 /// The transaction and the operation name in the model history of transaction are the same.
70 /// It updates the edit state in the widgets of property panel
71 /// \param isEditState boolean state whether the operation should become editing or creating
72 // \param theRestartTransaction if true, the current model transaction is committed and
73 /// the new one is started
74 void setEditOperation(const bool& isEditState/*const bool theRestartTransaction*/);
76 /// Returns the operation feature
77 /// \return the feature
78 FeaturePtr feature() const;
80 /// Must return True if the operation's feature is valid.
81 /// Since IOperation does not have any feature returns false.
82 virtual bool isValid() const;
84 /// Sets the operation feature
85 void setFeature(FeaturePtr theFeature);
87 /// Returns True if the current operation works with the given object (feature or result)
88 virtual bool hasObject(ObjectPtr theObj) const;
90 /// Returns true if the object is displayed when the operation was started
91 /// \param theObject a feature or result of the operation feature
92 /// \return boolean value whether the object display state was changed
93 virtual bool isDisplayedOnStart(ObjectPtr theObject);
95 /// Initialisation of operation with preliminary selection
96 /// \param theSelection an instance of Selection class
97 /// \param theViewer a viewer to have the viewer the eye position
98 virtual void initSelection(ModuleBase_ISelection* theSelection,
99 ModuleBase_IViewer* theViewer);
101 /// \brief Set property pane to the operation
102 /// \param theProp a property panel instance
103 virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
105 /// \return Currently installed property panel
106 //ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
108 /// Activates widgets by preselection if it is accepted.
109 /// \param theGreeAttributeId a greed attribute id if there is in the current feature
110 /// \return last filled widget
111 virtual ModuleBase_ModelWidget* activateByPreselection(const std::string& theGreedAttributeId);
113 /// If the operation works with feature which is sub-feature of another one
114 /// then this variable has to be initialised by parent feature
115 /// before operation feature creating
116 void setParentFeature(CompositeFeaturePtr theParent);
118 /// \return Installed parent feature (can be NULL)
119 CompositeFeaturePtr parentFeature() const;
121 /// Stores the previous to the operation current feature
122 /// \param theFeature a feature
123 void setPreviousCurrentFeature(const FeaturePtr& theFeature);
125 /// Returns the previous to the operation current feature
126 /// \return theFeature a feature
127 FeaturePtr previousCurrentFeature();
131 /// Public slot. Verifies whether operation can be started and starts operation.
132 /// This slot is not virtual and cannot be redefined. Redefine startOperation method
133 /// to change behavior of operation. There is no point in using this method. It would
134 /// be better to inherit own operator from base one and redefine startOperation method
136 /// \return true if the start is successful
137 virtual bool start();
140 /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined.
141 /// Redefine abortOperation method to change behavior of operation instead
144 /// Commits operation
145 /// Public slot. Commits operation. This slot is not virtual and cannot be redefined.
146 /// Redefine commitOperation method to change behavior of operation instead
150 /// Displays the feature/results if it is hidden. It will be hided in stopOperation
151 virtual void startOperation();
153 /// Hide feature/results if they were hided on start
154 virtual void stopOperation();
156 /// Creates an operation new feature
157 /// \param theFlushMessage the flag whether the create message should be flushed
158 /// \returns the created feature
159 virtual FeaturePtr createFeature(const bool theFlushMessage = true);
161 /// Removes the preselection information and clears the map of preselection
162 void clearPreselection();
165 /// The operation feature to be handled
166 FeaturePtr myFeature;
168 /// a list of hidden objects, whic are diplayed by operation start
169 /// and should be hidden by operation stop
170 std::set<ObjectPtr> myVisualizedObjects;
172 /// Editing feature flag
175 /// List of pre-selected object
176 QList<ModuleBase_ViewerPrs> myPreSelection;
178 /// If the operation works with feature which is sub-feature of another one
179 /// then this variable has to be initialised by parent feature
180 /// before operation feature creating
181 CompositeFeaturePtr myParentFeature;
183 /// Last current feature before editing operation. It is cashed when Edit operation is started
184 /// in order to restore the document current feature on commit/abort this operation.
185 FeaturePtr myPreviousCurrentFeature;