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 #include <ModelAPI_AttributeSelectionList.h>
  23 #include <ModelAPI_AttributeRefList.h>
  24
  25 #include <Config_WidgetAPI.h>
  26
  27 #include <QGridLayout>
  28 #include <QLabel>
  29 #include <QListWidget>
  30 #include <QObject>
  31 #include <QString>
  32 #include <QComboBox>
  33 #include <QEvent>
  34 #include <QAction>
  35 #include <QApplication>
  36 #include <QClipboard>
  37
  38 #include <memory>
  39 #include <string>
  40
  41 class CustomListWidget : public QListWidget
  42 {
  43 public:
  44   CustomListWidget( QWidget* theParent )
  45     : QListWidget( theParent )
  46   {
  47   }
  48
  49   virtual QSize sizeHint() const
  50   {
  51     int aHeight = 2*QFontMetrics( font() ).height();
  52     QSize aSize = QListWidget::sizeHint();
  53     return QSize( aSize.width(), aHeight );
  54   }
  55
  56   virtual QSize minimumSizeHint() const
  57   {
  58     int aHeight = 2*QFontMetrics( font() ).height();
  59     QSize aSize = QListWidget::minimumSizeHint();
  60     return QSize( aSize.width(), aHeight );
  61   }
  62 };
  63
  64 ModuleBase_WidgetMultiSelector::ModuleBase_WidgetMultiSelector(QWidget* theParent,
  65                                                                ModuleBase_IWorkshop* theWorkshop,
  66                                                                const Config_WidgetAPI* theData,
  67                                                                const std::string& theParentId)
  68  : ModuleBase_WidgetSelector(theParent, theWorkshop, theData, theParentId),
  69    mySelectionCount(0)
  70 {
  71   QGridLayout* aMainLay = new QGridLayout(this);
  72   ModuleBase_Tools::adjustMargins(aMainLay);
  73
  74   QLabel* aTypeLabel = new QLabel(tr("Type"), this);
  75   aMainLay->addWidget(aTypeLabel, 0, 0);
  76
  77   myTypeCombo = new QComboBox(this);
  78   // There is no sense to parameterize list of types while we can not parameterize selection mode
  79
  80   std::string aPropertyTypes = theData->getProperty("type_choice");
  81   QString aTypesStr = aPropertyTypes.c_str();
  82   QStringList aShapeTypes = aTypesStr.split(' ');
  83
  84   myIsUseChoice = theData->getBooleanAttribute("use_choice", true);
  85
  86   myTypeCombo->addItems(aShapeTypes);
  87   aMainLay->addWidget(myTypeCombo, 0, 1);
  88   // if the xml definition contains one type, the controls to select a type should not be shown
  89   if (aShapeTypes.size() == 1 || !myIsUseChoice) {
  90     aTypeLabel->setVisible(false);
  91     myTypeCombo->setVisible(false);
  92   }
  93
  94   std::string aLabelText = theData->getProperty("label");
  95   QLabel* aListLabel = new QLabel(!aLabelText.empty() ? aLabelText.c_str()
  96                                                       : tr("Selected objects:"), this);
  97   aMainLay->addWidget(aListLabel, 1, 0);
  98   // if the xml definition contains one type, an information label should be shown near to the latest
  99   if (aShapeTypes.size() == 1) {
 100     QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
 101     if (!aLabelIcon.isEmpty()) {
 102       QLabel* aSelectedLabel = new QLabel("", this);
 103       aSelectedLabel->setPixmap(QPixmap(aLabelIcon));
 104       aMainLay->addWidget(aSelectedLabel, 1, 1);
 105     }
 106     aMainLay->setColumnStretch(2, 1);
 107   }
 108
 109   myListControl = new CustomListWidget(this);
 110   aMainLay->addWidget(myListControl, 2, 0, 1, -1);
 111   aMainLay->setRowStretch(2, 1);
 112   //aMainLay->addWidget(new QLabel(this)); //FIXME(sbh)???
 113   //aMainLay->setRowMinimumHeight(3, 20);
 114   //this->setLayout(aMainLay);
 115   connect(myTypeCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(onSelectionTypeChanged()));
 116
 117   myCopyAction = new QAction(QIcon(":pictures/copy.png"), tr("Copy"), this);
 118   myCopyAction->setShortcut(QKeySequence::Copy);
 119   myCopyAction->setEnabled(false);
 120   connect(myCopyAction, SIGNAL(triggered(bool)), SLOT(onCopyItem()));
 121   myListControl->addAction(myCopyAction);
 122   myListControl->setContextMenuPolicy(Qt::ActionsContextMenu);
 123   connect(myListControl, SIGNAL(itemSelectionChanged()), SLOT(onListSelection()));
 124 }
 125
 126 ModuleBase_WidgetMultiSelector::~ModuleBase_WidgetMultiSelector()
 127 {
 128 }
 129
 130 //********************************************************************
 131 bool ModuleBase_WidgetMultiSelector::storeValueCustom() const
 132 {
 133   // the value is stored on the selection changed signal processing
 134   // A rare case when plugin was not loaded.
 135   if (!myFeature)
 136     return false;
 137
 138   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 139   if (aSelectionListAttr.get()) {
 140      aSelectionListAttr->setSelectionType(myTypeCombo->currentText().toStdString());
 141   }
 142    return true;
 143 }
 144
 145 //********************************************************************
 146 bool ModuleBase_WidgetMultiSelector::restoreValueCustom()
 147 {
 148   // A rare case when plugin was not loaded.
 149   if (!myFeature)
 150     return false;
 151
 152   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 153   if (aSelectionListAttr.get()) {
 154     // Restore shape type
 155     if (!aSelectionListAttr->selectionType().empty())
 156       setCurrentShapeType(ModuleBase_Tools::shapeType(aSelectionListAttr->selectionType().c_str()));
 157   }
 158   updateSelectionList();
 159   return true;
 160 }
 161
 162 //********************************************************************
 163 void ModuleBase_WidgetMultiSelector::storeAttributeValue()
 164 {
 165   ModuleBase_WidgetValidated::storeAttributeValue();
 166
 167   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 168   if (aSelectionListAttr.get()) {
 169     mySelectionType = aSelectionListAttr->selectionType();
 170     mySelectionCount = aSelectionListAttr->size();
 171   }
 172   else {
 173     AttributeRefListPtr aRefListAttr = myFeature->data()->reflist(attributeID());
 174     mySelectionCount = aRefListAttr->size();
 175   }
 176 }
 177
 178 //********************************************************************
 179 void ModuleBase_WidgetMultiSelector::restoreAttributeValue(bool theValid)
 180 {
 181   ModuleBase_WidgetValidated::restoreAttributeValue(theValid);
 182
 183   // Store shape type
 184   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 185   if (aSelectionListAttr.get()) {
 186     aSelectionListAttr->setSelectionType(mySelectionType);
 187
 188     // restore selection in the attribute. Indeed there is only one stored object
 189     int aCountAppened = aSelectionListAttr->size() - mySelectionCount;
 190     for (int i = 0; i < aCountAppened; i++)
 191       aSelectionListAttr->removeLast();
 192   }
 193   else {
 194     AttributeRefListPtr aRefListAttr = myFeature->data()->reflist(attributeID());
 195     // restore objects in the attribute. Indeed there is only one stored object
 196 #ifdef DEBUG_REFLIST
 197     int aCountAppened = aRefListAttr->size() - mySelectionCount;
 198     for (int i = 0; i < aCountAppened; i++)
 199       aRefListAttr->removeLast();
 200 #endif
 201   }
 202 }
 203
 204 //********************************************************************
 205 void ModuleBase_WidgetMultiSelector::clearAttribute()
 206 {
 207   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 208   if (aSelectionListAttr.get())
 209     aSelectionListAttr->clear();
 210   else {
 211     AttributeRefListPtr aRefListAttr = myFeature->data()->reflist(attributeID());
 212     aRefListAttr->clear();
 213   }
 214 }
 215
 216 //********************************************************************
 217 void ModuleBase_WidgetMultiSelector::setObject(ObjectPtr theSelectedObject,
 218                                                GeomShapePtr theShape)
 219 {
 220   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 221   if (aSelectionListAttr.get()) {
 222     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theSelectedObject);
 223     aSelectionListAttr->append(aResult, theShape, myIsInValidate);
 224   }
 225   else {
 226     AttributeRefListPtr aRefListAttr = myFeature->data()->reflist(attributeID());
 227     aRefListAttr->append(theSelectedObject);
 228   }
 229 }
 230
 231 //********************************************************************
 232 bool ModuleBase_WidgetMultiSelector::setSelection(QList<ModuleBase_ViewerPrs>& theValues,
 233                                                   const bool theToValidate)
 234 {
 235   QList<ModuleBase_ViewerPrs> aSkippedValues;
 236
 237   QList<ModuleBase_ViewerPrs>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
 238   bool isDone = false;
 239   for (; anIt != aLast; anIt++) {
 240     ModuleBase_ViewerPrs aValue = *anIt;
 241     bool aProcessed = false;
 242     if (!theToValidate || isValidInFilters(aValue)) {
 243       aProcessed = setSelectionCustom(aValue);
 244     }
 245     else
 246       aSkippedValues.append(aValue);
 247     // if there is at least one set, the result is true
 248     isDone = isDone || aProcessed;
 249   }
 250   // updateObject - to update/redisplay feature
 251   // it is commented in order to perfom it outside the method
 252   //if (isDone) {
 253     //updateObject(myFeature);
 254     // this emit is necessary to call store/restore method an restore type of selection
 255     //emit valuesChanged();
 256   //}
 257   theValues.clear();
 258   if (!aSkippedValues.empty())
 259     theValues.append(aSkippedValues);
 260
 261   return isDone;
 262 }
 263
 264 //********************************************************************
 265 bool ModuleBase_WidgetMultiSelector::isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs)
 266 {
 267   bool aValid = ModuleBase_WidgetSelector::isValidSelectionCustom(thePrs);
 268   if (aValid) {
 269     ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
 270     aValid = aResult.get() != NULL;
 271     if (aValid) {
 272       if (myFeature) {
 273         // We can not select a result of our feature
 274         const std::list<ResultPtr>& aResList = myFeature->results();
 275         std::list<ResultPtr>::const_iterator aIt;
 276         bool isSkipSelf = false;
 277         for (aIt = aResList.cbegin(); aIt != aResList.cend(); ++aIt) {
 278           if ((*aIt) == aResult) {
 279             isSkipSelf = true;
 280             break;
 281           }
 282         }
 283         if (isSkipSelf)
 284           aValid = false;
 285       }
 286     }
 287   }
 288   return aValid;
 289 }
 290
 291 //********************************************************************
 292 QList<QWidget*> ModuleBase_WidgetMultiSelector::getControls() const
 293 {
 294   QList<QWidget*> result;
 295   //result << myTypeCombo;
 296   result << myListControl;
 297   return result;
 298 }
 299
 300 //********************************************************************
 301 void ModuleBase_WidgetMultiSelector::onSelectionTypeChanged()
 302 {
 303   activateSelection(true);
 304   activateFilters(true);
 305   QList<ModuleBase_ViewerPrs> anEmptyList;
 306   // This method will call Selection changed event which will call onSelectionChanged
 307   // To clear mySelection, myListControl and storeValue()
 308   // So, we don't need to call it
 309   myWorkshop->setSelected(anEmptyList);
 310 }
 311
 312 void ModuleBase_WidgetMultiSelector::updateFocus()
 313 {
 314   // Set focus to List control in order to make possible
 315   // to use Tab key for transfer the focus to next widgets
 316   myListControl->setCurrentRow(myListControl->model()->rowCount() - 1);
 317   myListControl->setFocus();
 318 }
 319
 320 //********************************************************************
 321 void ModuleBase_WidgetMultiSelector::updateSelectionName()
 322 {
 323 }
 324
 325 //********************************************************************
 326 QIntList ModuleBase_WidgetMultiSelector::getShapeTypes() const
 327 {
 328   QIntList aShapeTypes;
 329
 330   if (myTypeCombo->count() > 1 && myIsUseChoice) {
 331     aShapeTypes.append(ModuleBase_Tools::shapeType(myTypeCombo->currentText()));
 332   }
 333   else {
 334     for (int i = 0, aCount = myTypeCombo->count(); i < aCount; i++) {
 335       aShapeTypes.append(ModuleBase_Tools::shapeType(myTypeCombo->itemText(i)));
 336     }
 337   }
 338   return aShapeTypes;
 339 }
 340
 341 //********************************************************************
 342 void ModuleBase_WidgetMultiSelector::setCurrentShapeType(const TopAbs_ShapeEnum theShapeType)
 343 {
 344   QString aShapeTypeName;
 345
 346   for (int idx = 0; idx < myTypeCombo->count(); ++idx) {
 347     aShapeTypeName = myTypeCombo->itemText(idx);
 348     TopAbs_ShapeEnum aRefType = ModuleBase_Tools::shapeType(aShapeTypeName);
 349     if(aRefType == theShapeType && idx != myTypeCombo->currentIndex()) {
 350       activateSelection(false);
 351       activateFilters(false);
 352       bool isBlocked = myTypeCombo->blockSignals(true);
 353       myTypeCombo->setCurrentIndex(idx);
 354       myTypeCombo->blockSignals(isBlocked);
 355
 356       activateSelection(true);
 357       activateFilters(true);
 358       break;
 359     }
 360   }
 361 }
 362
 363 QList<ModuleBase_ViewerPrs> ModuleBase_WidgetMultiSelector::getAttributeSelection() const
 364 {
 365   QList<ModuleBase_ViewerPrs> aSelected;
 366   // Restore selection in the viewer by the attribute selection list
 367   if(myFeature) {
 368     AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 369     if (aSelectionListAttr.get()) {
 370       for (int i = 0; i < aSelectionListAttr->size(); i++) {
 371         AttributeSelectionPtr anAttr = aSelectionListAttr->value(i);
 372         ResultPtr anObject = anAttr->context();
 373         if (anObject.get()) {
 374           TopoDS_Shape aShape;
 375           std::shared_ptr<GeomAPI_Shape> aShapePtr = anAttr->value();
 376           if (aShapePtr.get()) {
 377             aShape = aShapePtr->impl<TopoDS_Shape>();
 378           }
 379           aSelected.append(ModuleBase_ViewerPrs(anObject, aShape, NULL));
 380         }
 381       }
 382     }
 383     else {
 384       AttributeRefListPtr aRefListAttr = myFeature->data()->reflist(attributeID());
 385       if (aRefListAttr.get()) {
 386         for (int i = 0; i < aRefListAttr->size(); i++) {
 387           ObjectPtr anObject = aRefListAttr->object(i);
 388           if (anObject.get()) {
 389             aSelected.append(ModuleBase_ViewerPrs(anObject, TopoDS_Shape(), NULL));
 390           }
 391         }
 392       }
 393     }
 394   }
 395   return aSelected;
 396 }
 397
 398 //********************************************************************
 399 void ModuleBase_WidgetMultiSelector::updateSelectionList()
 400 {
 401   myListControl->clear();
 402
 403   AttributeSelectionListPtr aSelectionListAttr = myFeature->data()->selectionList(attributeID());
 404   if (aSelectionListAttr.get()) {
 405     for (int i = 0; i < aSelectionListAttr->size(); i++) {
 406       AttributeSelectionPtr aAttr = aSelectionListAttr->value(i);
 407       myListControl->addItem(aAttr->namingName().c_str());
 408     }
 409   }
 410   else {
 411     AttributeRefListPtr aRefListAttr = myFeature->data()->reflist(attributeID());
 412     for (int i = 0; i < aRefListAttr->size(); i++) {
 413       ObjectPtr anObject = aRefListAttr->object(i);
 414       if (anObject.get())
 415         myListControl->addItem(anObject->data()->name().c_str());
 416     }
 417   }
 418   // We have to call repaint because sometimes the List control is not updated
 419   myListControl->repaint();
 420 }
 421
 422 //********************************************************************
 423 std::string ModuleBase_WidgetMultiSelector::validatorType(const QString& theType) const
 424 {
 425   std::string aType;
 426
 427   if (theType == "Vertices")
 428     aType = "vertex";
 429   else if (theType == "Edges")
 430     aType = "edge";
 431   else if (theType == "Faces")
 432     aType = "face";
 433   else if (theType == "Solids")
 434     aType = "solid";
 435
 436   return aType;
 437 }
 438
 439 //********************************************************************
 440 void ModuleBase_WidgetMultiSelector::onCopyItem()
 441 {
 442   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 443   QString aRes;
 444   foreach(QListWidgetItem* aItem, aItems) {
 445     if (!aRes.isEmpty())
 446       aRes += "\n";
 447     aRes += aItem->text();
 448   }
 449   if (!aRes.isEmpty()) {
 450     QClipboard *clipboard = QApplication::clipboard();
 451     clipboard->setText(aRes);
 452   }
 453 }
 454
 455 //********************************************************************
 456 void ModuleBase_WidgetMultiSelector::onListSelection()
 457 {
 458   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 459   myCopyAction->setEnabled(!aItems.isEmpty());
 460 }