src/PartSet/PartSet_OperationPrs.cpp

   1 // Copyright (C) 2014-2020  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 "PartSet_OperationPrs.h"
  21 #include "PartSet_Tools.h"
  22
  23 #include "XGUI_Workshop.h"
  24 #include "XGUI_ModuleConnector.h"
  25 #include "XGUI_Displayer.h"
  26 #include "XGUI_Tools.h"
  27
  28 #include "ModuleBase_Tools.h"
  29 #include "ModuleBase_IModule.h"
  30 #include <ModuleBase_IPropertyPanel.h>
  31 #include <ModuleBase_ModelWidget.h>
  32 #include <ModuleBase_ViewerPrs.h>
  33
  34 #include <ModelAPI_Events.h>
  35 #include <ModelAPI_Result.h>
  36 #include <ModelAPI_Attribute.h>
  37 #include <ModelAPI_AttributeRefAttr.h>
  38 #include <ModelAPI_AttributeReference.h>
  39 #include <ModelAPI_AttributeSelection.h>
  40 #include <ModelAPI_AttributeSelectionList.h>
  41 #include <ModelAPI_AttributeRefList.h>
  42 #include <ModelAPI_Validator.h>
  43 #include <ModelAPI_Session.h>
  44 #include <ModelAPI_ResultBody.h>
  45 #include <ModelAPI_Tools.h>
  46
  47 #include <Events_InfoMessage.h>
  48 #include <Events_Loop.h>
  49
  50 #include <GeomAPI_IPresentable.h>
  51
  52 #include <StdPrs_WFShape.hxx>
  53
  54 #include <QList>
  55
  56 #include <gp_Pnt.hxx>
  57 #include <TopoDS_Vertex.hxx>
  58 #include <BRepBuilderAPI_MakeVertex.hxx>
  59 #include <BRep_Builder.hxx>
  60 #include <TopoDS_Compound.hxx>
  61 #include <Prs3d_IsoAspect.hxx>
  62
  63 //#define DEBUG_EMPTY_SHAPE
  64 //#define DEBUG_OPERATION_PRS
  65
  66 // multi-rotation/translation operation
  67 //#define DEBUG_HIDE_COPY_ATTRIBUTE
  68 #ifdef DEBUG_HIDE_COPY_ATTRIBUTE
  69 #include <ModelAPI_AttributeBoolean.h>
  70 #include <SketchPlugin_SketchEntity.h>
  71 #endif
  72
  73 IMPLEMENT_STANDARD_RTTIEXT(PartSet_OperationPrs, ViewerData_AISShape);
  74
  75 PartSet_OperationPrs::PartSet_OperationPrs(ModuleBase_IWorkshop* theWorkshop)
  76 : ViewerData_AISShape(TopoDS_Shape()), myWorkshop(theWorkshop), myUseAISWidth(false)
  77 {
  78 #ifdef DEBUG_OPERATION_PRS
  79   qDebug("PartSet_OperationPrs::PartSet_OperationPrs");
  80 #endif
  81   myShapeColor = Quantity_Color(1, 1, 1, Quantity_TOC_RGB);
  82
  83   // first presentation for having correct Compute until presentation with shapes are set
  84   gp_Pnt aPnt(0.0, 0.0, 0.0);
  85   BRepBuilderAPI_MakeVertex aMaker(aPnt);
  86   TopoDS_Vertex aVertex = aMaker.Vertex();
  87   myShapeToPrsMap.Bind(aVertex, NULL);
  88
  89   Handle(Prs3d_Drawer) aDrawer = Attributes();
  90   Handle(Prs3d_IsoAspect) aUIsoAspect = new Prs3d_IsoAspect(myShapeColor, Aspect_TOL_SOLID, 1, 0);
  91   Handle(Prs3d_IsoAspect) aVIsoAspect = new Prs3d_IsoAspect(myShapeColor, Aspect_TOL_SOLID, 1, 0);
  92   aDrawer->SetUIsoAspect(aUIsoAspect);
  93   aDrawer->SetVIsoAspect(aVIsoAspect);
  94   aDrawer->SetIsoOnPlane(false);
  95   //aDrawer->SetTypeOfDeflection(Aspect_TOD_ABSOLUTE);
  96 }
  97
  98 bool PartSet_OperationPrs::hasShapes()
  99 {
 100   return !myShapeToPrsMap.IsEmpty();
 101 }
 102
 103 void PartSet_OperationPrs::setShapeColor(const Quantity_Color& theColor)
 104 {
 105   myShapeColor = theColor;
 106 }
 107
 108 void PartSet_OperationPrs::useAISWidth()
 109 {
 110   myUseAISWidth = true;
 111 }
 112
 113 void PartSet_OperationPrs::Compute(
 114             const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
 115             const Handle(Prs3d_Presentation)& thePresentation,
 116             const Standard_Integer theMode)
 117 {
 118 #ifdef DEBUG_OPERATION_PRS
 119   qDebug("PartSet_OperationPrs::Compute -- begin");
 120 #endif
 121
 122   SetColor(myShapeColor);
 123   thePresentation->Clear();
 124   bool aReadyToDisplay = !myShapeToPrsMap.IsEmpty();
 125
 126   Handle(Prs3d_Drawer) aDrawer = Attributes();
 127   // create presentations on the base of the shapes
 128   BRep_Builder aBuilder;
 129   TopoDS_Compound aComp;
 130   aBuilder.MakeCompound(aComp);
 131   for(NCollection_DataMap<TopoDS_Shape, Handle(AIS_InteractiveObject)>::Iterator
 132       anIter(myShapeToPrsMap); anIter.More(); anIter.Next()) {
 133     const TopoDS_Shape& aShape = anIter.Key();
 134     aBuilder.Add(aComp, aShape);
 135     // change deviation coefficient to provide more precise circle
 136     // as there is no result, the shape is processed to correct deviation. To be unified
 137     ModuleBase_Tools::setDefaultDeviationCoefficient(aShape, aDrawer);
 138     ModuleBase_Tools::setDefaultDeviationCoefficient(aShape, DynamicHilightAttributes());
 139
 140     if (myUseAISWidth) {
 141       Handle(AIS_InteractiveObject) anIO = anIter.Value();
 142       if (!anIO.IsNull()) {
 143         int aWidth = anIO->Width();
 144         /// workaround for zero width. Else, there will be a crash
 145         if (aWidth == 0) { // width returns of TSolid shape is zero
 146           aWidth = PartSet_Tools::getAISDefaultWidth();// default width value
 147         }
 148         setWidth(aDrawer, aWidth);
 149       }
 150     }
 151     try {
 152       StdPrs_WFShape::Add(thePresentation, aShape, aDrawer);
 153     }
 154     catch (...) {
 155       return;
 156     }
 157   }
 158   Set(aComp);
 159   if (!aReadyToDisplay) {
 160     Events_InfoMessage("PartSet_OperationPrs",
 161       "An empty AIS presentation: PartSet_OperationPrs").send();
 162     std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
 163                 new Events_Message(Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION)));
 164     Events_Loop::loop()->send(aMsg);
 165   }
 166 #ifdef DEBUG_OPERATION_PRS
 167   qDebug("PartSet_OperationPrs::Compute -- end");
 168 #endif
 169 }
 170
 171 void PartSet_OperationPrs::ComputeSelection(const Handle(SelectMgr_Selection)& aSelection,
 172                                             const Standard_Integer aMode)
 173 {
 174   // the presentation is not used in the selection
 175 }
 176
 177 NCollection_DataMap<TopoDS_Shape, Handle(AIS_InteractiveObject)>& PartSet_OperationPrs::shapesMap()
 178 {
 179   return myShapeToPrsMap;
 180 }
 181
 182 bool isSubObject(const ObjectPtr& theObject, const FeaturePtr& theFeature)
 183 {
 184   bool isSub = false;
 185   CompositeFeaturePtr aComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
 186   if (aComposite.get())
 187     isSub = aComposite->isSub(theObject);
 188
 189   return isSub;
 190 }
 191
 192 void PartSet_OperationPrs::addValue(const ObjectPtr& theObject, const GeomShapePtr& theShape,
 193                                     const FeaturePtr& theFeature, ModuleBase_IWorkshop* theWorkshop,
 194                                     QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes)
 195 {
 196   if (theObject.get()) {
 197     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 198     if (aResult.get()) {
 199       ResultBodyPtr aBodyResult =
 200         std::dynamic_pointer_cast<ModelAPI_ResultBody>(theObject);
 201       if (aBodyResult.get()) {
 202         if (aBodyResult->numberOfSubs() > 0) {
 203           for(int i = 0; i < aBodyResult->numberOfSubs(); i++) {
 204             ResultPtr aSubResult = aBodyResult->subResult(i);
 205             if (aSubResult.get()) {
 206               GeomShapePtr aShape;
 207               addValue(aSubResult, aShape, theFeature, theWorkshop, theObjectShapes);
 208             }
 209           }
 210           return;
 211         }
 212       }
 213 #ifdef DEBUG_HIDE_COPY_ATTRIBUTE
 214       else {
 215         FeaturePtr aFeature = ModelAPI_Feature::feature(theObject);
 216         if (aFeature.get()) {
 217           AttributeBooleanPtr aCopyAttr =
 218             aFeature->data()->boolean(SketchPlugin_SketchEntity::COPY_ID());
 219           if (aCopyAttr.get()) {
 220             bool isCopy = aCopyAttr->value();
 221             if (isCopy)
 222               return;
 223           }
 224         }
 225       }
 226 #endif
 227     }
 228
 229     GeomShapePtr aShape = theShape;
 230     if (!aShape.get()) {
 231       ResultPtr aRes = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 232       if (aRes.get())
 233         aShape = aRes->shape();
 234     }
 235     if (!isSubObject(theObject, theFeature))
 236       appendShapeIfVisible(theWorkshop, theObject, aShape, theObjectShapes);
 237   }
 238 }
 239
 240 void PartSet_OperationPrs::appendShapeIfVisible(ModuleBase_IWorkshop* theWorkshop,
 241                               const ObjectPtr& theObject,
 242                               GeomShapePtr theGeomShape,
 243                               QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes)
 244 {
 245   if (theGeomShape.get()) {
 246     if (theObjectShapes.contains(theObject))
 247       theObjectShapes[theObject].append(theGeomShape);
 248     else {
 249       QList<GeomShapePtr> aShapes;
 250       aShapes.append(theGeomShape);
 251       theObjectShapes[theObject] = aShapes;
 252     }
 253   } else {
 254 #ifdef DEBUG_EMPTY_SHAPE
 255     qDebug(QString("Empty shape in result, result: %1")
 256             .arg(ModuleBase_Tools::objectInfo(theObject)).toStdString().c_str());
 257 #endif
 258   }
 259 }
 260
 261 void PartSet_OperationPrs::getFeatureShapes(const FeaturePtr& theFeature,
 262                                             ModuleBase_IWorkshop* theWorkshop,
 263                                             QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes)
 264 {
 265   theObjectShapes.clear();
 266   if (!theFeature.get())
 267     return;
 268
 269   ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
 270
 271   QList<GeomShapePtr> aShapes;
 272   std::list<AttributePtr> anAttributes = theFeature->data()->attributes("");
 273   std::list<AttributePtr>::const_iterator anIt = anAttributes.begin(), aLast = anAttributes.end();
 274   for (; anIt != aLast; anIt++) {
 275     AttributePtr anAttribute = *anIt;
 276     if (!isSelectionAttribute(anAttribute))
 277       continue;
 278
 279     if (!aValidators->isCase(theFeature, anAttribute->id()))
 280       continue; // this attribute is not participated in the current case
 281
 282     std::string anAttrType = anAttribute->attributeType();
 283
 284     if (anAttrType == ModelAPI_AttributeSelectionList::typeId()) {
 285       std::shared_ptr<ModelAPI_AttributeSelectionList> aCurSelList =
 286               std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(anAttribute);
 287       for(int i = 0; i < aCurSelList->size(); i++) {
 288         std::shared_ptr<ModelAPI_AttributeSelection> aSelAttribute = aCurSelList->value(i);
 289         ResultPtr aResult = aSelAttribute->context();
 290         GeomShapePtr aShape = aSelAttribute->value();
 291         addValue(aResult, aShape, theFeature, theWorkshop, theObjectShapes);
 292       }
 293     }
 294     if (anAttrType == ModelAPI_AttributeRefList::typeId()) {
 295       std::shared_ptr<ModelAPI_AttributeRefList> aCurSelList =
 296         std::dynamic_pointer_cast<ModelAPI_AttributeRefList>(anAttribute);
 297       for (int i = 0; i < aCurSelList->size(); i++) {
 298         ObjectPtr anObject = aCurSelList->object(i);
 299         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
 300         // if a feature is stored in the attribute, we should obtain the feature results
 301         // e.g. feature rectangle uses parameters feature lines in the attribute
 302         if (aFeature.get()) {
 303           getResultShapes(aFeature, theWorkshop, theObjectShapes, false);
 304         }
 305         else {
 306           ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
 307           if (aResult.get()) {
 308             GeomShapePtr aShape = aResult->shape();
 309             if (aShape.get())
 310               addValue(aResult, aShape, theFeature, theWorkshop, theObjectShapes);
 311           }
 312         }
 313       }
 314     }
 315     else {
 316       ObjectPtr anObject;
 317       GeomShapePtr aShape;
 318       if (anAttrType == ModelAPI_AttributeRefAttr::typeId()) {
 319         AttributeRefAttrPtr aRefAttr =
 320           std::dynamic_pointer_cast<ModelAPI_AttributeRefAttr>(anAttribute);
 321         if (aRefAttr->isObject()) {
 322           anObject = aRefAttr->object();
 323         }
 324         else {
 325           AttributePtr anAttr = aRefAttr->attr();
 326           aShape = PartSet_Tools::findShapeBy2DPoint(anAttr, theWorkshop);
 327           // the distance point is not found if the point is selected in the 2nd time
 328           // TODO: after debug, this check can be removed
 329           if (!aShape.get())
 330             continue;
 331           anObject = anAttr->owner();
 332         }
 333       }
 334       if (anAttrType == ModelAPI_AttributeSelection::typeId()) {
 335         AttributeSelectionPtr anAttr =
 336           std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(anAttribute);
 337         anObject = anAttr->context();
 338         aShape = anAttr->value();
 339       }
 340       if (anAttrType == ModelAPI_AttributeReference::typeId()) {
 341         AttributeReferencePtr anAttr =
 342           std::dynamic_pointer_cast<ModelAPI_AttributeReference>(anAttribute);
 343         anObject = anAttr->value();
 344       }
 345       addValue(anObject, aShape, theFeature, theWorkshop, theObjectShapes);
 346     }
 347   }
 348 }
 349
 350 void PartSet_OperationPrs::getResultShapes(const FeaturePtr& theFeature,
 351                                            ModuleBase_IWorkshop* theWorkshop,
 352                                            QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes,
 353                                            const bool theListShouldBeCleared)
 354 {
 355   if (theListShouldBeCleared)
 356     theObjectShapes.clear();
 357
 358   if (!theFeature.get())
 359     return;
 360
 361   std::list<ResultPtr> aResults;
 362   ModelAPI_Tools::allResults(theFeature, aResults);
 363   std::list<ResultPtr>::const_iterator aRIt = aResults.begin(),
 364                                        aRLast = aResults.end();
 365   for (; aRIt != aRLast; aRIt++) {
 366     ResultPtr aResult = *aRIt;
 367     GeomShapePtr aGeomShape = aResult->shape();
 368     appendShapeIfVisible(theWorkshop, aResult, aGeomShape, theObjectShapes);
 369   }
 370 }
 371
 372 void PartSet_OperationPrs::getPresentationShapes(const FeaturePtr& theFeature,
 373                                            ModuleBase_IWorkshop* theWorkshop,
 374                                            QMap<ObjectPtr, QList<GeomShapePtr> >& theObjectShapes,
 375                                            const bool theListShouldBeCleared)
 376 {
 377   if (theListShouldBeCleared)
 378     theObjectShapes.clear();
 379
 380   if (!theFeature.get() || !theFeature->data()->isValid()) // if feature is already removed
 381     return;
 382
 383   XGUI_Displayer* aDisplayer = XGUI_Tools::workshop(theWorkshop)->displayer();
 384
 385   GeomPresentablePtr aPrs = std::dynamic_pointer_cast<GeomAPI_IPresentable>(theFeature);
 386   if (!aPrs.get())
 387     return;
 388
 389   AISObjectPtr anAIS = aPrs->getAISObject(aDisplayer->getAISObject(theFeature));
 390   if (!anAIS.get())
 391     return;
 392
 393   Handle(AIS_InteractiveObject) anAISPrs = anAIS->impl<Handle(AIS_InteractiveObject)>();
 394   if (!anAISPrs.IsNull()) {
 395     Handle(AIS_Shape) aShapePrs = Handle(AIS_Shape)::DownCast(anAISPrs);
 396     if (!aShapePrs.IsNull()) {
 397       TopoDS_Shape aShape = aShapePrs->Shape();
 398       if (!aShape.IsNull()) {
 399         std::shared_ptr<GeomAPI_Shape> aGeomShape(new GeomAPI_Shape());
 400         aGeomShape->setImpl(new TopoDS_Shape(aShape));
 401         appendShapeIfVisible(theWorkshop, theFeature, aGeomShape, theObjectShapes);
 402       }
 403     }
 404   }
 405 }
 406
 407 void PartSet_OperationPrs::getHighlightedShapes(ModuleBase_IWorkshop* theWorkshop,
 408                                                 QMap<ObjectPtr,
 409                                                 QList<GeomShapePtr> >& theObjectShapes)
 410 {
 411   theObjectShapes.clear();
 412
 413   QList<ModuleBase_ViewerPrsPtr> aValues;
 414   ModuleBase_ModelWidget* anActiveWidget = theWorkshop->module()->activeWidget();
 415   if (anActiveWidget)
 416     anActiveWidget->getHighlighted(aValues);
 417
 418   QList<GeomShapePtr> aShapes;
 419   QList<ModuleBase_ViewerPrsPtr>::const_iterator anIIt = aValues.begin(),
 420                                               aILast = aValues.end();
 421   for (; anIIt != aILast; anIIt++) {
 422     ModuleBase_ViewerPrsPtr aPrs = *anIIt;
 423     ObjectPtr anObject = aPrs->object();
 424
 425     GeomShapePtr aGeomShape = aPrs->shape();
 426     if (!aGeomShape.get() || aGeomShape->isNull()) {
 427       ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(anObject);
 428       if (aResult.get()) {
 429         aGeomShape = aResult->shape();
 430       }
 431     }
 432     appendShapeIfVisible(theWorkshop, anObject, aGeomShape, theObjectShapes);
 433   }
 434 }
 435
 436
 437 bool PartSet_OperationPrs::isSelectionAttribute(const AttributePtr& theAttribute)
 438 {
 439   std::string anAttrType = theAttribute->attributeType();
 440
 441   return anAttrType == ModelAPI_AttributeSelectionList::typeId() ||
 442          anAttrType == ModelAPI_AttributeRefList::typeId() ||
 443          anAttrType == ModelAPI_AttributeRefAttr::typeId() ||
 444          anAttrType == ModelAPI_AttributeSelection::typeId() ||
 445          anAttrType == ModelAPI_AttributeReference::typeId();
 446 }
 447
 448 void PartSet_OperationPrs::fillShapeList(
 449                             const QMap<ObjectPtr, QList<GeomShapePtr> >& theFeatureShapes,
 450                             ModuleBase_IWorkshop* theWorkshop,
 451                             NCollection_DataMap<TopoDS_Shape,
 452                             Handle(AIS_InteractiveObject)>& theShapeToPrsMap)
 453 {
 454   theShapeToPrsMap.Clear();
 455
 456   XGUI_Displayer* aDisplayer = XGUI_Tools::workshop(theWorkshop)->displayer();
 457
 458   // create presentations on the base of the shapes
 459   QMap<ObjectPtr, QList<GeomShapePtr> >::const_iterator anIt = theFeatureShapes.begin(),
 460                                                         aLast = theFeatureShapes.end();
 461   for (; anIt != aLast; anIt++) {
 462     ObjectPtr anObject = anIt.key();
 463     QList<GeomShapePtr> aShapes = anIt.value();
 464     QList<GeomShapePtr>::const_iterator aShIt = aShapes.begin(), aShLast = aShapes.end();
 465     for (; aShIt != aShLast; aShIt++) {
 466       GeomShapePtr aGeomShape = *aShIt;
 467       // the shape should not be checked here on empty value because it should be checked in
 468       // appendShapeIfVisible() on the step of filling theFeatureShapes list
 469       // the reason is to avoid empty AIS object visualized in the viewer
 470       //if (!aGeomShape.get()) continue;
 471       TopoDS_Shape aShape = aGeomShape.get() ? aGeomShape->impl<TopoDS_Shape>() : TopoDS_Shape();
 472       if (aShape.IsNull())
 473         continue;
 474
 475       // change deviation coefficient to provide more precise circle
 476       Handle(AIS_InteractiveObject) anIO;
 477       AISObjectPtr anAISPtr = aDisplayer->getAISObject(anObject);
 478       if (anAISPtr.get())
 479         anIO = anAISPtr->impl<Handle(AIS_InteractiveObject)>();
 480       theShapeToPrsMap.Bind(aShape, anIO);
 481     }
 482   }
 483 }