Salome HOME
Minor code correction: undo/redo unification, show hide faces panel in debug, do...
[modules/shaper.git] / src / XGUI / XGUI_FacesPanel.cpp
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #include "XGUI_FacesPanel.h"
22
23 #include <Config_PropManager.h>
24 #include <Events_Loop.h>
25 #include <GeomAlgoAPI_CompoundBuilder.h>
26
27 #include <ModelAPI_Events.h>
28
29 #include <ModuleBase_ISelection.h>
30 #include "ModuleBase_IWorkshop.h"
31 #include "ModuleBase_ListView.h"
32 #include "ModuleBase_ResultPrs.h"
33 #include "ModuleBase_Tools.h"
34 #include "ModuleBase_ViewerPrs.h"
35
36 #include "XGUI_Tools.h"
37 #include "XGUI_Workshop.h"
38
39 #include <QAction>
40 #include <QCheckBox>
41 #include <QFocusEvent>
42 #include <QGridLayout>
43 #include <QListWidget>
44 #include <QMainWindow>
45
46 static const int LayoutMargin = 3;
47
48 //********************************************************************
49 XGUI_FacesPanel::XGUI_FacesPanel(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop)
50   : QDockWidget(theParent), myIsActive(false), myWorkshop(theWorkshop)
51 {
52   setWindowTitle(tr("Hide Faces"));
53   QAction* aViewAct = toggleViewAction();
54   setStyleSheet("::title { position: relative; padding-left: 5px; text-align: left center }");
55
56   QWidget* aContent = new QWidget(this);
57   QGridLayout* aMainLayout = new QGridLayout(aContent);
58   aMainLayout->setContentsMargins(LayoutMargin, LayoutMargin, LayoutMargin, LayoutMargin);
59   setWidget(aContent);
60
61   myHiddenOrTransparent = new QCheckBox(tr("Transparent"), aContent);
62   connect(myHiddenOrTransparent, SIGNAL(toggled(bool)), SLOT(onTransparencyChanged()));
63
64   myListView = new ModuleBase_ListView(aContent, "", "Hidden/transparent faces in 3D view");
65   connect(myListView, SIGNAL(deleteActionClicked()), SLOT(onDeleteItem()));
66
67   aMainLayout->addWidget(myHiddenOrTransparent, 0, 0);
68   aMainLayout->addWidget(myListView->getControl(), 1, 0);
69
70   myListView->getControl()->setFocusPolicy(Qt::StrongFocus);
71   myListView->getControl()->viewport()->installEventFilter(this);
72 }
73
74 //********************************************************************
75 void XGUI_FacesPanel::reset(const bool isToFlushRedisplay)
76 {
77   if (myLastItemIndex == 0) // do nothing because there was no activity in the pane after reset
78     return;
79
80   // clear internal containers
81   myListView->getControl()->clear();
82   myItems.clear();
83
84   // restore previous view of presentations
85   bool isModified = redisplayObjects(myItemObjects, false);
86   std::set<std::shared_ptr<ModelAPI_Object> > aHiddenObjects = myHiddenObjects;
87   isModified = displayHiddenObjects(aHiddenObjects, myHiddenObjects, false) || isModified;
88   if (isModified)// && isToFlushRedisplay) // flush signal immediatelly until container is filled
89     Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
90
91   updateProcessedObjects(myItems, myItemObjects);
92   myHiddenObjects.clear();
93   myLastItemIndex = 0; // it should be after redisplay as flag used in customize
94 }
95
96 //********************************************************************
97 bool XGUI_FacesPanel::eventFilter(QObject* theObject, QEvent *theEvent)
98 {
99   QWidget* aWidget = qobject_cast<QWidget*>(theObject);
100   if (theEvent->type() == QEvent::MouseButtonRelease)
101   {
102     if (myListView->getControl()->viewport() == aWidget)
103       setActivePanel(true);
104   }
105   // pass the event on to the parent class
106   return QObject::eventFilter(theObject, theEvent);
107 }
108
109 //********************************************************************
110 void XGUI_FacesPanel::setActivePanel(const bool theIsActive)
111 {
112   if (myIsActive == theIsActive)
113     return;
114
115   ModuleBase_Tools::setShadowEffect(myListView->getControl(), theIsActive);
116   myIsActive = theIsActive;
117
118   if (myIsActive)
119   {
120     emit activated();
121     // selection should be activated after emit signal, that deactivates current widget(selection)
122     activateSelection(theIsActive);
123   }
124   else
125   {
126     // selection should be activated after emit signal, that deactivates current widget(selection)
127     activateSelection(theIsActive);
128     emit deactivated();
129   }
130 }
131
132 //********************************************************************
133 bool XGUI_FacesPanel::useTransparency() const
134 {
135   return myHiddenOrTransparent->isChecked();
136 }
137
138 //********************************************************************
139 void XGUI_FacesPanel::restoreObjects(const std::set<ObjectPtr>& theHiddenObjects)
140 {
141   std::set<int> anIndicesToBeRemoved;
142   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anItemsIt = myItems.begin();
143     anItemsIt != myItems.end(); anItemsIt++)
144   {
145     ModuleBase_ViewerPrsPtr aPrs = anItemsIt.value();
146     ObjectPtr anObject = aPrs->object();
147     if (theHiddenObjects.find(anObject) == theHiddenObjects.end()) // not found
148       continue;
149     anIndicesToBeRemoved.insert(anItemsIt.key());
150   }
151
152   // remove from myItes container
153   for (std::set<int>::const_iterator aToBeRemovedIt = anIndicesToBeRemoved.begin();
154     aToBeRemovedIt != anIndicesToBeRemoved.end(); aToBeRemovedIt++)
155   {
156     myItems.remove(*aToBeRemovedIt);
157   }
158   if (!anIndicesToBeRemoved.empty()) // means that myItems has been changed
159     updateProcessedObjects(myItems, myItemObjects);
160   myListView->removeItems(anIndicesToBeRemoved);
161
162   // remove from container of hidden objects
163   for (std::set<ObjectPtr>::const_iterator aHiddenIt = theHiddenObjects.begin();
164     aHiddenIt != theHiddenObjects.end(); aHiddenIt++)
165   {
166     if (myHiddenObjects.find(*aHiddenIt) != myHiddenObjects.end()) /// found objects
167       myHiddenObjects.erase(*aHiddenIt);
168   }
169 }
170
171 //********************************************************************
172 bool XGUI_FacesPanel::processAction(ModuleBase_ActionType theActionType)
173 {
174   switch (theActionType) {
175     //case ActionEnter:
176     //  return processEnter();
177     case ActionEscape:
178       setActivePanel(false);
179       return true;
180     case ActionDelete:
181       return processDelete();
182     //case ActionUndo:
183     //case ActionRedo:
184     default:
185       return false;
186   }
187 }
188
189 //********************************************************************
190 void XGUI_FacesPanel::processSelection()
191 {
192   QList<ModuleBase_ViewerPrsPtr> aSelected = myWorkshop->selection()->getSelected(
193                                                        ModuleBase_ISelection::Viewer);
194   bool isModified = false;
195   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
196   for (int i = 0; i < aSelected.size(); i++) {
197     ModuleBase_ViewerPrsPtr aPrs = aSelected[i];
198     ObjectPtr anObject = aPrs->object();
199     if (!anObject.get())
200       continue;
201     if (ModuleBase_Tools::getSelectedShape(aPrs).ShapeType() != TopAbs_FACE)
202       continue;
203
204     Handle(ModuleBase_ResultPrs) aResultPrs = Handle(ModuleBase_ResultPrs)::DownCast(
205       aPrs->interactive());
206     if (aResultPrs.IsNull())
207       continue;
208
209     myItems.insert(myLastItemIndex, aPrs);
210     myListView->addItem(generateName(aPrs), myLastItemIndex);
211     myLastItemIndex++;
212     isModified = true;
213
214     if (aResultPrs->hasSubShapeVisible(ModuleBase_Tools::getSelectedShape(aPrs)) ||
215         useTransparency()) // redisplay
216       ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
217     else { // erase object because it is entirely hidden
218       anObject->setDisplayed(false);
219       myHiddenObjects.insert(anObject);
220       ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
221     }
222   }
223   if (isModified)
224   {
225     updateProcessedObjects(myItems, myItemObjects);
226     Events_Loop::loop()->flush(aDispEvent);
227   }
228 }
229
230 //********************************************************************
231 bool XGUI_FacesPanel::processDelete()
232 {
233   //appendFirstSelectionInHistory();
234   QModelIndexList anIndices = myListView->getControl()->selectionModel()->selectedIndexes();
235
236   std::set<int> aSelectedIds;
237   myListView->getSelectedIndices(aSelectedIds);
238   if (aSelectedIds.empty())
239     return false;
240
241   bool isModified = false;
242   std::set<ObjectPtr> aRestoredObjects;
243   for (std::set<int>::const_iterator anIt = aSelectedIds.begin(); anIt != aSelectedIds.end();
244        anIt++) {
245     ModuleBase_ViewerPrsPtr aPrs = myItems[*anIt];
246     if (aRestoredObjects.find(aPrs->object()) == aRestoredObjects.end())
247       aRestoredObjects.insert(aPrs->object());
248     myItems.remove(*anIt);
249     isModified = true;
250   }
251   if (isModified) {
252     bool isRedisplayed = redisplayObjects(aRestoredObjects, false);
253     isRedisplayed = displayHiddenObjects(aRestoredObjects, myHiddenObjects, false)
254                     || isRedisplayed;
255     if (isRedisplayed)
256       Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
257     // should be after flush of redisplay to have items object to be updated
258     updateProcessedObjects(myItems, myItemObjects);
259   }
260
261   myListView->removeSelectedItems();
262   // Restore selection
263   myListView->restoreSelection(anIndices);
264   //appendSelectionInHistory();
265   return true;
266 }
267
268 //********************************************************************
269 bool XGUI_FacesPanel::redisplayObjects(
270   const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects,
271   const bool isToFlushRedisplay)
272 {
273   if (theObjects.empty())
274     return false;
275
276   bool isModified = false;
277   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
278   for (std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(); anIt != theObjects.end();
279        anIt++)
280   {
281     ObjectPtr anObject = *anIt;
282     if (!anObject->isDisplayed())
283       continue;
284     ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
285     isModified = true;
286   }
287   if (isModified && isToFlushRedisplay)
288     Events_Loop::loop()->flush(aDispEvent);
289   return isModified;
290 }
291
292 //********************************************************************
293 bool XGUI_FacesPanel::displayHiddenObjects(
294   const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects,
295   std::set<std::shared_ptr<ModelAPI_Object> >& theHiddenObjects,
296   const bool isToFlushRedisplay)
297 {
298   if (theObjects.empty())
299     return false;
300
301   bool isModified = false;
302   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
303
304   for (std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(); anIt != theObjects.end();
305        anIt++)
306   {
307     ObjectPtr anObject = *anIt;
308     // if the object was hidden by this panel
309     if (anObject->isDisplayed() || theHiddenObjects.find(anObject) == theHiddenObjects.end())
310       continue;
311     theHiddenObjects.erase(anObject);
312     anObject->setDisplayed(true); // it means that the object is hidden by hide all faces
313     ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
314     isModified = true;
315   }
316
317   if (isModified && isToFlushRedisplay)
318     Events_Loop::loop()->flush(aDispEvent);
319   return isModified;
320 }
321
322 //********************************************************************
323 bool XGUI_FacesPanel::hideEmptyObjects()
324 {
325   bool isModified = false;
326   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
327   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anIt = myItems.begin();
328        anIt != myItems.end(); anIt++) {
329     ModuleBase_ViewerPrsPtr aPrs = anIt.value();
330     ObjectPtr anObject = aPrs->object();
331     if (!anObject.get() || !anObject->isDisplayed())
332       continue;
333
334     Handle(ModuleBase_ResultPrs) aResultPrs = Handle(ModuleBase_ResultPrs)::DownCast(
335       aPrs->interactive());
336     if (aResultPrs.IsNull())
337       continue;
338
339     if (!aResultPrs->hasSubShapeVisible(ModuleBase_Tools::getSelectedShape(aPrs))) {
340       // erase object because it is entirely hidden
341       anObject->setDisplayed(false);
342       myHiddenObjects.insert(anObject);
343       ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
344       isModified = true;
345     }
346   }
347   return isModified;
348 }
349
350 //********************************************************************
351 void XGUI_FacesPanel::updateProcessedObjects(QMap<int, ModuleBase_ViewerPrsPtr> theItems,
352                                              std::set<ObjectPtr>& theObjects)
353 {
354   theObjects.clear();
355   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anIt = theItems.begin();
356        anIt != theItems.end(); anIt++) {
357     ModuleBase_ViewerPrsPtr aPrs = anIt.value();
358     ObjectPtr anObject = aPrs.get() ? aPrs->object() : ObjectPtr();
359     if (anObject.get() && theObjects.find(anObject) != theObjects.end())
360       continue;
361     theObjects.insert(anObject);
362   }
363 }
364
365 //********************************************************************
366 void XGUI_FacesPanel::closeEvent(QCloseEvent* theEvent)
367 {
368   QDockWidget::closeEvent(theEvent);
369   emit closed();
370 }
371
372 //********************************************************************
373 void XGUI_FacesPanel::activateSelection(bool toActivate)
374 {
375   QIntList aShapeTypes;
376   aShapeTypes.append(TopAbs_FACE);
377
378   if (toActivate) {
379     myWorkshop->activateSubShapesSelection(aShapeTypes);
380   } else {
381     myWorkshop->deactivateSubShapesSelection();
382   }
383   if (toActivate)
384     activateSelectionFilters();
385   else
386     deactivateSelectionFilters();
387 }
388
389 //********************************************************************
390 QString XGUI_FacesPanel::generateName(const ModuleBase_ViewerPrsPtr& thePrs)
391 {
392   if (!thePrs.get() || !thePrs->object().get())
393     return "Undefined";
394
395   GeomShapePtr aContext;
396   ObjectPtr anObject = thePrs->object();
397   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
398   if (aResult.get())
399     aContext = aResult->shape();
400   else {
401     // TODO if there is this case
402   }
403
404   QString aName = anObject->data()->name().c_str();
405   if (aContext.get()) {
406     GeomShapePtr aSubShape(new GeomAPI_Shape());
407     aSubShape->setImpl(new TopoDS_Shape(ModuleBase_Tools::getSelectedShape(thePrs)));
408     if (!aSubShape->isEqual(aContext))
409       aName += QString("_%1").arg(GeomAlgoAPI_CompoundBuilder::id(aContext, aSubShape));
410   }
411   return aName;
412 }
413
414 //********************************************************************
415 bool XGUI_FacesPanel::customizeObject(const ObjectPtr& theObject,
416                                       const AISObjectPtr& thePresentation)
417 {
418   if (myLastItemIndex == 0) // do nothing because there was no activity in the pane after reset
419     return false;
420
421   if (thePresentation.get() == NULL)
422     return false;
423
424   if (myItemObjects.find(theObject) == myItemObjects.end()) // not found
425     return false;
426
427   // if the object is displayed, the hidden faces are collected and set to the presentation
428   bool isModified = false;
429   NCollection_List<TopoDS_Shape> aHiddenSubShapes;
430   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anIt = myItems.begin();
431     anIt != myItems.end(); anIt++) {
432     ModuleBase_ViewerPrsPtr aPrs = anIt.value();
433     if (aPrs.get() && aPrs->object() != theObject)
434       continue;
435     TopoDS_Shape aShape = ModuleBase_Tools::getSelectedShape(aPrs);
436     if (!aHiddenSubShapes.Contains(aShape))
437       aHiddenSubShapes.Append(aShape);
438   }
439
440   Handle(ModuleBase_ResultPrs) aResultPrs = Handle(ModuleBase_ResultPrs)::DownCast(
441     thePresentation->impl<Handle(AIS_InteractiveObject)>());
442   if (aResultPrs.IsNull())
443     return false;
444
445   isModified = aResultPrs->setSubShapeHidden(aHiddenSubShapes);
446
447   double aTransparency = !useTransparency() ? 1
448     : Config_PropManager::real("Visualization", "hidden_face_transparency");
449   isModified = aResultPrs->setHiddenSubShapeTransparency(aTransparency) || isModified;
450
451   return isModified;
452 }
453
454 //********************************************************************
455 void XGUI_FacesPanel::onDeleteItem()
456 {
457   processDelete();
458 }
459
460 //********************************************************************
461 void XGUI_FacesPanel::onTransparencyChanged()
462 {
463   bool isModified = false;
464   if (useTransparency()) {
465     std::set<std::shared_ptr<ModelAPI_Object> > aHiddenObjects = myHiddenObjects;
466     isModified = displayHiddenObjects(aHiddenObjects, myHiddenObjects, false);
467   }
468   else
469     isModified = hideEmptyObjects();
470
471   isModified = redisplayObjects(myItemObjects, false) || isModified;
472   if (isModified)
473     Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
474
475 }
476
477 //********************************************************************
478 void XGUI_FacesPanel::onClosed()
479 {
480   setActivePanel(false);
481   reset(true);
482 }