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 <ModelAPI_Data.h>
  19 #include <ModelAPI_Object.h>
  20
  21 #include <Config_WidgetAPI.h>
  22
  23 #include <QGridLayout>
  24 #include <QLabel>
  25 #include <QListWidget>
  26 #include <QObject>
  27 #include <QString>
  28 #include <QComboBox>
  29 #include <QEvent>
  30 #include <QAction>
  31 #include <QApplication>
  32 #include <QClipboard>
  33
  34 #include <memory>
  35 #include <string>
  36
  37 ModuleBase_WidgetMultiSelector::ModuleBase_WidgetMultiSelector(QWidget* theParent,
  38                                                                ModuleBase_IWorkshop* theWorkshop,
  39                                                                const Config_WidgetAPI* theData,
  40                                                                const std::string& theParentId)
  41     : ModuleBase_WidgetValidated(theParent, theData, theParentId),
  42       myWorkshop(theWorkshop)
  43 {
  44   QGridLayout* aMainLay = new QGridLayout(this);
  45   ModuleBase_Tools::adjustMargins(aMainLay);
  46
  47   QLabel* aTypeLabel = new QLabel(tr("Type"), this);
  48   aMainLay->addWidget(aTypeLabel, 0, 0);
  49
  50   myTypeCombo = new QComboBox(this);
  51   // There is no sence to paramerize list of types while we can not parametrize selection mode
  52
  53   std::string aPropertyTypes = theData->getProperty("type_choice");
  54   QString aTypesStr = aPropertyTypes.c_str();
  55   QStringList aShapeTypes = aTypesStr.split(' ');
  56
  57   myTypeCombo->addItems(aShapeTypes);
  58   aMainLay->addWidget(myTypeCombo, 0, 1);
  59   // if the xml definition contains one type, the controls to select a type should not be shown
  60   if (aShapeTypes.size() == 1) {
  61     aTypeLabel->setVisible(false);
  62     myTypeCombo->setVisible(false);
  63   }
  64
  65   QLabel* aListLabel = new QLabel(tr("Selected objects:"), this);
  66   aMainLay->addWidget(aListLabel, 1, 0);
  67   // if the xml definition contains one type, an information label should be shown near to the latest
  68   if (aShapeTypes.size() == 1) {
  69     QString aLabelText = QString::fromStdString(theData->widgetLabel());
  70     QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
  71     QLabel* aSelectedLabel = new QLabel(aLabelText, this);
  72     if (!aLabelIcon.isEmpty())
  73       aSelectedLabel->setPixmap(QPixmap(aLabelIcon));
  74     aMainLay->addWidget(aSelectedLabel, 1, 1);
  75     aMainLay->setColumnStretch(2, 1);
  76   }
  77
  78   myListControl = new QListWidget(this);
  79   aMainLay->addWidget(myListControl, 2, 0, 2, -1);
  80   aMainLay->setRowStretch(2, 1);
  81   aMainLay->addWidget(new QLabel(this)); //FIXME(sbh)???
  82   aMainLay->setRowMinimumHeight(3, 20);
  83   this->setLayout(aMainLay);
  84   connect(myTypeCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(onSelectionTypeChanged()));
  85
  86   myCopyAction = new QAction(QIcon(":pictures/copy.png"), tr("Copy"), this);
  87   myCopyAction->setShortcut(QKeySequence::Copy);
  88   myCopyAction->setEnabled(false);
  89   connect(myCopyAction, SIGNAL(triggered(bool)), SLOT(onCopyItem()));
  90   myListControl->addAction(myCopyAction);
  91   myListControl->setContextMenuPolicy(Qt::ActionsContextMenu);
  92   connect(myListControl, SIGNAL(itemSelectionChanged()), SLOT(onListSelection()));
  93 }
  94
  95 ModuleBase_WidgetMultiSelector::~ModuleBase_WidgetMultiSelector()
  96 {
  97   activateShapeSelection(false);
  98   activateFilters(myWorkshop, false);
  99 }
 100
 101 //********************************************************************
 102 void ModuleBase_WidgetMultiSelector::activateCustom()
 103 {
 104   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
 105   connect(myWorkshop, SIGNAL(selectionChanged()),
 106           this,       SLOT(onSelectionChanged()),
 107           Qt::UniqueConnection);
 108
 109   activateShapeSelection(true);
 110
 111   // Restore selection in the viewer by the attribute selection list
 112   myWorkshop->setSelected(getAttributeSelection());
 113
 114   activateFilters(myWorkshop, true);
 115 }
 116
 117 //********************************************************************
 118 void ModuleBase_WidgetMultiSelector::deactivate()
 119 {
 120   disconnect(myWorkshop, SIGNAL(selectionChanged()), this, SLOT(onSelectionChanged()));
 121   activateShapeSelection(false);
 122   activateFilters(myWorkshop, false);
 123 }
 124
 125 //********************************************************************
 126 bool ModuleBase_WidgetMultiSelector::storeValueCustom() const
 127 {
 128   // the value is stored on the selection changed signal processing
 129   // A rare case when plugin was not loaded.
 130   if(!myFeature)
 131     return false;
 132   DataPtr aData = myFeature->data();
 133   AttributeSelectionListPtr aSelectionListAttr =
 134     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 135
 136   if (aSelectionListAttr) {
 137     // Store shapes type
 138      TopAbs_ShapeEnum aCurrentType =
 139            ModuleBase_Tools::shapeType(myTypeCombo->currentText());
 140      aSelectionListAttr->setSelectionType(myTypeCombo->currentText().toStdString());
 141   }
 142    return true;
 143 }
 144
 145 //********************************************************************
 146 bool ModuleBase_WidgetMultiSelector::restoreValue()
 147 {
 148   // A rare case when plugin was not loaded.
 149   if(!myFeature)
 150     return false;
 151   DataPtr aData = myFeature->data();
 152   AttributeSelectionListPtr aSelectionListAttr =
 153     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 154
 155   if (aSelectionListAttr) {
 156     // Restore shape type
 157     if (!aSelectionListAttr->selectionType().empty())
 158       setCurrentShapeType(ModuleBase_Tools::shapeType(aSelectionListAttr->selectionType().c_str()));
 159     updateSelectionList(aSelectionListAttr);
 160     return true;
 161   }
 162   return false;
 163 }
 164
 165 //********************************************************************
 166 void ModuleBase_WidgetMultiSelector::storeAttributeValue()
 167 {
 168   DataPtr aData = myFeature->data();
 169   AttributeSelectionListPtr aSelectionListAttr =
 170     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 171   if (aSelectionListAttr.get() == NULL)
 172     return;
 173
 174   mySelectionType = aSelectionListAttr->selectionType();
 175   mySelection.clear();
 176   int aSize = aSelectionListAttr->size();
 177   for (int i = 0; i < aSelectionListAttr->size(); i++) {
 178     AttributeSelectionPtr aSelectAttr = aSelectionListAttr->value(i);
 179     mySelection.append(GeomSelection(aSelectAttr->context(), aSelectAttr->value()));
 180   }
 181 }
 182
 183 //********************************************************************
 184 void ModuleBase_WidgetMultiSelector::restoreAttributeValue(bool/* theValid*/)
 185 {
 186   DataPtr aData = myFeature->data();
 187   AttributeSelectionListPtr aSelectionListAttr =
 188     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 189   if (aSelectionListAttr.get() == NULL)
 190     return;
 191   aSelectionListAttr->clear();
 192
 193   // Store shapes type
 194   aSelectionListAttr->setSelectionType(mySelectionType);
 195
 196   // Store selection in the attribute
 197   int aSize = mySelection.size();
 198   foreach (GeomSelection aSelec, mySelection) {
 199     aSelectionListAttr->append(aSelec.first, aSelec.second);
 200   }
 201 }
 202
 203 //********************************************************************
 204 bool ModuleBase_WidgetMultiSelector::setSelection(const QList<ModuleBase_ViewerPrs>& theValues,
 205                                                   int& thePosition)
 206 {
 207   if (thePosition < 0)
 208     return false;
 209
 210   QList<ModuleBase_ViewerPrs>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
 211   bool isDone = false;
 212   for (int i = thePosition; i < theValues.size(); i++) {
 213     ModuleBase_ViewerPrs aValue = theValues[i];
 214     thePosition++;
 215     bool aProcessed = false;
 216     if (isValidSelection(aValue)) {
 217       aProcessed = setSelectionCustom(aValue);
 218     }
 219     // if there is at least one set, the result is true
 220     isDone = isDone || aProcessed;
 221     // when an object, which do not satisfy the validating process, stop set selection
 222     if (!aProcessed)
 223       break;
 224   }
 225   if (isDone) {
 226     updateObject(myFeature);
 227     // this emit is necessary to call store/restore method an restore type of selection
 228     emit valuesChanged();
 229   }
 230   return isDone;
 231 }
 232
 233 //********************************************************************
 234 bool ModuleBase_WidgetMultiSelector::setSelectionCustom(const ModuleBase_ViewerPrs& thePrs)
 235 {
 236   TopoDS_Shape aShape = thePrs.shape();
 237   if ((myTypeCombo->count() > 1) && (!aShape.IsNull())) {
 238     TopAbs_ShapeEnum aType = ModuleBase_Tools::shapeType(myTypeCombo->currentText());
 239     if (aShape.ShapeType() != aType)
 240       return false;
 241   }
 242   ResultPtr aResult;
 243   if (!thePrs.owner().IsNull()) {
 244     ObjectPtr anObject = myWorkshop->selection()->getSelectableObject(thePrs.owner());
 245     aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
 246   }
 247   else {
 248     aResult = std::dynamic_pointer_cast<ModelAPI_Result>(thePrs.object());
 249   }
 250
 251
 252   if (myFeature) {
 253     // We can not select a result of our feature
 254     const std::list<ResultPtr>& aResList = myFeature->results();
 255     std::list<ResultPtr>::const_iterator aIt;
 256     bool isSkipSelf = false;
 257     for (aIt = aResList.cbegin(); aIt != aResList.cend(); ++aIt) {
 258       if ((*aIt) == aResult) {
 259         isSkipSelf = true;
 260         break;
 261       }
 262     }
 263     if(isSkipSelf)
 264       return false;
 265   }
 266
 267   // if the result has the similar shap as the parameter shape, just the context is set to the
 268   // selection list attribute.
 269   DataPtr aData = myFeature->data();
 270   AttributeSelectionListPtr aSelectionListAttr =
 271     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 272
 273   const TopoDS_Shape& aTDSShape = thePrs.shape();
 274   // if only result is selected, an empty shape is set to the model
 275   if (aTDSShape.IsNull()) {
 276     aSelectionListAttr->append(aResult, GeomShapePtr());
 277   }
 278   else {
 279     GeomShapePtr aShape(new GeomAPI_Shape());
 280     aShape->setImpl(new TopoDS_Shape(aTDSShape));
 281     // We can not select a result of our feature
 282     if (aShape->isEqual(aResult->shape()))
 283       aSelectionListAttr->append(aResult, GeomShapePtr());
 284     else
 285       aSelectionListAttr->append(aResult, aShape);
 286   }
 287   return true;
 288 }
 289
 290 //********************************************************************
 291 QList<QWidget*> ModuleBase_WidgetMultiSelector::getControls() const
 292 {
 293   QList<QWidget*> result;
 294   //result << myTypeCombo;
 295   result << myListControl;
 296   return result;
 297 }
 298
 299 //********************************************************************
 300 bool ModuleBase_WidgetMultiSelector::eventFilter(QObject* theObj, QEvent* theEvent)
 301 {
 302   //TODO: Remove maybe?
 303   return ModuleBase_ModelWidget::eventFilter(theObj, theEvent);
 304 }
 305
 306 //********************************************************************
 307 void ModuleBase_WidgetMultiSelector::onSelectionTypeChanged()
 308 {
 309   activateShapeSelection(true);
 310   activateFilters(myWorkshop, true);
 311   QList<ModuleBase_ViewerPrs> anEmptyList;
 312   // This method will call Selection changed event which will call onSelectionChanged
 313   // To clear mySelection, myListControl and storeValue()
 314   // So, we don't need to call it
 315   myWorkshop->setSelected(anEmptyList);
 316 }
 317
 318 //********************************************************************
 319 void ModuleBase_WidgetMultiSelector::onSelectionChanged()
 320 {
 321   QList<ModuleBase_ViewerPrs> aSelected = getSelectedEntitiesOrObjects(myWorkshop->selection());
 322
 323   DataPtr aData = myFeature->data();
 324   AttributeSelectionListPtr aSelectionListAttr =
 325     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 326
 327   aSelectionListAttr->clear();
 328   if (aSelected.size() > 0) {
 329     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 330       if (isValidSelection(aPrs)) {
 331         setSelectionCustom(aPrs);
 332       }
 333     }
 334   }
 335   emit valuesChanged();
 336   // the updateObject method should be called to flush the updated sigal. The workshop listens it,
 337   // calls validators for the feature and, as a result, updates the Apply button state.
 338   updateObject(myFeature);
 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       activateShapeSelection(false);
 351       activateFilters(myWorkshop, false);
 352       bool isBlocked = myTypeCombo->blockSignals(true);
 353       myTypeCombo->setCurrentIndex(idx);
 354       myTypeCombo->blockSignals(isBlocked);
 355
 356       activateShapeSelection(true);
 357       activateFilters(myWorkshop, true);
 358       break;
 359     }
 360   }
 361 }
 362
 363 void ModuleBase_WidgetMultiSelector::activateShapeSelection(const bool isActivated)
 364 {
 365   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
 366
 367   if (isActivated) {
 368     QString aNewType = myTypeCombo->currentText();
 369     QIntList aList;
 370     aList.append(ModuleBase_Tools::shapeType(aNewType));
 371     myWorkshop->activateSubShapesSelection(aList);
 372   } else {
 373     myWorkshop->deactivateSubShapesSelection();
 374   }
 375 }
 376
 377 QList<ModuleBase_ViewerPrs> ModuleBase_WidgetMultiSelector::getAttributeSelection() const
 378 {
 379   QList<ModuleBase_ViewerPrs> aSelected;
 380   // Restore selection in the viewer by the attribute selection list
 381   if(myFeature) {
 382     DataPtr aData = myFeature->data();
 383     AttributeSelectionListPtr aListAttr =
 384       std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 385     if (aListAttr) {
 386       for (int i = 0; i < aListAttr->size(); i++) {
 387         AttributeSelectionPtr anAttr = aListAttr->value(i);
 388         ResultPtr anObject = anAttr->context();
 389         if (anObject.get()) {
 390           TopoDS_Shape aShape;
 391           std::shared_ptr<GeomAPI_Shape> aShapePtr = anAttr->value();
 392           if (aShapePtr.get()) {
 393             aShape = aShapePtr->impl<TopoDS_Shape>();
 394           }
 395           aSelected.append(ModuleBase_ViewerPrs(anObject, aShape, NULL));
 396         }
 397       }
 398     }
 399   }
 400   return aSelected;
 401 }
 402
 403 //********************************************************************
 404 void ModuleBase_WidgetMultiSelector::updateSelectionList(AttributeSelectionListPtr theList)
 405 {
 406   myListControl->clear();
 407   for (int i = 0; i < theList->size(); i++) {
 408     AttributeSelectionPtr aAttr = theList->value(i);
 409     myListControl->addItem(aAttr->namingName().c_str());
 410   }
 411   // We have to call repaint because sometimes the List control is not updated
 412   myListControl->repaint();
 413 }
 414
 415 //********************************************************************
 416 void ModuleBase_WidgetMultiSelector::onCopyItem()
 417 {
 418   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 419   QString aRes;
 420   foreach(QListWidgetItem* aItem, aItems) {
 421     if (!aRes.isEmpty())
 422       aRes += "\n";
 423     aRes += aItem->text();
 424   }
 425   if (!aRes.isEmpty()) {
 426     QClipboard *clipboard = QApplication::clipboard();
 427     clipboard->setText(aRes);
 428   }
 429 }
 430
 431 //********************************************************************
 432 void ModuleBase_WidgetMultiSelector::onListSelection()
 433 {
 434   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 435   myCopyAction->setEnabled(!aItems.isEmpty());
 436 }
 437