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   ObjectPtr anObject = myWorkshop->selection()->getSelectableObject(thePrs.owner());
 202   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
 203
 204   if (myFeature) {
 205     // We can not select a result of our feature
 206     const std::list<ResultPtr>& aResList = myFeature->results();
 207     std::list<ResultPtr>::const_iterator aIt;
 208     bool isSkipSelf = false;
 209     for (aIt = aResList.cbegin(); aIt != aResList.cend(); ++aIt) {
 210       if ((*aIt) == aResult) {
 211         isSkipSelf = true;
 212         break;
 213       }
 214     }
 215     if(isSkipSelf)
 216       return false;
 217   }
 218
 219   // if the result has the similar shap as the parameter shape, just the context is set to the
 220   // selection list attribute.
 221   DataPtr aData = myFeature->data();
 222   AttributeSelectionListPtr aSelectionListAttr =
 223     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 224
 225   const TopoDS_Shape& aTDSShape = thePrs.shape();
 226   // if only result is selected, an empty shape is set to the model
 227   if (aTDSShape.IsNull()) {
 228     aSelectionListAttr->append(aResult, GeomShapePtr());
 229   }
 230   else {
 231     GeomShapePtr aShape = std::shared_ptr<GeomAPI_Shape>(new GeomAPI_Shape());
 232     aShape->setImpl(new TopoDS_Shape(aTDSShape));
 233     aSelectionListAttr->append(aResult, aShape);
 234   }
 235   return true;
 236 }
 237
 238 //********************************************************************
 239 QList<QWidget*> ModuleBase_WidgetMultiSelector::getControls() const
 240 {
 241   QList<QWidget*> result;
 242   //result << myTypeCombo;
 243   result << myListControl;
 244   return result;
 245 }
 246
 247 //********************************************************************
 248 bool ModuleBase_WidgetMultiSelector::eventFilter(QObject* theObj, QEvent* theEvent)
 249 {
 250   //TODO: Remove maybe?
 251   return ModuleBase_ModelWidget::eventFilter(theObj, theEvent);
 252 }
 253
 254 //********************************************************************
 255 void ModuleBase_WidgetMultiSelector::onSelectionTypeChanged()
 256 {
 257   activateShapeSelection();
 258   QObjectPtrList anEmptyList;
 259   myWorkshop->setSelected(anEmptyList);
 260   // Clear mySelection, myListControl and storeValue()
 261   onSelectionChanged();
 262 }
 263
 264 //********************************************************************
 265 void ModuleBase_WidgetMultiSelector::onSelectionChanged()
 266 {
 267   QList<ModuleBase_ViewerPrs> aSelected = getSelectedEntitiesOrObjects(myWorkshop->selection());
 268
 269   DataPtr aData = myFeature->data();
 270   AttributeSelectionListPtr aSelectionListAttr =
 271     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(aData->attribute(attributeID()));
 272
 273   aSelectionListAttr->clear();
 274   if (aSelected.size() > 0) {
 275     foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
 276       if (isValidSelection(aPrs)) {
 277         setSelectionCustom(aPrs);
 278       }
 279     }
 280   }
 281   emit valuesChanged();
 282   // the updateObject method should be called to flush the updated sigal. The workshop listens it,
 283   // calls validators for the feature and, as a result, updates the Apply button state.
 284   updateObject(myFeature);
 285 }
 286
 287 //********************************************************************
 288 void ModuleBase_WidgetMultiSelector::setCurrentShapeType(const TopAbs_ShapeEnum theShapeType)
 289 {
 290   QString aShapeTypeName;
 291
 292   for (int idx = 0; idx < myTypeCombo->count(); ++idx) {
 293     aShapeTypeName = myTypeCombo->itemText(idx);
 294     TopAbs_ShapeEnum aRefType = ModuleBase_WidgetShapeSelector::shapeType(aShapeTypeName);
 295     if(aRefType == theShapeType && idx != myTypeCombo->currentIndex()) {
 296       myIsActive = false;
 297       activateShapeSelection();
 298       bool isBlocked = myTypeCombo->blockSignals(true);
 299       myTypeCombo->setCurrentIndex(idx);
 300       myIsActive = true;
 301       myTypeCombo->blockSignals(isBlocked);
 302       activateShapeSelection();
 303       break;
 304     }
 305   }
 306 }
 307
 308 void ModuleBase_WidgetMultiSelector::activateShapeSelection()
 309 {
 310   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
 311
 312   if (myIsActive) {
 313     QString aNewType = myTypeCombo->currentText();
 314     QIntList aList;
 315     aList.append(ModuleBase_WidgetShapeSelector::shapeType(aNewType));
 316     myWorkshop->activateSubShapesSelection(aList);
 317   } else {
 318     myWorkshop->deactivateSubShapesSelection();
 319   }
 320
 321   activateFilters(myWorkshop, myIsActive);
 322 }
 323
 324 //********************************************************************
 325 void ModuleBase_WidgetMultiSelector::updateSelectionList(AttributeSelectionListPtr theList)
 326 {
 327   myListControl->clear();
 328   for (int i = 0; i < theList->size(); i++) {
 329     AttributeSelectionPtr aAttr = theList->value(i);
 330     myListControl->addItem(aAttr->namingName().c_str());
 331   }
 332   // We have to call repaint because sometimes the List control is not updated
 333   myListControl->repaint();
 334 }
 335
 336 //********************************************************************
 337 void ModuleBase_WidgetMultiSelector::onCopyItem()
 338 {
 339   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 340   QString aRes;
 341   foreach(QListWidgetItem* aItem, aItems) {
 342     if (!aRes.isEmpty())
 343       aRes += "\n";
 344     aRes += aItem->text();
 345   }
 346   if (!aRes.isEmpty()) {
 347     QClipboard *clipboard = QApplication::clipboard();
 348     clipboard->setText(aRes);
 349   }
 350 }
 351
 352 //********************************************************************
 353 void ModuleBase_WidgetMultiSelector::onListSelection()
 354 {
 355   QList<QListWidgetItem*> aItems = myListControl->selectedItems();
 356   myCopyAction->setEnabled(!aItems.isEmpty());
 357 }
 358