src/ModuleBase/ModuleBase_WidgetFeatureSelector.cpp

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include <ModuleBase_WidgetFeatureSelector.h>
  21
  22 #include <ModuleBase_Definitions.h>
  23 #include <ModuleBase_ISelection.h>
  24 #include <ModuleBase_IWorkshop.h>
  25 #include <ModuleBase_IViewer.h>
  26 #include <ModuleBase_Tools.h>
  27 #include <ModuleBase_Filter.h>
  28 #include <ModuleBase_IModule.h>
  29 #include <ModuleBase_ViewerPrs.h>
  30 #include <ModuleBase_IconFactory.h>
  31 #include <ModuleBase_ResultPrs.h>
  32
  33 #include <Config_WidgetAPI.h>
  34 #include <Events_Loop.h>
  35 #include <Events_Message.h>
  36 #include <GeomAPI_Interface.h>
  37 #include <GeomAPI_Shape.h>
  38
  39 #include <ModelAPI_Data.h>
  40 #include <ModelAPI_Document.h>
  41 #include <ModelAPI_Events.h>
  42 #include <ModelAPI_Feature.h>
  43 #include <ModelAPI_Result.h>
  44 #include <ModelAPI_Session.h>
  45
  46 #include <Config_WidgetAPI.h>
  47
  48 #include <GeomAPI_Shape.h>
  49
  50 #include <QWidget>
  51 #include <QLayout>
  52 #include <QLabel>
  53 #include <QLineEdit>
  54 #include <QToolButton>
  55 #include <QString>
  56 #include <QEvent>
  57 #include <QApplication>
  58 #include <QFormLayout>
  59
  60 #include <memory>
  61
  62 #include <list>
  63 #include <string>
  64
  65
  66 ModuleBase_WidgetFeatureSelector::ModuleBase_WidgetFeatureSelector(QWidget* theParent,
  67                                                      ModuleBase_IWorkshop* theWorkshop,
  68                                                      const Config_WidgetAPI* theData)
  69 : ModuleBase_WidgetValidated(theParent, theWorkshop, theData)
  70 {
  71   QFormLayout* aLayout = new QFormLayout(this);
  72   ModuleBase_Tools::adjustMargins(aLayout);
  73
  74   QString aLabelText = translate(theData->widgetLabel());
  75   QString aLabelIcon = QString::fromStdString(theData->widgetIcon());
  76   myLabel = new QLabel(aLabelText, this);
  77   if (!aLabelIcon.isEmpty())
  78     myLabel->setPixmap(ModuleBase_IconFactory::loadPixmap(aLabelIcon));
  79
  80
  81   QString aToolTip = translate(theData->widgetTooltip());
  82   myTextLine = new QLineEdit(this);
  83   QString anObjName = QString::fromStdString(attributeID());
  84   myTextLine->setObjectName(anObjName);
  85   myTextLine->setReadOnly(true);
  86   myTextLine->setToolTip(aToolTip);
  87   myTextLine->installEventFilter(this);
  88
  89   aLayout->addRow(myLabel, myTextLine);
  90   myLabel->setToolTip(aToolTip);
  91 }
  92
  93 //********************************************************************
  94 ModuleBase_WidgetFeatureSelector::~ModuleBase_WidgetFeatureSelector()
  95 {
  96 }
  97
  98 //********************************************************************
  99 bool ModuleBase_WidgetFeatureSelector::setSelectionCustom(const ModuleBase_ViewerPrsPtr& thePrs)
 100 {
 101   ObjectPtr anObject = ModelAPI_Feature::feature(thePrs->object());
 102   GeomShapePtr aShape;
 103
 104   FeaturePtr aFeature = ModelAPI_Feature::feature(anObject);
 105   // the last flag is to be depending on hasObject is called before. To be corrected later
 106   return ModuleBase_Tools::setObject(attribute(), aFeature, aShape,
 107                                      myWorkshop, myIsInValidate, true);
 108 }
 109
 110 //********************************************************************
 111 void ModuleBase_WidgetFeatureSelector::selectionModes(int& theModuleSelectionModes,
 112                                                       QIntList& theModes)
 113 {
 114   theModuleSelectionModes = -1;
 115   theModes.push_back(ModuleBase_ResultPrs::Sel_Result);
 116 }
 117
 118 //********************************************************************
 119 void ModuleBase_WidgetFeatureSelector::activateCustom()
 120 {
 121   // Restore selection in the viewer by the attribute selection list
 122   // it should be postponed to have current widget as active to validate restored selection
 123   //static Events_ID anEvent = Events_Loop::eventByName(EVENT_UPDATE_BY_WIDGET_SELECTION);
 124   //ModelAPI_EventCreator::get()->sendUpdated(myFeature, anEvent);
 125 }
 126
 127 //********************************************************************
 128 bool ModuleBase_WidgetFeatureSelector::storeValueCustom()
 129 {
 130   // the value is stored on the selection changed signal processing
 131   return true;
 132 }
 133
 134 //********************************************************************
 135 bool ModuleBase_WidgetFeatureSelector::setSelection(QList<ModuleBase_ViewerPrsPtr>& theValues,
 136                                                   const bool theToValidate)
 137 {
 138   if (theValues.empty()) {
 139     // In order to make reselection possible, set empty object and shape should be done
 140     setSelectionCustom(std::shared_ptr<ModuleBase_ViewerPrs>(new ModuleBase_ViewerPrs(
 141                                                   ObjectPtr(), GeomShapePtr(), NULL)));
 142     return false;
 143   }
 144   // it removes the processed value from the parameters list
 145   ModuleBase_ViewerPrsPtr aValue = theValues.takeFirst();
 146   bool isDone = false;
 147
 148   if (!theToValidate || isValidSelection(aValue))
 149     isDone = setSelectionCustom(aValue);
 150
 151   return isDone;
 152 }
 153
 154 //********************************************************************
 155 bool ModuleBase_WidgetFeatureSelector::restoreValueCustom()
 156 {
 157   bool isBlocked = this->blockSignals(true);
 158   updateSelectionName();
 159   this->blockSignals(isBlocked);
 160
 161   return true;
 162 }
 163
 164 //********************************************************************
 165 QList<QWidget*> ModuleBase_WidgetFeatureSelector::getControls() const
 166 {
 167   QList<QWidget*> aControls;
 168   aControls.append(myTextLine);
 169   return aControls;
 170 }
 171
 172 void ModuleBase_WidgetFeatureSelector::updateFocus()
 173 {
 174   emit focusOutWidget(this);
 175 }
 176
 177 //********************************************************************
 178 void ModuleBase_WidgetFeatureSelector::updateSelectionName()
 179 {
 180   DataPtr aData = myFeature->data();
 181   if (!aData->isValid())
 182     return;
 183
 184   ObjectPtr anObject = ModuleBase_Tools::getObject(myFeature->attribute(attributeID()));
 185   if (anObject.get() != NULL) {
 186     std::wstring aName = anObject->data()->name();
 187     myTextLine->setText(QString::fromStdWString(aName));
 188   } else {
 189     myTextLine->clear();
 190   }
 191 }
 192
 193 //********************************************************************
 194 bool ModuleBase_WidgetFeatureSelector::isValidInFilters(const ModuleBase_ViewerPrsPtr& thePrs)
 195 {
 196   bool aValid = false;
 197
 198   ObjectPtr anObject = thePrs->object();
 199   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
 200   aValid = aFeature.get();
 201   if (!aValid) {
 202     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
 203     aValid = aResult.get() && aResult->shape() == thePrs->shape();
 204   }
 205
 206   return aValid;
 207 }
 208
 209 //********************************************************************
 210 bool ModuleBase_WidgetFeatureSelector::processSelection()
 211 {
 212   QList<ModuleBase_ViewerPrsPtr> aSelected = myWorkshop->selection()->getSelected(
 213                                                               ModuleBase_ISelection::AllControls);
 214
 215   bool isDone = setSelection(aSelected, true/*false*/);
 216   updateOnSelectionChanged(isDone);
 217
 218   return isDone;
 219 }
 220
 221 //********************************************************************
 222 void ModuleBase_WidgetFeatureSelector::updateOnSelectionChanged(const bool theDone)
 223 {
 224   // "false" flag should be used here, it connects to the #26658 OCC bug, when the user click in
 225   // the same place repeatedly without mouse moved. In the case validation by filters is not
 226   // perfromed, so an invalid object is selected. E.g. distance constraint, selection of a point.
 227   // the 3rd click in the same point allow using this point.
 228   emit valuesChanged();
 229   // the updateObject method should be called to flush the updated sigal. The workshop listens it,
 230   // calls validators for the feature and, as a result, updates the Apply button state.
 231   updateObject(myFeature);
 232
 233   // we need to forget about previous validation result as the current selection can influence on it
 234   clearValidatedCash();
 235
 236   if (theDone)
 237     updateFocus();
 238 }
 239
 240