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