src/ModuleBase/ModuleBase_WidgetValidated.cpp

   1 // Copyright (C) 2014-2019  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_WidgetValidated.h>
  21 #include <ModuleBase_IModule.h>
  22 #include <ModuleBase_IViewer.h>
  23 #include <ModuleBase_IWorkshop.h>
  24 #include <ModuleBase_ISelection.h>
  25 #include <ModuleBase_ISelectionActivate.h>
  26 #include <ModuleBase_WidgetSelectorStore.h>
  27 #include <ModuleBase_ViewerPrs.h>
  28
  29 #include <Events_InfoMessage.h>
  30
  31 #include <ModelAPI_Session.h>
  32 #include <ModelAPI_Validator.h>
  33 #include <ModelAPI_AttributeValidator.h>
  34 #include <ModelAPI_Events.h>
  35 #include <ModelAPI_ResultBody.h>
  36 #include <ModelAPI_Tools.h>
  37 #include <ModelAPI_AttributeSelection.h>
  38
  39 #include <SelectMgr_ListIteratorOfListOfFilter.hxx>
  40 #include <SelectMgr_EntityOwner.hxx>
  41 #include <StdSelect_BRepOwner.hxx>
  42
  43 #include <Events_Loop.h>
  44
  45 #include <QWidget>
  46
  47 //#define DEBUG_VALID_STATE
  48
  49 ModuleBase_WidgetValidated::ModuleBase_WidgetValidated(QWidget* theParent,
  50                                                        ModuleBase_IWorkshop* theWorkshop,
  51                                                        const Config_WidgetAPI* theData)
  52 : ModuleBase_ModelWidget(theParent, theData),
  53   myWorkshop(theWorkshop), myIsInValidate(false)
  54 {
  55   myAttributeStore = new ModuleBase_WidgetSelectorStore();
  56 }
  57
  58 ModuleBase_WidgetValidated::~ModuleBase_WidgetValidated()
  59 {
  60   delete myAttributeStore;
  61 }
  62
  63 //********************************************************************
  64 ObjectPtr ModuleBase_WidgetValidated::findPresentedObject(const AISObjectPtr& theAIS) const
  65 {
  66   return myPresentedObject;
  67 }
  68
  69 //********************************************************************
  70 void ModuleBase_WidgetValidated::deactivate()
  71 {
  72   clearValidatedCash();
  73 }
  74
  75 //********************************************************************
  76 void ModuleBase_WidgetValidated::clearValidatedCash()
  77 {
  78 #ifdef DEBUG_VALID_STATE
  79   qDebug("clearValidatedCash");
  80 #endif
  81   myValidPrs.Clear();
  82   myInvalidPrs.Clear();
  83 }
  84
  85 //********************************************************************
  86 void ModuleBase_WidgetValidated::storeAttributeValue(const AttributePtr& theAttribute)
  87 {
  88   myIsInValidate = true;
  89   myAttributeStore->storeAttributeValue(theAttribute, myWorkshop);
  90 }
  91
  92 //********************************************************************
  93 void ModuleBase_WidgetValidated::restoreAttributeValue(const AttributePtr& theAttribute,
  94                                                        const bool theValid)
  95 {
  96   myIsInValidate = false;
  97   myAttributeStore->restoreAttributeValue(theAttribute, myWorkshop);
  98 }
  99
 100 //********************************************************************
 101 bool ModuleBase_WidgetValidated::isValidInFilters(const ModuleBase_ViewerPrsPtr& thePrs)
 102 {
 103   bool aValid = true;
 104   Handle(SelectMgr_EntityOwner) anOwner = thePrs->owner();
 105
 106   // if an owner is null, the selection happens in the Object browser.
 107   // creates a selection owner on the base of object shape and the object AIS object
 108   if (anOwner.IsNull() && thePrs->owner().IsNull() && thePrs->object().get()) {
 109     ResultPtr aResult = myWorkshop->selection()->getResult(thePrs);
 110     GeomShapePtr aShape = aResult.get() ? aResult->shape() : GeomShapePtr();
 111     // some results have no shape, e.g. the parameter one. So, they should not be validated
 112     if (aShape.get()) {
 113       const TopoDS_Shape aTDShape = aShape->impl<TopoDS_Shape>();
 114       Handle(AIS_InteractiveObject) anIO = myWorkshop->selection()->getIO(thePrs);
 115       anOwner = new StdSelect_BRepOwner(aTDShape, anIO);
 116       myPresentedObject = aResult;
 117     }
 118     else {
 119       //FeaturePtr aFeature = ModelAPI_Feature::feature(thePrs->object());
 120       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(thePrs->object());
 121       if (aFeature.get()) {
 122         // Use feature as a reference to all its results
 123         myPresentedObject = aFeature;
 124         AttributePtr anAttr = attribute();
 125         std::string aType = anAttr->attributeType();
 126
 127         // Check that results of Feature is acceptable by filters for selection attribute
 128         if (aType == ModelAPI_AttributeSelection::typeId()) {
 129           AttributeSelectionPtr aSelectAttr =
 130             std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(anAttr);
 131           aSelectAttr->setValue(myPresentedObject, GeomShapePtr(), true);
 132           GeomShapePtr aShape = aSelectAttr->value();
 133           if (!aShape.get() && aSelectAttr->contextFeature().get() &&
 134             aSelectAttr->contextFeature()->firstResult().get()) {
 135             aShape = aSelectAttr->contextFeature()->firstResult()->shape();
 136           }
 137           if (aShape.get()) {
 138             const TopoDS_Shape aTDShape = aShape->impl<TopoDS_Shape>();
 139             Handle(AIS_InteractiveObject) anIO = myWorkshop->selection()->getIO(thePrs);
 140             anOwner = new StdSelect_BRepOwner(aTDShape, anIO);
 141           }
 142           else
 143             aValid = false;
 144           aSelectAttr->setValue(ObjectPtr(), GeomShapePtr(), true);
 145         }
 146         else {
 147           ResultPtr aResult = aFeature->firstResult();
 148           if (aResult.get()) {
 149             GeomShapePtr aShapePtr = ModelAPI_Tools::shape(aResult);
 150             if (aShapePtr.get()) {
 151               const TopoDS_Shape aTDShape = aShapePtr->impl<TopoDS_Shape>();
 152               AISObjectPtr aIOPtr = myWorkshop->findPresentation(aResult);
 153               if (aIOPtr.get()) {
 154                 Handle(AIS_InteractiveObject) anIO = aIOPtr->impl<Handle(AIS_InteractiveObject)>();
 155                 anOwner = new StdSelect_BRepOwner(aTDShape, anIO);
 156               }
 157             }
 158           }
 159           aValid = !anOwner.IsNull(); // only results with a shape can be filtered
 160         }
 161       } else
 162         aValid = false; // only results with a shape can be filtered
 163     }
 164   }
 165   // checks the owner by the AIS context activated filters
 166   if (!anOwner.IsNull()) {
 167     // the widget validator filter should be active, but during check by preselection
 168     // it is not yet activated, so we need to activate/deactivate it manually
 169     bool isActivated = isFilterActivated();
 170     if (!isActivated) {
 171       QIntList aModuleSelectionFilters = myWorkshop->module()->selectionFilters();
 172       SelectMgr_ListOfFilter aSelectionFilters;
 173       selectionFilters(aModuleSelectionFilters, aSelectionFilters);
 174       /// after validation, the selection filters should be restored
 175       myWorkshop->selectionActivate()->activateSelectionFilters(aSelectionFilters);
 176     }
 177
 178     Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
 179     if (!aContext.IsNull()) {
 180       const SelectMgr_ListOfFilter& aFilters = aContext->Filters();
 181       SelectMgr_ListIteratorOfListOfFilter anIt(aFilters);
 182       for (; anIt.More() && aValid; anIt.Next()) {
 183         Handle(SelectMgr_Filter) aFilter = anIt.Value();
 184         aValid = aFilter->IsOk(anOwner);
 185       }
 186     }
 187     if (!isActivated)
 188     {
 189       // reset filters set in activateSelectionFilters above
 190       myWorkshop->selectionActivate()->updateSelectionFilters();
 191       clearValidatedCash();
 192     }
 193   }
 194
 195   // removes created owner
 196   if (!anOwner.IsNull() && anOwner != thePrs->owner()) {
 197     anOwner.Nullify();
 198     myPresentedObject = ObjectPtr();
 199   }
 200   return aValid;
 201 }
 202
 203 //********************************************************************
 204 AttributePtr ModuleBase_WidgetValidated::attribute() const
 205 {
 206   return myFeature->attribute(attributeID());
 207 }
 208
 209 //********************************************************************
 210 bool ModuleBase_WidgetValidated::isValidSelection(const ModuleBase_ViewerPrsPtr& theValue)
 211 {
 212   bool aValid = false;
 213   if (getValidState(theValue, aValid)) {
 214     return aValid;
 215   }
 216   aValid = isValidSelectionCustom(theValue);
 217   if (aValid)
 218     aValid = isValidSelectionForAttribute(theValue, attribute());
 219
 220   storeValidState(theValue, aValid);
 221   return aValid;
 222 }
 223
 224 //********************************************************************
 225 bool ModuleBase_WidgetValidated::isValidSelectionForAttribute(
 226                                             const ModuleBase_ViewerPrsPtr& theValue,
 227                                             const AttributePtr& theAttribute)
 228 {
 229   bool aValid = false;
 230
 231   // stores the current values of the widget attribute
 232   bool isFlushesActived, isAttributeSetInitializedBlocked, isAttributeSendUpdatedBlocked;
 233
 234   blockAttribute(theAttribute, true, isFlushesActived, isAttributeSetInitializedBlocked,
 235                  isAttributeSendUpdatedBlocked);
 236
 237   storeAttributeValue(theAttribute);
 238
 239   // saves the owner value to the widget attribute
 240   aValid = setSelectionCustom(theValue);
 241   if (aValid)
 242     // checks the attribute validity
 243     aValid = isValidAttribute(theAttribute);
 244
 245   // restores the current values of the widget attribute
 246   restoreAttributeValue(theAttribute, aValid);
 247
 248   blockAttribute(theAttribute, false, isFlushesActived, isAttributeSetInitializedBlocked,
 249                  isAttributeSendUpdatedBlocked);
 250   /// NDS: The following rows are commented for issue #1452 (to be removed after debug)
 251   /// This is not correct to perform it here because it might cause update selection and
 252   /// the selection mechanizm will be circled: use the scenario of the bug with preselected point.
 253   // In particular case the results are deleted and called as redisplayed inside of this
 254   // highlight-selection, to they must be flushed as soon as possible.
 255   // Example: selection of group-vertices subshapes with shift pressend on body. Without
 256   //  these 4 lines below the application crashes because of left presentations on
 257   //  removed results still in the viewer.
 258   /*static Events_ID aDeletedEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
 259   static Events_ID aRedispEvent = Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY);
 260   Events_Loop::loop()->flush(aDeletedEvent);
 261   Events_Loop::loop()->flush(aRedispEvent);
 262   */
 263   return aValid;
 264 }
 265
 266 //********************************************************************
 267 bool ModuleBase_WidgetValidated::isValidSelectionCustom(const ModuleBase_ViewerPrsPtr& thePrs)
 268 {
 269   return true;
 270 }
 271
 272 //********************************************************************
 273 bool ModuleBase_WidgetValidated::isValidAttribute(const AttributePtr& theAttribute)
 274 {
 275   SessionPtr aMgr = ModelAPI_Session::get();
 276   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
 277   std::string aValidatorID;
 278   Events_InfoMessage anError;
 279   return aFactory->validate(theAttribute, aValidatorID, anError);
 280 }
 281
 282 //********************************************************************
 283 bool ModuleBase_WidgetValidated::isFilterActivated() const
 284 {
 285   bool isActivated = false;
 286
 287   Handle(SelectMgr_Filter) aSelFilter = myWorkshop->validatorFilter();
 288   ModuleBase_IViewer* aViewer = myWorkshop->viewer();
 289
 290   return aViewer->hasSelectionFilter(aSelFilter);
 291 }
 292
 293 //********************************************************************
 294 void ModuleBase_WidgetValidated::selectionFilters(QIntList& theModuleSelectionFilters,
 295                                                   SelectMgr_ListOfFilter& theSelectionFilters)
 296 {
 297   theSelectionFilters.Append(myWorkshop->validatorFilter());
 298 }
 299
 300 //********************************************************************
 301 void ModuleBase_WidgetValidated::blockAttribute(const AttributePtr& theAttribute,
 302                                                 const bool& theToBlock,
 303                                                 bool& isFlushesActived,
 304                                                 bool& isAttributeSetInitializedBlocked,
 305                                                 bool& isAttributeSendUpdatedBlocked)
 306 {
 307   blockFeatureAttribute(theAttribute, myFeature, theToBlock, isFlushesActived,
 308                         isAttributeSetInitializedBlocked, isAttributeSendUpdatedBlocked);
 309 }
 310
 311 //********************************************************************
 312 void ModuleBase_WidgetValidated::blockFeatureAttribute(const AttributePtr& theAttribute,
 313                                                 const FeaturePtr& theFeature,
 314                                                 const bool& theToBlock,
 315                                                 bool& isFlushesActived,
 316                                                 bool& isAttributeSetInitializedBlocked,
 317                                                 bool& isAttributeSendUpdatedBlocked)
 318 {
 319   Events_Loop* aLoop = Events_Loop::loop();
 320   DataPtr aData = theFeature->data();
 321   if (theToBlock) {
 322     // blocks the flush signals to avoid the temporary objects visualization in the viewer
 323     // they should not be shown in order to do not lose highlight by erasing them
 324     isFlushesActived = aLoop->activateFlushes(false);
 325
 326     isAttributeSendUpdatedBlocked = aData->blockSendAttributeUpdated(true);
 327     isAttributeSetInitializedBlocked = theAttribute->blockSetInitialized(true);
 328   }
 329   else {
 330     aData->blockSendAttributeUpdated(isAttributeSendUpdatedBlocked, false);
 331     theAttribute->blockSetInitialized(isAttributeSetInitializedBlocked);
 332     aLoop->activateFlushes(isFlushesActived);
 333   }
 334 }
 335
 336 //********************************************************************
 337 void ModuleBase_WidgetValidated::storeValidState(const ModuleBase_ViewerPrsPtr& theValue,
 338                                                  const bool theValid)
 339 {
 340   GeomShapePtr aShape = theValue.get() ? theValue->shape() : GeomShapePtr();
 341   if (aShape.get()) {
 342     if (theValid) {
 343       const TopoDS_Shape& aTDShape = aShape->impl<TopoDS_Shape>();
 344       bool aValidPrsContains = myValidPrs.IsBound(aTDShape) &&
 345                                theValue.get()->isEqual(myValidPrs.Find(aTDShape).get());
 346       if (!aValidPrsContains) {
 347   #ifdef LIST_OF_VALID_PRS
 348         myValidPrs.append(theValue);
 349   #else
 350         myValidPrs.Bind(aTDShape, theValue);
 351   #endif
 352       // the commented code will be useful when the valid state of the presentation
 353       // will be changable between activate/deactivate. Currently it does not happen.
 354       //if (anInvalidPrs)
 355       //  myInvalidPrs.removeOne(theValue);
 356       }
 357     }
 358     else { // !theValid
 359       if (aShape.get()) {
 360         const TopoDS_Shape& aTDShape = aShape->impl<TopoDS_Shape>();
 361         bool anIValidPrsContains = myInvalidPrs.IsBound(aTDShape) &&
 362                                    theValue.get()->isEqual(myInvalidPrs.Find(aTDShape).get());
 363         if (!anIValidPrsContains) {
 364     #ifdef LIST_OF_VALID_PRS
 365           myInvalidPrs.append(theValue);
 366     #else
 367           myInvalidPrs.Bind(aTDShape, theValue);
 368     #endif
 369         //if (!aValidPrs)
 370         //  myValidPrs.removeOne(theValue);
 371         }
 372       }
 373     }
 374   }
 375   #ifdef DEBUG_VALID_STATE
 376     qDebug(QString("storeValidState: myValidPrs.size() = %1, myInvalidPrs.size() = %2")
 377                    .arg(myValidPrs.count())
 378                    .arg(myInvalidPrs.count()).toStdString().c_str());
 379   #endif
 380 }
 381
 382 //********************************************************************
 383 bool ModuleBase_WidgetValidated::getValidState(const ModuleBase_ViewerPrsPtr& theValue,
 384                                                bool& theValid)
 385 {
 386   if (!theValue.get())
 387     return false;
 388
 389 #ifdef LIST_OF_VALID_PRS
 390   bool aValidPrsContains = myValidPrs.contains(theValue);
 391   bool anInvalidPrsContains = myInvalidPrs.contains(theValue);
 392 #else
 393   GeomShapePtr aShape = theValue.get() ? theValue->shape() : GeomShapePtr();
 394   if (!aShape.get())
 395     return false;
 396
 397   const TopoDS_Shape& aTDShape = aShape->impl<TopoDS_Shape>();
 398   bool aValidPrsContains = myValidPrs.IsBound(aTDShape) &&
 399                            theValue.get()->isEqual(myValidPrs.Find(aTDShape).get());
 400
 401   bool anInvalidPrsContains = myInvalidPrs.IsBound(aTDShape) &&
 402                               theValue.get()->isEqual(myInvalidPrs.Find(aTDShape).get());
 403   /*
 404   bool aValidPrsContains = false, anInvalidPrsContains = false;
 405   GeomShapePtr aShape = theValue.get() ? theValue->shape() : GeomShapePtr();
 406   if (aShape.get()) {
 407     aValidPrsContains = myValidPrs.contains(aShape);
 408     anInvalidPrsContains = myInvalidPrs.contains(aShape);
 409
 410     if (aValidPrsContains)
 411       aValidPrsContains = theValue == myValidPrs[aShape];
 412     else
 413       anInvalidPrsContains = theValue == myInvalidPrs[aShape];*/
 414 #endif
 415
 416   if (aValidPrsContains)
 417     theValid = true;
 418   else if (anInvalidPrsContains)
 419     theValid = false;
 420
 421   return aValidPrsContains || anInvalidPrsContains;
 422 }
 423
 424 //********************************************************************
 425 QList<ModuleBase_ViewerPrsPtr> ModuleBase_WidgetValidated::getFilteredSelected()
 426 {
 427   QList<ModuleBase_ViewerPrsPtr> aSelected = myWorkshop->selection()->getSelected(
 428                                                        ModuleBase_ISelection::Viewer);
 429
 430   QList<ModuleBase_ViewerPrsPtr> anOBSelected = myWorkshop->selection()->getSelected(
 431                                                        ModuleBase_ISelection::Browser);
 432   // filter the OB presentations
 433   filterPresentations(anOBSelected);
 434   if (!anOBSelected.isEmpty())
 435     ModuleBase_ISelection::appendSelected(anOBSelected, aSelected);
 436
 437   filterCompSolids(aSelected);
 438
 439   return aSelected;
 440 }
 441
 442 //********************************************************************
 443 void ModuleBase_WidgetValidated::filterPresentations(QList<ModuleBase_ViewerPrsPtr>& theValues)
 444 {
 445   QList<ModuleBase_ViewerPrsPtr> aValidatedValues;
 446   foreach(ModuleBase_ViewerPrsPtr aPrs, theValues) {
 447     if (isValidInFilters(aPrs))
 448       aValidatedValues.append(aPrs);
 449   }
 450   if (aValidatedValues.size() != theValues.size()) {
 451     theValues.clear();
 452     theValues = aValidatedValues;
 453   }
 454 }
 455
 456 //********************************************************************
 457 void ModuleBase_WidgetValidated::filterCompSolids(QList<ModuleBase_ViewerPrsPtr>& theValues)
 458 {
 459   std::set<ResultPtr> aFilterOut; // all objects that must be filtered out with their children
 460   QList<ModuleBase_ViewerPrsPtr> aValidatedValues;
 461
 462   // Collect compsolids.
 463   QList<ModuleBase_ViewerPrsPtr>::const_iterator anIt = theValues.begin(), aLast = theValues.end();
 464   for(; anIt != aLast; anIt++) {
 465     const ModuleBase_ViewerPrsPtr& aViewerPrs = *anIt;
 466     ObjectPtr anObject = aViewerPrs->object();
 467     ResultBodyPtr aResultCompSolid =
 468       std::dynamic_pointer_cast<ModelAPI_ResultBody>(anObject);
 469     if (aResultCompSolid.get()) {
 470       for(int aSubIndex = 0; aSubIndex < aResultCompSolid->numberOfSubs(); aSubIndex++)
 471         aFilterOut.insert(aResultCompSolid->subResult(aSubIndex));
 472     } else { // it could be a whole feature selected, so, add all results of this feature
 473       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
 474       if (aFeature.get()) {
 475         std::list<ResultPtr>::const_iterator aRes = aFeature->results().cbegin();
 476         for(; aRes != aFeature->results().cend(); aRes++)
 477           aFilterOut.insert(*aRes);
 478       }
 479     }
 480   }
 481
 482   // Filter sub-solids of compsolids.
 483   anIt = theValues.begin();
 484   for(; anIt != aLast; anIt++) {
 485     const ModuleBase_ViewerPrsPtr& aViewerPrs = *anIt;
 486     ObjectPtr anObject = aViewerPrs->object();
 487     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
 488     while(aResult.get()) {
 489       if (aFilterOut.find(aResult) != aFilterOut.end()) // skip if parent is filtered out
 490         break;
 491       aResult = ModelAPI_Tools::bodyOwner(aResult); // iterate all parents
 492     }
 493     if (aResult.get()) {
 494       continue; // skip
 495     } else {
 496       aValidatedValues.append(*anIt);
 497     }
 498   }
 499
 500   if (aValidatedValues.size() != theValues.size()) {
 501     theValues.clear();
 502     theValues = aValidatedValues;
 503   }
 504 }