src/ModuleBase/ModuleBase_WidgetMultiSelector.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetMultiSelector.cpp
   5  *
   6  *  Created on: Aug 28, 2014
   7  *      Author: sbh
   8  */
   9
  10 #include <ModuleBase_WidgetMultiSelector.h>
  11 #include <ModuleBase_WidgetShapeSelector.h>
  12 #include <ModuleBase_ISelection.h>
  13 #include <ModuleBase_IWorkshop.h>
  14 #include <ModuleBase_IViewer.h>
  15 #include <ModuleBase_Tools.h>
  16 #include <ModuleBase_Definitions.h>
  17
  18 #include <GeomValidators_ShapeType.h>
  19
  20 #include <ModelAPI_Data.h>
  21 #include <ModelAPI_Object.h>
  22
  23 #include <Config_WidgetAPI.h>
  24
  25 #include <QGridLayout>
  26 #include <QLabel>
  27 #include <QListWidget>
  28 #include <QObject>
  29 #include <QString>
  30 #include <QComboBox>
  31 #include <QEvent>
  32 #include <QAction>
  33 #include <QApplication>
  34 #include <QClipboard>
  35
  36 #include <memory>
  37 #include <string>
  38
  39 //#define DEBUG_SHAPE_VALIDATION_PREVIOUS
  40
  41 ModuleBase_WidgetMultiSelector::ModuleBase_WidgetMultiSelector(QWidget* theParent,
  42                                                                ModuleBase_IWorkshop* theWorkshop,
  43                                                                const Config_WidgetAPI* theData,
  44                                                                const std::string& theParentId)
  45     : ModuleBase_WidgetValidated(theParent, theData, theParentId),
  46       myWorkshop(theWorkshop)
  47 {
  48   QGridLayout* aMainLay = new QGridLayout(this);
  49   ModuleBase_Tools::adjustMargins(aMainLay);
  50
  51   QLabel* aTypeLabel = new QLabel(tr("Type"), this);
  52   aMainLay->addWidget(aTypeLabel, 0, 0);
  53
  54   myTypeCombo = new QComboBox(this);
  55   // There is no sence to paramerize list of types while we can not parametrize selection mode
  56
  57   myShapeValidator = new GeomValidators_ShapeType();
  58
  59   std::string aPropertyTypes = theData->getProperty("type_choice");
  60   QString aTypesStr = aPropertyTypes.c_str();
  61   QStringList aShapeTypes = aTypesStr.split(' ');
  62
  63   //myIsUseChoice = theData->getBooleanAttribute("use_choice", true);
  64
  65   myTypeCombo->addItems(aShapeTypes);
  66   aMainLay->addWidget(myTypeCombo, 0, 1);
  67   // if the xml definition contains one type, the controls to select a type should not be shown
  68   if (aShapeTypes.size() == 1/* || !myIsUseChoice*/) {
  69     aTypeLabel->setVisible(false);
  70     myTypeCombo->setVisible(false);
  71   }
  72
  73   std::string aLabelText = theData->getProperty("label");
  74   QLabel* aListLabel = new QLabel(!aLabelText.empty() ? aLabelText.c_str()
  75                                                       : tr("Selected objects:"), this);
  76   aMainLay->addWidget(aListLabel, 1, 0);
  77   // if the xml definition contains one type, an information label should be shown near to the latest
  78   if (aShapeTypes.size() == 1) {
  79     QString aLabelText = QString::fromStdString(theData->widgetLabel());
  80     QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
  81     QLabel* aSelectedLabel = new QLabel(aLabelText, this);
  82     if (!aLabelIcon.isEmpty())
  83       aSelectedLabel->setPixmap(QPixmap(aLabelIcon));
  84     aMainLay->addWidget(aSelectedLabel, 1, 1);
  85     aMainLay->setColumnStretch(2, 1);
  86   }
  87
  88   myListControl = new QListWidget(this);
  89   aMainLay->addWidget(myListControl, 2, 0, 2, -1);
  90   aMainLay->setRowStretch(2, 1);
  91   aMainLay->addWidget(new QLabel(this)); //FIXME(sbh)???
  92   aMainLay->setRowMinimumHeight(3, 20);
  93   this->setLayout(aMainLay);
  94   connect(myTypeCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(onSelectionTypeChanged()));
  95
  96   myCopyAction = new QAction(QIcon(":pictures/copy.png"), tr("Copy"), this);
  97   myCopyAction->setShortcut(QKeySequence::Copy);
  98   myCopyAction->setEnabled(false);
  99   connect(myCopyAction, SIGNAL(triggered(bool)), SLOT(onCopyItem()));
 100   myListControl->addAction(myCopyAction);
 101   myListControl->setContextMenuPolicy(Qt::ActionsContextMenu);
 102   connect(myListControl, SIGNAL(itemSelectionChanged()), SLOT(onListSelection()));
 103 }
 104
 105 ModuleBase_WidgetMultiSelector::~ModuleBase_WidgetMultiSelector()
 106 {
 107   delete myShapeValidator;
 108 }
 109
 110 //TODO: nds stabilization hotfix
 111 void ModuleBase_WidgetMultiSelector::disconnectSignals()
 112 {
 113   disconnect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
 114 }
 115
 116 //********************************************************************
 117 void ModuleBase_WidgetMultiSelector::activateCustom()
 118 {
 119   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
 120   connect(myWorkshop, SIGNAL(selectionChanged()),
 121           this,       SLOT(onSelectionChanged()),
 122           Qt::UniqueConnection);
 123
 124   activateShapeSelection(true);
 125
 126   // Restore selection in the viewer by the attribute selection list
 127   myWorkshop->setSelected(getAttributeSelection());
 128
 129   activateFilters(myWorkshop, true);
 130 }
 131
 132 //********************************************************************
 133 void ModuleBase_WidgetMultiSelector::deactivate()
 134 {
 135   disconnect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
 136   activateShapeSelection(false);
 137   activateFilters(myWorkshop, false);
 138 }
 139
 140 //********************************************************************
 141 bool ModuleBase_WidgetMultiSelector::storeValueCustom() const
 142 {
 143   // the value is stored on the selection changed signal processing
 144   // A rare case when plugin was not loaded.
 145   if(!myFeature)
 146     return false;
 147   DataPtr aData = myFeature->data();
 148   AttributeSelectionListPtr aSelectionListAttr =
 149     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 150
 151   if (aSelectionListAttr) {
 152     // Store shapes type
 153      TopAbs_ShapeEnum aCurrentType =
 154            ModuleBase_Tools::shapeType(myTypeCombo->currentText());
 155      aSelectionListAttr->setSelectionType(myTypeCombo->currentText().toStdString());
 156   }
 157    return true;
 158 }
 159
 160 //********************************************************************
 161 bool ModuleBase_WidgetMultiSelector::restoreValue()
 162 {
 163   // A rare case when plugin was not loaded.
 164   if(!myFeature)
 165     return false;
 166   DataPtr aData = myFeature->data();
 167   AttributeSelectionListPtr aSelectionListAttr =
 168     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 169
 170   if (aSelectionListAttr) {
 171     // Restore shape type
 172     if (!aSelectionListAttr->selectionType().empty())
 173       setCurrentShapeType(ModuleBase_Tools::shapeType(aSelectionListAttr->selectionType().c_str()));
 174     updateSelectionList(aSelectionListAttr);
 175     return true;
 176   }
 177   return false;
 178 }
 179
 180 //********************************************************************
 181 void ModuleBase_WidgetMultiSelector::storeAttributeValue()
 182 {
 183   DataPtr aData = myFeature->data();
 184   AttributeSelectionListPtr aSelectionListAttr =
 185     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 186   if (aSelectionListAttr.get() == NULL)
 187     return;
 188
 189   mySelectionType = aSelectionListAttr->selectionType();
 190   mySelection.clear();
 191   int aSize = aSelectionListAttr->size();
 192   for (int i = 0; i < aSelectionListAttr->size(); i++) {
 193     AttributeSelectionPtr aSelectAttr = aSelectionListAttr->value(i);
 194     mySelection.append(GeomSelection(aSelectAttr->context(), aSelectAttr->value()));
 195   }
 196 }
 197
 198 //********************************************************************
 199 void ModuleBase_WidgetMultiSelector::restoreAttributeValue(bool/* theValid*/)
 200 {
 201   DataPtr aData = myFeature->data();
 202   AttributeSelectionListPtr aSelectionListAttr =
 203     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 204   if (aSelectionListAttr.get() == NULL)
 205     return;
 206   aSelectionListAttr->clear();
 207
 208   // Store shapes type
 209   aSelectionListAttr->setSelectionType(mySelectionType);
 210
 211   // Store selection in the attribute
 212   int aSize = mySelection.size();
 213   foreach (GeomSelection aSelec, mySelection) {
 214     aSelectionListAttr->append(aSelec.first, aSelec.second);
 215   }
 216 }
 217
 218 //********************************************************************
 219 void ModuleBase_WidgetMultiSelector::customValidators(
 220                                         std::list<ModelAPI_Validator*>& theValidators,
 221                                         std::list<std::list<std::string> >& theArguments) const
 222 {
 223   return;
 224   std::list<std::string> anArguments;
 225
 226   theValidators.push_back(myShapeValidator);
 227   if (true/*myIsUseChoice*/) {
 228     QString aType = myTypeCombo->currentText();
 229     anArguments.push_back(validatorType(aType));
 230   }
 231   else {
 232     for(int i = 0, aCount = myTypeCombo->count(); i < aCount; i++) {
 233       anArguments.push_back(validatorType(myTypeCombo->itemText(i)));
 234     }
 235   }
 236   theArguments.push_back(anArguments);
 237 }
 238
 239 //********************************************************************
 240 bool ModuleBase_WidgetMultiSelector::acceptSubShape(const TopoDS_Shape& theShape) const
 241 {
 242   bool aValid = true;
 243   if (theShape.IsNull()) {
 244     aValid = true; // do not check the shape type if the shape is empty
 245     // extrusion uses a sketch object selectected in Object browser
 246   }
 247   else {
 248     aValid = false;
 249     TopAbs_ShapeEnum aShapeType = theShape.ShapeType();
 250     if (myTypeCombo->count() > 1) {
 251       TopAbs_ShapeEnum aType = ModuleBase_Tools::shapeType(myTypeCombo->currentText());
 252       aValid = aShapeType == aType;
 253     }
 254     else {
 255       for(int i = 0, aCount = myTypeCombo->count(); i < aCount && !aValid; i++) {
 256         TopAbs_ShapeEnum aType = ModuleBase_Tools::shapeType(myTypeCombo->itemText(i));
 257         aValid = aShapeType == aType;
 258       }
 259     }
 260   }
 261   return aValid;
 262 }
 263
 264 //********************************************************************
 265 bool ModuleBase_WidgetMultiSelector::setSelection(const QList<ModuleBase_ViewerPrs>& theValues,
 266                                                   int& thePosition)
 267 {
 268   if (thePosition < 0)
 269     return false;
 270
 271   QList<ModuleBase_ViewerPrs>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
 272   bool isDone = false;
 273   for (int i = thePosition; i < theValues.size(); i++) {
 274     ModuleBase_ViewerPrs aValue = theValues[i];
 275     bool aProcessed = false;
 276     if (isValidSelection(aValue)) {
 277       aProcessed = setSelectionCustom(aValue);
 278     }
 279     // if there is at least one set, the result is true
 280     isDone = isDone || aProcessed;
 281     // when an object, which do not satisfy the validating process, stop set selection
 282     if (!aProcessed)
 283       break;
 284     else
 285       thePosition++;
 286   }
 287   if (isDone) {
 288     updateObject(myFeature);
 289     // this emit is necessary to call store/restore method an restore type of selection
 290     emit valuesChanged();
 291   }
 292   return isDone;
 293 }
 294
 295 //********************************************************************
 296 bool ModuleBase_WidgetMultiSelector::isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs)
 297 {
 298 #ifdef DEBUG_SHAPE_VALIDATION_PREVIOUS
 299   return true;
 300 #endif
 301   GeomShapePtr aShape = myWorkshop->selection()->getShape(thePrs);
 302   // if there is no selected shape, the method returns true
 303   bool aValid;
 304   if (!aShape.get())
 305     aValid = true;
 306   else {
 307     // Check that the selection corresponds to selection type
 308     TopoDS_Shape aTopoShape = aShape->impl<TopoDS_Shape>();
 309     aValid = acceptSubShape(aTopoShape);
 310   }
 311
 312   if (aValid) {
 313     ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
 314
 315     if (myFeature) {
 316       // We can not select a result of our feature
 317       const std::list<ResultPtr>& aResList = myFeature->results();
 318       std::list<ResultPtr>::const_iterator aIt;
 319       bool isSkipSelf = false;
 320       for (aIt = aResList.cbegin(); aIt != aResList.cend(); ++aIt) {
 321         if ((*aIt) == aResult) {
 322           isSkipSelf = true;
 323           break;
 324         }
 325       }
 326       if(isSkipSelf)
 327         aValid = false;
 328     }
 329
 330   }
 331
 332   return aValid;
 333 }
 334
 335 //********************************************************************
 336 bool ModuleBase_WidgetMultiSelector::setSelectionCustom(const ModuleBase_ViewerPrs& thePrs)
 337 {
 338   //TopoDS_Shape aShape = thePrs.shape();
 339   //if (!acceptSubShape(aShape))
 340   //  return false;
 341
 342   ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
 343   /*
 344   if (myFeature) {
 345     // We can not select a result of our feature
 346     const std::list<ResultPtr>& aResList = myFeature->results();
 347     std::list<ResultPtr>::const_iterator aIt;
 348     bool isSkipSelf = false;
 349     for (aIt = aResList.cbegin(); aIt != aResList.cend(); ++aIt) {
 350       if ((*aIt) == aResult) {
 351         isSkipSelf = true;
 352         break;
 353       }
 354     }
 355     if(isSkipSelf)
 356       return false;
 357   }*/
 358
 359   // if the result has the similar shap as the parameter shape, just the context is set to the
 360   // selection list attribute.
 361   DataPtr aData = myFeature->data();
 362   AttributeSelectionListPtr aSelectionListAttr =
 363     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 364
 365   /*const TopoDS_Shape& aTDSShape = thePrs.shape();
 366   // if only result is selected, an empty shape is set to the model
 367   if (aTDSShape.IsNull()) {
 368     aSelectionListAttr->append(aResult, GeomShapePtr());
 369   }
 370   else {
 371     GeomShapePtr aShape(new GeomAPI_Shape());
 372     aShape->setImpl(new TopoDS_Shape(aTDSShape));
 373     // We can not select a result of our feature
 374     if (aShape->isEqual(aResult->shape()))
 375       aSelectionListAttr->append(aResult, GeomShapePtr());
 376     else
 377       aSelectionListAttr->append(aResult, aShape);
 378   }*/
 379   GeomShapePtr aShape = myWorkshop->selection()->getShape(thePrs);
 380   aSelectionListAttr->append(aResult, aShape);
 381
 382   return true;
 383 }
 384
 385 //********************************************************************
 386 QList<QWidget*> ModuleBase_WidgetMultiSelector::getControls() const
 387 {
 388   QList<QWidget*> result;
 389   //result << myTypeCombo;
 390   result << myListControl;
 391   return result;
 392 }
 393
 394 //********************************************************************
 395 void ModuleBase_WidgetMultiSelector::onSelectionTypeChanged()
 396 {
 397   activateShapeSelection(true);
 398   activateFilters(myWorkshop, true);
 399   QList<ModuleBase_ViewerPrs> anEmptyList;
 400   // This method will call Selection changed event which will call onSelectionChanged
 401   // To clear mySelection, myListControl and storeValue()
 402   // So, we don't need to call it
 403   myWorkshop->setSelected(anEmptyList);
 404 }
 405
 406 //********************************************************************
 407 void ModuleBase_WidgetMultiSelector::onSelectionChanged()
 408 {
 409   QList<ModuleBase_ViewerPrs> aSelected = getSelectedEntitiesOrObjects(myWorkshop->selection());
 410
 411   DataPtr aData = myFeature->data();
 412   AttributeSelectionListPtr aSelectionListAttr =
 413     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 414
 415   aSelectionListAttr->clear();
 416   if (aSelected.size() > 0) {
 417     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 418       if (isValidSelection(aPrs)) {
 419         setSelectionCustom(aPrs);
 420       }
 421     }
 422   }
 423   emit valuesChanged();
 424   // the updateObject method should be called to flush the updated sigal. The workshop listens it,
 425   // calls validators for the feature and, as a result, updates the Apply button state.
 426   updateObject(myFeature);
 427
 428   // Set focus to List control in order to make possible
 429   // to use Tab key for transfer the focus to next widgets
 430   myListControl->setCurrentRow(myListControl->model()->rowCount() - 1);
 431   myListControl->setFocus();
 432 }
 433
 434 //********************************************************************
 435 void ModuleBase_WidgetMultiSelector::setCurrentShapeType(const TopAbs_ShapeEnum theShapeType)
 436 {
 437   QString aShapeTypeName;
 438
 439   for (int idx = 0; idx < myTypeCombo->count(); ++idx) {
 440     aShapeTypeName = myTypeCombo->itemText(idx);
 441     TopAbs_ShapeEnum aRefType = ModuleBase_Tools::shapeType(aShapeTypeName);
 442     if(aRefType == theShapeType && idx != myTypeCombo->currentIndex()) {
 443       activateShapeSelection(false);
 444       activateFilters(myWorkshop, false);
 445       bool isBlocked = myTypeCombo->blockSignals(true);
 446       myTypeCombo->setCurrentIndex(idx);
 447       myTypeCombo->blockSignals(isBlocked);
 448
 449       activateShapeSelection(true);
 450       activateFilters(myWorkshop, true);
 451       break;
 452     }
 453   }
 454 }
 455
 456 void ModuleBase_WidgetMultiSelector::activateShapeSelection(const bool isActivated)
 457 {
 458   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
 459
 460   if (isActivated) {
 461     QString aNewType = myTypeCombo->currentText();
 462     QIntList aList;
 463     if (true /*myIsUseChoice*/) {
 464       aList.append(ModuleBase_Tools::shapeType(aNewType));
 465     }
 466     else {
 467       for(int i = 0, aCount = myTypeCombo->count(); i < aCount; i++)
 468         aList.append(ModuleBase_Tools::shapeType(myTypeCombo->itemText(i)));
 469     }
 470     myWorkshop->activateSubShapesSelection(aList);
 471   } else {
 472     myWorkshop->deactivateSubShapesSelection();
 473   }
 474 }
 475
 476 QList<ModuleBase_ViewerPrs> ModuleBase_WidgetMultiSelector::getAttributeSelection() const
 477 {
 478   QList<ModuleBase_ViewerPrs> aSelected;
 479   // Restore selection in the viewer by the attribute selection list
 480   if(myFeature) {
 481     DataPtr aData = myFeature->data();
 482     AttributeSelectionListPtr aListAttr =
 483       std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 484     if (aListAttr) {
 485       for (int i = 0; i < aListAttr->size(); i++) {
 486         AttributeSelectionPtr anAttr = aListAttr->value(i);
 487         ResultPtr anObject = anAttr->context();
 488         if (anObject.get()) {
 489           TopoDS_Shape aShape;
 490           std::shared_ptr<GeomAPI_Shape> aShapePtr = anAttr->value();
 491           if (aShapePtr.get()) {
 492             aShape = aShapePtr->impl<TopoDS_Shape>();
 493           }
 494           aSelected.append(ModuleBase_ViewerPrs(anObject, aShape, NULL));
 495         }
 496       }
 497     }
 498   }
 499   return aSelected;
 500 }
 501
 502 //********************************************************************
 503 void ModuleBase_WidgetMultiSelector::updateSelectionList(AttributeSelectionListPtr theList)
 504 {
 505   myListControl->clear();
 506   for (int i = 0; i < theList->size(); i++) {
 507     AttributeSelectionPtr aAttr = theList->value(i);
 508     myListControl->addItem(aAttr->namingName().c_str());
 509   }
 510   // We have to call repaint because sometimes the List control is not updated
 511   myListControl->repaint();
 512 }
 513
 514 //********************************************************************
 515 std::string ModuleBase_WidgetMultiSelector::validatorType(const QString& theType) const
 516 {
 517   std::string aType;
 518
 519   if (theType == "Vertices")
 520     aType = "vertex";
 521   else if (theType == "Edges")
 522     aType = "edge";
 523   else if (theType == "Faces")
 524     aType = "face";
 525   else if (theType == "Solids")
 526     aType = "solid";
 527
 528   return aType;
 529 }
 530
 531 //********************************************************************
 532 void ModuleBase_WidgetMultiSelector::onCopyItem()
 533 {
 534   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 535   QString aRes;
 536   foreach(QListWidgetItem* aItem, aItems) {
 537     if (!aRes.isEmpty())
 538       aRes += "\n";
 539     aRes += aItem->text();
 540   }
 541   if (!aRes.isEmpty()) {
 542     QClipboard *clipboard = QApplication::clipboard();
 543     clipboard->setText(aRes);
 544   }
 545 }
 546
 547 //********************************************************************
 548 void ModuleBase_WidgetMultiSelector::onListSelection()
 549 {
 550   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 551   myCopyAction->setEnabled(!aItems.isEmpty());
 552 }
 553