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_IModule.h>
  30 #include <ModuleBase_ISelection.h>
  31 #include "ModuleBase_IWorkshop.h"
  32 #include "ModuleBase_ListView.h"
  33 #include "ModuleBase_ResultPrs.h"
  34 #include "ModuleBase_Tools.h"
  35 #include "ModuleBase_ViewerPrs.h"
  36
  37 #include "XGUI_SelectionMgr.h"
  38 #include "XGUI_SelectionFilterType.h"
  39 #include "XGUI_Tools.h"
  40 #include "XGUI_Workshop.h"
  41
  42 #include <QAction>
  43 #include <QCheckBox>
  44 #include <QFocusEvent>
  45 #include <QGridLayout>
  46 #include <QListWidget>
  47 #include <QMainWindow>
  48
  49 static const int LayoutMargin = 3;
  50
  51 //********************************************************************
  52 XGUI_FacesPanel::XGUI_FacesPanel(QWidget* theParent, ModuleBase_IWorkshop* theWorkshop)
  53   : QDockWidget(theParent), myIsActive(false), myWorkshop(theWorkshop)
  54 {
  55   setWindowTitle(tr("Hide Faces"));
  56   QAction* aViewAct = toggleViewAction();
  57   setStyleSheet("::title { position: relative; padding-left: 5px; text-align: left center }");
  58
  59   QWidget* aContent = new QWidget(this);
  60   QGridLayout* aMainLayout = new QGridLayout(aContent);
  61   aMainLayout->setContentsMargins(LayoutMargin, LayoutMargin, LayoutMargin, LayoutMargin);
  62   setWidget(aContent);
  63
  64   myHiddenOrTransparent = new QCheckBox(tr("Transparent"), aContent);
  65   connect(myHiddenOrTransparent, SIGNAL(toggled(bool)), SLOT(onTransparencyChanged()));
  66
  67   myListView = new ModuleBase_ListView(aContent, "", "Hidden/transparent faces in 3D view");
  68   connect(myListView, SIGNAL(deleteActionClicked()), SLOT(onDeleteItem()));
  69
  70   aMainLayout->addWidget(myHiddenOrTransparent, 0, 0);
  71   aMainLayout->addWidget(myListView->getControl(), 1, 0);
  72
  73   myListView->getControl()->setFocusPolicy(Qt::StrongFocus);
  74   myListView->getControl()->viewport()->installEventFilter(this);
  75 }
  76
  77 //********************************************************************
  78 void XGUI_FacesPanel::reset(const bool isToFlushRedisplay)
  79 {
  80   if (myLastItemIndex == 0) // do nothing because there was no activity in the pane after reset
  81     return;
  82
  83   // clear internal containers
  84   myListView->getControl()->clear();
  85   myItems.clear();
  86
  87   // restore previous view of presentations
  88   bool isModified = redisplayObjects(myItemObjects, false);
  89   std::set<std::shared_ptr<ModelAPI_Object> > aHiddenObjects = myHiddenObjects;
  90   isModified = displayHiddenObjects(aHiddenObjects, myHiddenObjects, false) || isModified;
  91   if (isModified)// && isToFlushRedisplay) // flush signal immediatelly until container is filled
  92     Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
  93
  94   updateProcessedObjects(myItems, myItemObjects);
  95   myHiddenObjects.clear();
  96   myLastItemIndex = 0; // it should be after redisplay as flag used in customize
  97 }
  98
  99 //********************************************************************
 100 void XGUI_FacesPanel::selectionModes(QIntList& theModes)
 101 {
 102   theModes.append(TopAbs_FACE);
 103 }
 104
 105 //********************************************************************
 106 void XGUI_FacesPanel::selectionFilters(SelectMgr_ListOfFilter& theSelectionFilters)
 107 {
 108   ModuleBase_IModule* aModule = myWorkshop->module();
 109   QIntList aModuleSelectionFilters = myWorkshop->module()->selectionFilters();
 110
 111   theSelectionFilters.Append(aModule->selectionFilter(SF_GlobalFilter));
 112   theSelectionFilters.Append(aModule->selectionFilter(SF_FilterInfinite));
 113   theSelectionFilters.Append(aModule->selectionFilter(SF_ResultGroupNameFilter));
 114 }
 115
 116 //********************************************************************
 117 bool XGUI_FacesPanel::eventFilter(QObject* theObject, QEvent *theEvent)
 118 {
 119   QWidget* aWidget = qobject_cast<QWidget*>(theObject);
 120   if (theEvent->type() == QEvent::MouseButtonRelease)
 121   {
 122     if (myListView->getControl()->viewport() == aWidget)
 123       setActivePanel(true);
 124   }
 125   // pass the event on to the parent class
 126   return QObject::eventFilter(theObject, theEvent);
 127 }
 128
 129 //********************************************************************
 130 void XGUI_FacesPanel::setActivePanel(const bool theIsActive)
 131 {
 132   if (myIsActive == theIsActive)
 133     return;
 134
 135   ModuleBase_Tools::setShadowEffect(myListView->getControl(), theIsActive);
 136   myIsActive = theIsActive;
 137
 138   if (myIsActive) {
 139     emit activated();
 140     // selection should be cleared after emit of signal to do not process selection change
 141     // event by the previous selector
 142     // the selection is cleared by activating selection control
 143     XGUI_Tools::workshop(myWorkshop)->selector()->clearSelection();
 144   }
 145   else
 146     emit deactivated();
 147 }
 148
 149 //********************************************************************
 150 bool XGUI_FacesPanel::useTransparency() const
 151 {
 152   return myHiddenOrTransparent->isChecked();
 153 }
 154
 155 //********************************************************************
 156 void XGUI_FacesPanel::restoreObjects(const std::set<ObjectPtr>& theHiddenObjects)
 157 {
 158   std::set<int> anIndicesToBeRemoved;
 159   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anItemsIt = myItems.begin();
 160     anItemsIt != myItems.end(); anItemsIt++)
 161   {
 162     ModuleBase_ViewerPrsPtr aPrs = anItemsIt.value();
 163     ObjectPtr anObject = aPrs->object();
 164     if (theHiddenObjects.find(anObject) == theHiddenObjects.end()) // not found
 165       continue;
 166     anIndicesToBeRemoved.insert(anItemsIt.key());
 167   }
 168
 169   // remove from myItes container
 170   for (std::set<int>::const_iterator aToBeRemovedIt = anIndicesToBeRemoved.begin();
 171     aToBeRemovedIt != anIndicesToBeRemoved.end(); aToBeRemovedIt++)
 172   {
 173     myItems.remove(*aToBeRemovedIt);
 174   }
 175   if (!anIndicesToBeRemoved.empty()) // means that myItems has been changed
 176     updateProcessedObjects(myItems, myItemObjects);
 177   myListView->removeItems(anIndicesToBeRemoved);
 178
 179   // remove from container of hidden objects
 180   for (std::set<ObjectPtr>::const_iterator aHiddenIt = theHiddenObjects.begin();
 181     aHiddenIt != theHiddenObjects.end(); aHiddenIt++)
 182   {
 183     if (myHiddenObjects.find(*aHiddenIt) != myHiddenObjects.end()) /// found objects
 184       myHiddenObjects.erase(*aHiddenIt);
 185   }
 186 }
 187
 188 //********************************************************************
 189 bool XGUI_FacesPanel::processAction(ModuleBase_ActionType theActionType)
 190 {
 191   switch (theActionType) {
 192     //case ActionEnter:
 193     //  return processEnter();
 194     case ActionEscape:
 195       setActivePanel(false);
 196       return true;
 197     case ActionDelete:
 198       return processDelete();
 199     //case ActionUndo:
 200     //case ActionRedo:
 201     default:
 202       return false;
 203   }
 204 }
 205
 206 //********************************************************************
 207 void XGUI_FacesPanel::processSelection()
 208 {
 209   QList<ModuleBase_ViewerPrsPtr> aSelected = myWorkshop->selection()->getSelected(
 210                                                        ModuleBase_ISelection::Viewer);
 211   bool isModified = false;
 212   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 213   for (int i = 0; i < aSelected.size(); i++) {
 214     ModuleBase_ViewerPrsPtr aPrs = aSelected[i];
 215     ObjectPtr anObject = aPrs->object();
 216     if (!anObject.get())
 217       continue;
 218     if (ModuleBase_Tools::getSelectedShape(aPrs).ShapeType() != TopAbs_FACE)
 219       continue;
 220
 221     Handle(ModuleBase_ResultPrs) aResultPrs = Handle(ModuleBase_ResultPrs)::DownCast(
 222       aPrs->interactive());
 223     if (aResultPrs.IsNull())
 224       continue;
 225
 226     myItems.insert(myLastItemIndex, aPrs);
 227     myListView->addItem(generateName(aPrs), myLastItemIndex);
 228     myLastItemIndex++;
 229     isModified = true;
 230
 231     if (aResultPrs->hasSubShapeVisible(ModuleBase_Tools::getSelectedShape(aPrs)) ||
 232         useTransparency()) // redisplay
 233       ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
 234     else { // erase object because it is entirely hidden
 235       anObject->setDisplayed(false);
 236       myHiddenObjects.insert(anObject);
 237       ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
 238     }
 239   }
 240   if (isModified)
 241   {
 242     updateProcessedObjects(myItems, myItemObjects);
 243     Events_Loop::loop()->flush(aDispEvent);
 244   }
 245 }
 246
 247 //********************************************************************
 248 bool XGUI_FacesPanel::processDelete()
 249 {
 250   //appendFirstSelectionInHistory();
 251   QModelIndexList anIndices = myListView->getControl()->selectionModel()->selectedIndexes();
 252
 253   std::set<int> aSelectedIds;
 254   myListView->getSelectedIndices(aSelectedIds);
 255   if (aSelectedIds.empty())
 256     return false;
 257
 258   bool isModified = false;
 259   std::set<ObjectPtr> aRestoredObjects;
 260   for (std::set<int>::const_iterator anIt = aSelectedIds.begin(); anIt != aSelectedIds.end();
 261        anIt++) {
 262     ModuleBase_ViewerPrsPtr aPrs = myItems[*anIt];
 263     if (aRestoredObjects.find(aPrs->object()) == aRestoredObjects.end())
 264       aRestoredObjects.insert(aPrs->object());
 265     myItems.remove(*anIt);
 266     isModified = true;
 267   }
 268   if (isModified) {
 269     bool isRedisplayed = redisplayObjects(aRestoredObjects, false);
 270     isRedisplayed = displayHiddenObjects(aRestoredObjects, myHiddenObjects, false)
 271                     || isRedisplayed;
 272     if (isRedisplayed)
 273       Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
 274     // should be after flush of redisplay to have items object to be updated
 275     updateProcessedObjects(myItems, myItemObjects);
 276   }
 277
 278   myListView->removeSelectedItems();
 279   // Restore selection
 280   myListView->restoreSelection(anIndices);
 281   //appendSelectionInHistory();
 282   return true;
 283 }
 284
 285 //********************************************************************
 286 bool XGUI_FacesPanel::redisplayObjects(
 287   const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects,
 288   const bool isToFlushRedisplay)
 289 {
 290   if (theObjects.empty())
 291     return false;
 292
 293   bool isModified = false;
 294   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 295   for (std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(); anIt != theObjects.end();
 296        anIt++)
 297   {
 298     ObjectPtr anObject = *anIt;
 299     if (!anObject->isDisplayed())
 300       continue;
 301     ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
 302     isModified = true;
 303   }
 304   if (isModified && isToFlushRedisplay)
 305     Events_Loop::loop()->flush(aDispEvent);
 306   return isModified;
 307 }
 308
 309 //********************************************************************
 310 bool XGUI_FacesPanel::displayHiddenObjects(
 311   const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects,
 312   std::set<std::shared_ptr<ModelAPI_Object> >& theHiddenObjects,
 313   const bool isToFlushRedisplay)
 314 {
 315   if (theObjects.empty())
 316     return false;
 317
 318   bool isModified = false;
 319   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 320
 321   for (std::set<ObjectPtr>::const_iterator anIt = theObjects.begin(); anIt != theObjects.end();
 322        anIt++)
 323   {
 324     ObjectPtr anObject = *anIt;
 325     // if the object was hidden by this panel
 326     if (anObject->isDisplayed() || theHiddenObjects.find(anObject) == theHiddenObjects.end())
 327       continue;
 328     theHiddenObjects.erase(anObject);
 329     anObject->setDisplayed(true); // it means that the object is hidden by hide all faces
 330     ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
 331     isModified = true;
 332   }
 333
 334   if (isModified && isToFlushRedisplay)
 335     Events_Loop::loop()->flush(aDispEvent);
 336   return isModified;
 337 }
 338
 339 //********************************************************************
 340 bool XGUI_FacesPanel::hideEmptyObjects()
 341 {
 342   bool isModified = false;
 343   static Events_ID aDispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 344   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anIt = myItems.begin();
 345        anIt != myItems.end(); anIt++) {
 346     ModuleBase_ViewerPrsPtr aPrs = anIt.value();
 347     ObjectPtr anObject = aPrs->object();
 348     if (!anObject.get() || !anObject->isDisplayed())
 349       continue;
 350
 351     Handle(ModuleBase_ResultPrs) aResultPrs = Handle(ModuleBase_ResultPrs)::DownCast(
 352       aPrs->interactive());
 353     if (aResultPrs.IsNull())
 354       continue;
 355
 356     if (!aResultPrs->hasSubShapeVisible(ModuleBase_Tools::getSelectedShape(aPrs))) {
 357       // erase object because it is entirely hidden
 358       anObject->setDisplayed(false);
 359       myHiddenObjects.insert(anObject);
 360       ModelAPI_EventCreator::get()->sendUpdated(anObject, aDispEvent);
 361       isModified = true;
 362     }
 363   }
 364   return isModified;
 365 }
 366
 367 //********************************************************************
 368 void XGUI_FacesPanel::updateProcessedObjects(QMap<int, ModuleBase_ViewerPrsPtr> theItems,
 369                                              std::set<ObjectPtr>& theObjects)
 370 {
 371   theObjects.clear();
 372   for (QMap<int, ModuleBase_ViewerPrsPtr>::const_iterator anIt = theItems.begin();
 373        anIt != theItems.end(); anIt++) {
 374     ModuleBase_ViewerPrsPtr aPrs = anIt.value();
 375     ObjectPtr anObject = aPrs.get() ? aPrs->object() : ObjectPtr();
 376     if (anObject.get() && theObjects.find(anObject) != theObjects.end())
 377       continue;
 378     theObjects.insert(anObject);
 379   }
 380 }
 381
 382 //********************************************************************
 383 void XGUI_FacesPanel::closeEvent(QCloseEvent* theEvent)
 384 {
 385   QDockWidget::closeEvent(theEvent);
 386   emit closed();
 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 }