Salome HOME
#1371 Using auxilliary Sketch elements in any Feature
[modules/shaper.git] / src / ModuleBase / ModuleBase_IModule.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3
4 #include "ModuleBase_IModule.h"
5 #include "ModuleBase_IViewer.h"
6 #include "ModuleBase_ViewerPrs.h"
7 #include "ModuleBase_Operation.h"
8 #include "ModuleBase_ISelection.h"
9 #include "ModuleBase_OperationDescription.h"
10 #include "ModuleBase_OperationFeature.h"
11 #include "ModuleBase_ModelWidget.h"
12
13 #include <Events_Loop.h>
14
15 #include <ModelAPI_Events.h>
16 #include <ModelAPI_CompositeFeature.h>
17 #include <ModelAPI_Session.h>
18 #include "ModelAPI_Tools.h"
19
20 #include <Config_PointerMessage.h>
21 #include <Config_WidgetReader.h>
22 #include <Config_ModuleReader.h>
23
24 #include <QAction>
25
26 ModuleBase_IModule::ModuleBase_IModule(ModuleBase_IWorkshop* theParent)
27   : QObject(theParent), myWorkshop(theParent) 
28 {
29   connect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
30
31
32   //connect(myWorkshop->viewer(), SIGNAL(mousePress(QMouseEvent*)), this,
33   //        SLOT(onMousePressed(QMouseEvent*)));
34   //connect(myWorkshop->viewer(), SIGNAL(mouseRelease(QMouseEvent*)), this,
35   //        SLOT(onMouseReleased(QMouseEvent*)));
36   //connect(myWorkshop->viewer(), SIGNAL(mouseMove(QMouseEvent*)), this,
37   //        SLOT(onMouseMoved(QMouseEvent*)));
38   //connect(myWorkshop->viewer(), SIGNAL(keyRelease(QKeyEvent*)), this,
39   //        SLOT(onKeyRelease(QKeyEvent*)));
40   //connect(myWorkshop->viewer(), SIGNAL(mouseDoubleClick(QMouseEvent*)), this,
41   //        SLOT(onMouseDoubleClick(QMouseEvent*)));
42 }
43
44 void ModuleBase_IModule::launchOperation(const QString& theCmdId)
45 {
46   if (!myWorkshop->canStartOperation(theCmdId))
47     return;
48
49   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
50                                              (createOperation(theCmdId.toStdString()));
51   if (aFOperation) {
52     ModuleBase_ISelection* aSelection = myWorkshop->selection();
53     // Initialise operation with preliminary selection
54     aFOperation->initSelection(aSelection, myWorkshop->viewer());
55     sendOperation(aFOperation);
56   }
57 }
58
59
60 void ModuleBase_IModule::sendOperation(ModuleBase_Operation* theOperation)
61 {
62   static Events_ID aModuleEvent = Events_Loop::eventByName(EVENT_OPERATION_LAUNCHED);
63   std::shared_ptr<Config_PointerMessage> aMessage =
64       std::shared_ptr<Config_PointerMessage>(new Config_PointerMessage(aModuleEvent, this));
65   aMessage->setPointer(theOperation);
66   Events_Loop::loop()->send(aMessage);
67 }
68
69 Handle(AIS_InteractiveObject) ModuleBase_IModule::createPresentation(const ResultPtr& theResult)
70 {
71   return Handle(AIS_InteractiveObject)();
72 }
73
74 QString ModuleBase_IModule::getFeatureError(const FeaturePtr& theFeature)
75 {
76   return ModelAPI_Tools::getFeatureError(theFeature).c_str();
77 }
78
79 void ModuleBase_IModule::grantedOperationIds(ModuleBase_Operation* theOperation,
80                                              QStringList& theIds) const
81 {
82 }
83
84 ModuleBase_Operation* ModuleBase_IModule::getNewOperation(const std::string& theFeatureId)
85 {
86   return new ModuleBase_OperationFeature(theFeatureId.c_str(), this);
87 }
88
89 bool ModuleBase_IModule::customizeObject(ObjectPtr theObject,
90                                          const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
91                                          const bool theUpdateViewer)
92 {
93   return false;
94 }
95
96 ModuleBase_Operation* ModuleBase_IModule::createOperation(const std::string& theFeatureId)
97 {
98   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
99                                                           (getNewOperation(theFeatureId));
100   // If the operation is launched as sub-operation of another then we have to initialize
101   // parent feature
102   ModuleBase_OperationFeature* aCurOperation = dynamic_cast<ModuleBase_OperationFeature*>
103                                                          (myWorkshop->currentOperation());
104   if (aCurOperation) {
105     FeaturePtr aFeature = aCurOperation->feature();
106     CompositeFeaturePtr aCompFeature =
107         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
108     if (aCompFeature) {
109       aFOperation->setParentFeature(aCompFeature);
110     }
111   }
112
113   std::string aXmlCfg, aDescription;
114   getXMLRepresentation(theFeatureId, aXmlCfg, aDescription);
115   aFOperation->getDescription()->setDescription(QString::fromStdString(aDescription));
116   aFOperation->getDescription()->setXmlRepresentation(QString::fromStdString(aXmlCfg));
117
118   return aFOperation;
119 }
120
121 void ModuleBase_IModule::createFeatures()
122 {
123   registerValidators();
124   registerFilters();
125   registerProperties();
126
127   Config_ModuleReader aXMLReader = Config_ModuleReader();
128   aXMLReader.readAll();
129   myFeaturesInFiles = aXMLReader.featuresInFiles();
130 }
131
132
133 void ModuleBase_IModule::actionCreated(QAction* theFeature)
134 {
135   theFeature->setStatusTip(theFeature->text());
136   connect(theFeature, SIGNAL(triggered(bool)), this, SLOT(onFeatureTriggered()));
137 }
138
139 bool ModuleBase_IModule::canEraseObject(const ObjectPtr& theObject) const
140 {
141   return true;
142 }
143
144 bool ModuleBase_IModule::canDisplayObject(const ObjectPtr& theObject) const
145 {
146   return true;
147 }
148
149 bool ModuleBase_IModule::canUndo() const
150 {
151   SessionPtr aMgr = ModelAPI_Session::get();
152   return aMgr->hasModuleDocument() && aMgr->canUndo() && !aMgr->isOperation();
153 }
154
155 bool ModuleBase_IModule::canRedo() const
156 {
157   SessionPtr aMgr = ModelAPI_Session::get();
158   return aMgr->hasModuleDocument() && aMgr->canRedo() && !aMgr->isOperation();
159 }
160
161 void ModuleBase_IModule::onFeatureTriggered()
162 {
163   QAction* aCmd = dynamic_cast<QAction*>(sender());
164   //Do nothing on uncheck
165   if (aCmd->isCheckable() && !aCmd->isChecked()) {
166     ModuleBase_Operation* anOperation = myWorkshop->findStartedOperation(aCmd->data().toString());
167     if (myWorkshop->canStopOperation(anOperation))
168       myWorkshop->abortOperation(anOperation);
169     else {
170       aCmd->setChecked(true);
171     }
172   }
173   else {
174     launchOperation(aCmd->data().toString());
175     emit operationLaunched();
176   }
177 }
178
179 void ModuleBase_IModule::editFeature(FeaturePtr theFeature)
180 {
181   std::string aFeatureId = theFeature->getKind();
182   if (!myWorkshop->canStartOperation(aFeatureId.c_str()))
183     return;
184
185   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
186                                                          (createOperation(aFeatureId));
187   if (aFOperation) {
188     aFOperation->setFeature(theFeature);
189     sendOperation(aFOperation);
190   }
191 }
192
193 bool ModuleBase_IModule::canActivateSelection(const ObjectPtr& theObject) const
194 {
195   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
196                                                      (myWorkshop->currentOperation());
197   return !aFOperation || !aFOperation->hasObject(theObject);
198 }
199
200 void ModuleBase_IModule::operationResumed(ModuleBase_Operation* theOperation) 
201 {
202   emit resumed(theOperation);
203 }
204
205 void ModuleBase_IModule::getXMLRepresentation(const std::string& theFeatureId,
206                                               std::string& theXmlCfg, std::string& theDescription)
207 {
208   std::string aPluginFileName = myFeaturesInFiles[theFeatureId];
209   Config_WidgetReader aWdgReader = Config_WidgetReader(aPluginFileName);
210   aWdgReader.readAll();
211
212   theXmlCfg = aWdgReader.featureWidgetCfg(theFeatureId);
213   theDescription = aWdgReader.featureDescription(theFeatureId);
214 }