1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 #include "XGUI_WorkshopListener.h"
4 #include "XGUI_Workshop.h"
5 #include "XGUI_Displayer.h"
6 #include "XGUI_ErrorMgr.h"
7 #include "XGUI_OperationMgr.h"
8 #include "XGUI_SalomeConnector.h"
9 #include "XGUI_ActionsMgr.h"
10 #include "XGUI_PropertyPanel.h"
11 #include "XGUI_ModuleConnector.h"
12 #include "XGUI_QtEvents.h"
15 #include <AppElements_MainWindow.h>
18 #include <ModuleBase_IModule.h>
19 #include <ModuleBase_Events.h>
21 #include <ModelAPI_Object.h>
22 #include <ModelAPI_Events.h>
23 #include <ModelAPI_Session.h>
24 #include <ModelAPI_Result.h>
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_Data.h>
27 #include <ModelAPI_ResultBody.h>
28 #include <ModelAPI_ResultGroup.h>
29 #include <ModelAPI_ResultCompSolid.h>
30 #include <ModelAPI_Tools.h>
32 #include <Events_Loop.h>
33 #include <Events_LongOp.h>
35 #include <ModuleBase_IWorkshop.h>
37 #include <ModuleBase_Operation.h>
38 #include <ModuleBase_OperationDescription.h>
39 #include <ModuleBase_OperationFeature.h>
40 #include <ModuleBase_Tools.h>
41 #include <ModuleBase_IViewer.h>
42 #include <ModuleBase_FilterFactory.h>
43 #include <ModuleBase_WidgetSelector.h>
45 #include <Config_FeatureMessage.h>
46 #include <Config_PointerMessage.h>
47 #include <Config_SelectionFilterMessage.h>
48 #include <Config_Keywords.h>
49 #include <Events_InfoMessage.h>
51 #include <QApplication>
52 #include <QMainWindow>
61 //#define DEBUG_FEATURE_CREATED
62 //#define DEBUG_FEATURE_REDISPLAY
63 //#define DEBUG_FEATURE_UPDATED
64 //#define DEBUG_RESULT_COMPSOLID
66 #ifdef DEBUG_FEATURE_REDISPLAY
67 const std::string DebugFeatureKind = "";//"Extrusion";
70 XGUI_WorkshopListener::XGUI_WorkshopListener(ModuleBase_IWorkshop* theWorkshop)
71 : myWorkshop(theWorkshop),
74 XGUI_OperationMgr* anOperationMgr = workshop()->operationMgr();
77 //******************************************************
78 XGUI_WorkshopListener::~XGUI_WorkshopListener(void)
82 //******************************************************
83 void XGUI_WorkshopListener::initializeEventListening()
85 //Initialize event listening
86 Events_Loop* aLoop = Events_Loop::loop();
87 aLoop->registerListener(this, Events_InfoMessage::errorID()); //!< Listening application errors.
88 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
89 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED));
90 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
91 aLoop->registerListener(this, Events_LongOp::eventID());
92 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_PLUGIN_LOADED));
93 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_SELFILTER_LOADED));
95 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED));
96 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED));
97 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION));
98 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_UPDATE_BY_WIDGET_SELECTION));
101 //******************************************************
102 void XGUI_WorkshopListener::processEvent(const std::shared_ptr<Events_Message>& theMessage)
104 if (QApplication::instance()->thread() != QThread::currentThread()) {
106 std::cout << "XGUI_Workshop::processEvent: " << "Working in another thread." << std::endl;
108 SessionPtr aMgr = ModelAPI_Session::get();
109 PostponeMessageQtEvent* aPostponeEvent = new PostponeMessageQtEvent(theMessage);
110 QApplication::postEvent(this, aPostponeEvent);
114 // Process creation of Part
115 if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED)) {
116 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aUpdMsg =
117 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
118 onFeatureCreatedMsg(aUpdMsg);
120 XGUI_SalomeConnector* aSalomeConnector = workshop()->salomeConnector();
121 if (aSalomeConnector)
122 aSalomeConnector->createPreferences();
123 myUpdatePrefs = false;
126 else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED)) {
127 myUpdatePrefs = true;
130 else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY)) {
131 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aUpdMsg =
132 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
133 onFeatureRedisplayMsg(aUpdMsg);
134 } else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION)) {
135 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aUpdMsg =
136 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
137 onFeatureEmptyPresentationMsg(aUpdMsg);
138 } else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_UPDATE_BY_WIDGET_SELECTION)) {
139 ModuleBase_ModelWidget* aWidget = workshop()->propertyPanel()->activeWidget();
141 ModuleBase_WidgetSelector* aWidgetSelector =
142 dynamic_cast<ModuleBase_WidgetSelector*>(aWidget);
144 myWorkshop->setSelected(aWidgetSelector->getAttributeSelection());
148 //Update property panel on corresponding message. If there is no current operation (no
149 //property panel), or received message has different feature to the current - do nothing.
150 else if (theMessage->eventID() == Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED)) {
151 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> anUpdateMsg =
152 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
153 onFeatureUpdatedMsg(anUpdateMsg);
154 } else if (theMessage->eventID() == Events_LongOp::eventID()) {
155 if (Events_LongOp::isPerformed()) {
156 QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
158 QApplication::restoreOverrideCursor();
161 else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_SELFILTER_LOADED)) {
162 std::shared_ptr<Config_SelectionFilterMessage> aMsg =
163 std::dynamic_pointer_cast<Config_SelectionFilterMessage>(theMessage);
165 ModuleBase_FilterFactory* aFactory = myWorkshop->selectionFilters();
166 if (!aMsg->attributeId().empty()) {
167 aFactory->assignFilter(aMsg->selectionFilterId(), aMsg->featureId(), aMsg->attributeId(),
171 } else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)) {
172 // the viewer's update context will not happens until viewer updated is emitted
173 workshop()->displayer()->enableUpdateViewer(false);
174 } else if (theMessage->eventID() == Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)) {
175 // the viewer's update context is unblocked, the viewer's update works
176 XGUI_Displayer* aDisplayer = workshop()->displayer();
177 aDisplayer->enableUpdateViewer(true);
179 //Show error dialog if error message received.
180 std::shared_ptr<Events_InfoMessage> anIngfoMsg =
181 std::dynamic_pointer_cast<Events_InfoMessage>(theMessage);
183 emit errorOccurred(anIngfoMsg);
188 SessionPtr aMgr = ModelAPI_Session::get();
189 AppElements_MainWindow* aMainWindow = workshop()->mainWindow();
190 if (aMgr->isModified() != aMainWindow->isModifiedState())
191 aMainWindow->setModifiedState(aMgr->isModified());
195 //******************************************************
196 void XGUI_WorkshopListener::onFeatureUpdatedMsg(
197 const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
199 #ifdef DEBUG_FEATURE_UPDATED
200 std::set<ObjectPtr> anObjects = theMsg->objects();
201 std::set<ObjectPtr>::const_iterator aIt;
203 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
204 anInfo.append(ModuleBase_Tools::objectInfo((*aIt)));
206 QString anInfoStr = anInfo.join(";\t");
207 qDebug(QString("onFeatureUpdatedMsg: %1, %2")
208 .arg(anObjects.size()).arg(anInfoStr).toStdString().c_str());
210 std::set<ObjectPtr> aFeatures = theMsg->objects();
211 XGUI_OperationMgr* anOperationMgr = workshop()->operationMgr();
212 if (anOperationMgr->hasOperation()) {
213 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
214 (anOperationMgr->currentOperation());
216 FeaturePtr aCurrentFeature = aFOperation->feature();
217 std::set<ObjectPtr>::const_iterator aIt;
218 for (aIt = aFeatures.begin(); aIt != aFeatures.end(); ++aIt) {
219 ObjectPtr aNewFeature = (*aIt);
220 if (aNewFeature == aCurrentFeature) {
221 workshop()->propertyPanel()->updateContentWidget(aCurrentFeature);
227 //anOperationMgr->onValidateOperation();
229 //if (myObjectBrowser)
230 // myObjectBrowser->processEvent(theMsg);
233 //******************************************************
234 void XGUI_WorkshopListener::
235 onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
237 std::set<ObjectPtr> anObjects = theMsg->objects();
238 std::set<ObjectPtr>::const_iterator aIt;
240 #ifdef DEBUG_FEATURE_REDISPLAY
242 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
243 anInfo.append(ModuleBase_Tools::objectInfo((*aIt)));
245 QString anInfoStr = anInfo.join(";\t");
246 qDebug(QString("onFeatureRedisplayMsg: %1, %2")
247 .arg(anObjects.size()).arg(anInfoStr).toStdString().c_str());
250 XGUI_Workshop* aWorkshop = workshop();
251 XGUI_Displayer* aDisplayer = aWorkshop->displayer();
252 bool aFirstVisualizedBody = false;
254 bool aRedisplayed = false;
255 //std::list<ObjectPtr> aHiddenObjects;
256 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
257 ObjectPtr aObj = (*aIt);
259 // Hide the object if it is invalid or concealed one
260 bool aHide = !aObj->data() || !aObj->data()->isValid() ||
261 aObj->isDisabled() || (!aObj->isDisplayed());
262 if (!aHide) { // check that this is not hidden result
263 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(aObj);
264 aHide = aRes && aRes->isConcealed();
266 // Hide the presentation with an empty shape. But isDisplayed state of the object should not
267 // be changed to the object becomes visible when the shape becomes not empty
268 if (!aHide && aRes.get())
269 aHide = !aRes->shape().get() || aRes->shape()->isNull();
272 #ifdef DEBUG_RESULT_COMPSOLID
273 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(aObj);
275 ResultCompSolidPtr aCompSolidRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(aRes);
276 if (aCompSolidRes.get()) {
277 qDebug(QString("COMPSOLID, numberOfSubs = %1")
278 .arg(aCompSolidRes->numberOfSubs()).toStdString().c_str());
280 if (ModelAPI_Tools::compSolidOwner(aRes))
281 qDebug("COMPSOLID sub-object");
284 #ifdef DEBUG_FEATURE_REDISPLAY
285 QString anObjInfo = ModuleBase_Tools::objectInfo((aObj));
286 FeaturePtr aFeature = ModelAPI_Feature::feature(aObj);
287 if (aFeature.get()) {
288 std::string aKind = aFeature->getKind();
289 if (aKind == DebugFeatureKind || DebugFeatureKind.empty()) {
290 qDebug(QString("visible=%1, hide=%2 : display= %2").arg(aDisplayer->isVisible(aObj))
291 .arg(aHide).arg(anObjInfo).toStdString().c_str());
296 //we should provide objects which are hidden in the viewer, e.g. sketch always should
297 // visualizes all sub-features, if some features are to be hidden, sould be proposed may
298 // be to removed #1223
299 // aHiddenObjects.push_back(aObj);
300 aRedisplayed = aDisplayer->erase(aObj, false) || aRedisplayed;
301 #ifdef DEBUG_FEATURE_REDISPLAY
302 // Redisplay the visible object or the object of the current operation
303 bool isVisibleObject = aDisplayer->isVisible(aObj);
305 QString anObjInfo = ModuleBase_Tools::objectInfo((aObj));
309 // Redisplay the visible object or the object of the current operation
310 bool isVisibleObject = aDisplayer->isVisible(aObj);
311 #ifdef DEBUG_FEATURE_REDISPLAY
312 QString anObjInfo = ModuleBase_Tools::objectInfo((aObj));
315 if (isVisibleObject) { // redisplay visible object
316 //displayObject(aObj); // In order to update presentation
317 // in order to avoid the check whether the object can be redisplayed, the exact method
318 // of redisplay is called. This modification is made in order to have the line is updated
319 // by creation of a horizontal constraint on the line by preselection
320 if (ModelAPI_Tools::hasSubResults(std::dynamic_pointer_cast<ModelAPI_Result>(aObj))) {
321 aRedisplayed = aDisplayer->erase(aObj, false) || aRedisplayed;
324 aRedisplayed = aDisplayer->redisplay(aObj, false) || aRedisplayed;
325 // Deactivate object of current operation from selection
326 aWorkshop->deactivateActiveObject(aObj, false);
328 } else { // display object if the current operation has it
329 if (displayObject(aObj, aFirstVisualizedBody)) {
331 // Deactivate object of current operation from selection
332 aWorkshop->deactivateActiveObject(aObj, false);
337 // this processing should be moved in another place in order to do not cause problems in
338 // flush messages chain
339 //if (aHiddenObjects.size() > 0)
340 // myWorkshop->module()->processHiddenObject(aHiddenObjects);
342 bool isCustomized = customizeCurrentObject(anObjects, aRedisplayed);
343 if (aRedisplayed || isCustomized) {
344 Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION));
346 //VSV FitAll updated viewer by it self
347 if (aFirstVisualizedBody)
348 myWorkshop->viewer()->fitAll();
350 aDisplayer->updateViewer();
354 //******************************************************
355 void XGUI_WorkshopListener::
356 onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
358 std::set<ObjectPtr> anObjects = theMsg->objects();
359 std::set<ObjectPtr>::const_iterator aIt;
360 #ifdef DEBUG_FEATURE_CREATED
362 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
363 anInfo.append(ModuleBase_Tools::objectInfo((*aIt)));
365 QString anInfoStr = anInfo.join(";\t");
366 qDebug(QString("onFeatureCreatedMsg: %1, %2")
367 .arg(anObjects.size()).arg(anInfoStr).toStdString().c_str());
370 bool aFirstVisualizedBody = false;
372 //bool aHasPart = false;
373 bool aDisplayed = false;
374 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
375 ObjectPtr anObject = *aIt;
377 #ifdef DEBUG_RESULT_COMPSOLID
378 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
380 ResultCompSolidPtr aCompSolidRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(aRes);
381 if (aCompSolidRes.get()) {
382 qDebug(QString("COMPSOLID, numberOfSubs = %1")
383 .arg(aCompSolidRes->numberOfSubs()).toStdString().c_str());
385 if (ModelAPI_Tools::compSolidOwner(aRes))
386 qDebug("COMPSOLID sub-object");
389 // the validity of the data should be checked here in order to avoid display of the objects,
390 // which were created, then deleted, but flush for the creation event happens after that
391 // we should not display disabled objects
392 bool aHide = !anObject->data()->isValid() ||
393 anObject->isDisabled() ||
394 !anObject->isDisplayed();
395 if (!aHide) { // check that this is not hidden result
396 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
397 bool isConcealed = aRes && aRes->isConcealed();
398 aHide = aRes && aRes->isConcealed();
399 // Hide the presentation with an empty shape. But isDisplayed state of the object should not
400 // be changed to the object becomes visible when the shape becomes not empty
401 if (!aHide && aRes.get())
402 aHide = !aRes->shape().get() || aRes->shape()->isNull();
405 // setDisplayed has to be called in order to synchronize internal state of the object
406 // with list of displayed objects
407 if (myWorkshop->module()->canDisplayObject(anObject)) {
408 anObject->setDisplayed(true);
409 aDisplayed = displayObject(*aIt, aFirstVisualizedBody);
411 anObject->setDisplayed(false);
415 bool isCustomized = customizeCurrentObject(anObjects, aDisplayed);
417 //if (myObjectBrowser)
418 // myObjectBrowser->processEvent(theMsg);
420 Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_EMPTY_AIS_PRESENTATION));
421 //VSV FitAll updated viewer by it self
422 if (aFirstVisualizedBody)
423 myWorkshop->viewer()->fitAll();
425 workshop()->displayer()->updateViewer();
427 //if (aHasPart) { // TODO: Avoid activate last part on loading of document
428 // activateLastPart();
432 //******************************************************
433 void XGUI_WorkshopListener::onFeatureEmptyPresentationMsg(
434 const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& theMsg)
436 std::set<ObjectPtr> anObjects = theMsg->objects();
437 std::set<ObjectPtr>::const_iterator aIt;
438 #ifdef DEBUG_FEATURE_CREATED
440 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
441 anInfo.append(ModuleBase_Tools::objectInfo((*aIt)));
443 QString anInfoStr = anInfo.join(";\t");
444 qDebug(QString("onFeatureEmptyPresentationMsg: %1, %2")
445 .arg(anObjects.size()).arg(anInfoStr).toStdString().c_str());
448 XGUI_Workshop* aWorkshop = workshop();
449 XGUI_Displayer* aDisplayer = aWorkshop->displayer();
451 bool aRedisplayed = false;
452 for (aIt = anObjects.begin(); aIt != anObjects.end(); ++aIt) {
453 ObjectPtr anObject = *aIt;
454 aRedisplayed = aDisplayer->erase(anObject, false) || aRedisplayed;
458 aDisplayer->updateViewer();
461 bool XGUI_WorkshopListener::event(QEvent * theEvent)
463 PostponeMessageQtEvent* aPostponedEv = dynamic_cast<PostponeMessageQtEvent*>(theEvent);
465 std::shared_ptr<Events_Message> aEventPtr = aPostponedEv->postponedMessage();
466 processEvent(aEventPtr);
472 //**************************************************************
473 bool XGUI_WorkshopListener::displayObject(ObjectPtr theObj, bool& theFirstVisualizedBody)
475 #ifdef DEBUG_RESULT_COMPSOLID
476 ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObj);
477 if (aRes.get() && (ModelAPI_Tools::hasSubResults(aRes) || ModelAPI_Tools::compSolidOwner(aRes))) {
478 ResultCompSolidPtr aCompSolidRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(aRes);
479 if (aCompSolidRes.get()) {
480 qDebug("COMPSOLID: displayObject");
485 bool aDisplayed = false;
486 XGUI_Workshop* aWorkshop = workshop();
487 // do not display the object if it has sub objects. They should be displayed separately.
488 if (!aWorkshop->module()->canDisplayObject(theObj) ||
489 ModelAPI_Tools::hasSubResults(std::dynamic_pointer_cast<ModelAPI_Result>(theObj)))
492 XGUI_Displayer* aDisplayer = aWorkshop->displayer();
493 int aNb = aDisplayer->objectsCount();
494 aDisplayed = aDisplayer->display(theObj, false);
496 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObj);
497 if (aNb == 0 && aResult.get()) {
498 std::string aResultGroupName = aResult->groupName();
499 if (aResultGroupName == ModelAPI_ResultBody::group() ||
500 aResultGroupName == ModelAPI_ResultGroup::group()) {
501 std::shared_ptr<GeomAPI_Shape> aShapePtr = ModelAPI_Tools::shape(aResult);
502 theFirstVisualizedBody = aShapePtr.get() != NULL;
508 bool XGUI_WorkshopListener::customizeCurrentObject(const std::set<ObjectPtr>& theObjects,
509 bool theForceRedisplay)
511 XGUI_OperationMgr* anOperationMgr = workshop()->operationMgr();
512 FeaturePtr aCurrentFeature;
513 if (anOperationMgr->hasOperation()) {
514 ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
515 (anOperationMgr->currentOperation());
517 aCurrentFeature = aFOperation->feature();
521 bool aCustomized = false;
522 if (aCurrentFeature.get()) {
523 // the customize presentation should be redisplayed if force redislayed is true or
524 // if a list of message objects contains the operation feature for case when
525 // the feature is hidden, but arguments of the feature are modified
526 // e.g. extrusion is hidden(h=0) but sketch is chosen
527 if (theForceRedisplay || theObjects.find(aCurrentFeature) != theObjects.end()) {
528 aCustomized = myWorkshop->module()->customizeObject(aCurrentFeature,
529 ModuleBase_IModule::CustomizeArguments, false) || aCustomized;
530 aCustomized = myWorkshop->module()->customizeObject(aCurrentFeature,
531 ModuleBase_IModule::CustomizeResults, false) || aCustomized;
532 aCustomized = myWorkshop->module()->customizeObject(aCurrentFeature,
533 ModuleBase_IModule::CustomizeHighlightedObjects, false) || aCustomized;
539 XGUI_Workshop* XGUI_WorkshopListener::workshop() const
541 XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
542 return aConnector->workshop();