src/PartSet/PartSet_CustomPrs.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        PartSet_CustomPrs.cpp
   4 // Created:     30 Jun 2015
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #include <PartSet_CustomPrs.h>
   8 #include <PartSet_Module.h>
   9 #include "PartSet_OperationPrs.h"
  10 #include "PartSet_OverconstraintListener.h"
  11
  12 #include <XGUI_ModuleConnector.h>
  13 #include <XGUI_Workshop.h>
  14 #include <XGUI_Displayer.h>
  15
  16 #include <ModuleBase_IWorkshop.h>
  17 #include <ModuleBase_IViewer.h>
  18 #include <ModuleBase_Tools.h>
  19
  20 #include <Config_PropManager.h>
  21 #include <Events_Loop.h>
  22 #include <ModelAPI_Events.h>
  23
  24 #include <AIS_InteractiveContext.hxx>
  25 #include <AIS_InteractiveObject.hxx>
  26 #include <Prs3d_PointAspect.hxx>
  27
  28 //#define DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
  29
  30 PartSet_CustomPrs::PartSet_CustomPrs(ModuleBase_IWorkshop* theWorkshop)
  31   : myWorkshop(theWorkshop), myFeature(FeaturePtr()), myPresentationIsEmpty(false)
  32 {
  33   Events_Loop* aLoop = Events_Loop::loop();
  34   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION));
  35
  36   initPresentation(ModuleBase_IModule::CustomizeArguments);
  37   initPresentation(ModuleBase_IModule::CustomizeResults);
  38   initPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
  39
  40   myIsActive[ModuleBase_IModule::CustomizeArguments] = false;
  41   myIsActive[ModuleBase_IModule::CustomizeResults] = false;
  42   myIsActive[ModuleBase_IModule::CustomizeHighlightedObjects] = false;
  43 }
  44
  45 bool PartSet_CustomPrs::isActive(const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
  46 {
  47   return myIsActive[theFlag];
  48 }
  49
  50 bool PartSet_CustomPrs::activate(const FeaturePtr& theFeature,
  51                                  const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
  52                                  const bool theUpdateViewer)
  53 {
  54 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
  55   return false;
  56 #endif
  57
  58   myIsActive[theFlag] = true;
  59   myFeature = theFeature;
  60
  61   bool isModified = false;
  62   if (theFeature.get()) {
  63     displayPresentation(theFlag, theUpdateViewer);
  64     isModified = true;
  65   }
  66   return isModified;
  67 }
  68
  69 bool PartSet_CustomPrs::deactivate(const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
  70                                    const bool theUpdateViewer)
  71 {
  72   myIsActive[theFlag] = false;
  73   erasePresentation(theFlag, theUpdateViewer);
  74   return true;
  75 }
  76
  77 bool PartSet_CustomPrs::displayPresentation(
  78                                   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
  79                                   const bool theUpdateViewer)
  80 {
  81   bool isModified = false;
  82
  83   // update the AIS objects content
  84   AISObjectPtr aPresentation = getPresentation(theFlag, true);
  85   Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
  86   Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
  87
  88   // do nothing if the feature can not be displayed [is moved from presentation, to be checked]
  89   if (!myFeature.get())
  90     return isModified;
  91
  92   QMap<ObjectPtr, QList<GeomShapePtr> > aFeatureShapes;
  93   switch (theFlag) {
  94     case ModuleBase_IModule::CustomizeArguments:
  95       PartSet_OperationPrs::getFeatureShapes(myFeature, myWorkshop, aFeatureShapes);
  96       break;
  97     case ModuleBase_IModule::CustomizeResults:
  98       PartSet_OperationPrs::getResultShapes(myFeature, myWorkshop, aFeatureShapes);
  99       PartSet_OperationPrs::getPresentationShapes(myFeature, myWorkshop, aFeatureShapes, false);
 100       break;
 101     case ModuleBase_IModule::CustomizeHighlightedObjects:
 102       PartSet_OperationPrs::getHighlightedShapes(myWorkshop, aFeatureShapes);
 103       break;
 104     default:
 105       return isModified;
 106   }
 107   NCollection_DataMap<TopoDS_Shape, Handle_AIS_InteractiveObject>& aShapeMap =
 108                                                                  anOperationPrs->shapesMap();
 109   PartSet_OperationPrs::fillShapeList(aFeatureShapes, myWorkshop, aShapeMap);
 110
 111   myPresentationIsEmpty = false;
 112   // redisplay AIS objects
 113   bool aRedisplayed = false;
 114   Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
 115   if (!aContext.IsNull() && !aContext->IsDisplayed(anOperationPrs)) {
 116     // when the feature can not be visualized in the module, the operation preview should not
 117     // be visualized also
 118     if (anOperationPrs->hasShapes() && myWorkshop->module()->canDisplayObject(myFeature)) {
 119       // set color here because it can be changed in preferences
 120       Quantity_Color aShapeColor = getShapeColor(theFlag);
 121       anOperationPrs->setShapeColor(aShapeColor);
 122
 123       PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
 124       XGUI_Workshop* aWorkshop = workshop();
 125       aRedisplayed = aWorkshop->displayer()->displayAIS(myPresentations[theFlag],
 126                                          false/*load object in selection*/, false);
 127       aContext->SetZLayer(anOperationPrs, aModule->getVisualLayerId());
 128       isModified = true;
 129     }
 130   }
 131   else {
 132     // when the feature can not be visualized in the module, the operation preview should not
 133     // be visualized also
 134     if (!anOperationPrs->hasShapes() || !myWorkshop->module()->canDisplayObject(myFeature)) {
 135       aRedisplayed = erasePresentation(theFlag, false);
 136       isModified = true;
 137     }
 138     else {
 139       anOperationPrs->Redisplay();
 140       isModified = true;
 141       aRedisplayed = true;
 142     }
 143   }
 144   if (myPresentationIsEmpty) {
 145     aRedisplayed = erasePresentation(theFlag, false);
 146   }
 147   if (aRedisplayed && theUpdateViewer)
 148     workshop()->displayer()->updateViewer();
 149
 150   return isModified;
 151 }
 152
 153 bool PartSet_CustomPrs::erasePresentation(
 154                           const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 155                           const bool theUpdateViewer)
 156 {
 157   bool isErased = false;
 158   XGUI_Workshop* aWorkshop = workshop();
 159   if (myPresentations.contains(theFlag))
 160     isErased = aWorkshop->displayer()->eraseAIS(myPresentations[theFlag], theUpdateViewer);
 161   return isErased;
 162 }
 163
 164 void PartSet_CustomPrs::clearPresentation(
 165   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
 166 {
 167   AISObjectPtr aPresentation = getPresentation(theFlag, false);
 168   if (aPresentation.get()) {
 169     Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
 170     Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
 171
 172     anOperationPrs->shapesMap().Clear();
 173     if (!anOperationPrs.IsNull())
 174       anOperationPrs.Nullify();
 175     myPresentations.remove(theFlag);
 176   }
 177 }
 178
 179 AISObjectPtr PartSet_CustomPrs::getPresentation(
 180                                        const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 181                                        const bool theToCreate)
 182 {
 183   Handle(PartSet_OperationPrs) aPresentation;
 184
 185   AISObjectPtr anOperationPrs;
 186   if (myPresentations.contains(theFlag))
 187     anOperationPrs = myPresentations[theFlag];
 188
 189   if (!anOperationPrs.get() && theToCreate) {
 190     initPresentation(theFlag);
 191     anOperationPrs = myPresentations[theFlag];
 192   }
 193
 194   return anOperationPrs;
 195 }
 196
 197 bool PartSet_CustomPrs::redisplay(const ObjectPtr& theObject,
 198                                   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 199                                   const bool theUpdateViewer)
 200 {
 201 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
 202   return false;
 203 #endif
 204   bool aRedisplayed = false;
 205   if (myIsActive[theFlag])
 206     aRedisplayed = displayPresentation(theFlag, theUpdateViewer);
 207
 208   return aRedisplayed;
 209 }
 210
 211 void PartSet_CustomPrs::clearPrs()
 212 {
 213   clearPresentation(ModuleBase_IModule::CustomizeArguments);
 214   clearPresentation(ModuleBase_IModule::CustomizeResults);
 215   clearPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
 216 }
 217
 218 void PartSet_CustomPrs::processEvent(const std::shared_ptr<Events_Message>& theMessage)
 219 {
 220   if (theMessage->eventID() == Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION))
 221     myPresentationIsEmpty = true; /// store state to analize it after display/erase is finished
 222 }
 223
 224 void PartSet_CustomPrs::initPresentation(
 225   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
 226 {
 227   AISObjectPtr anOperationPrs = AISObjectPtr(new GeomAPI_AISObject());
 228   Handle(PartSet_OperationPrs) anAISPrs = new PartSet_OperationPrs(myWorkshop);
 229   anOperationPrs->setImpl(new Handle(AIS_InteractiveObject)(anAISPrs));
 230   if (theFlag == ModuleBase_IModule::CustomizeArguments ||
 231       theFlag == ModuleBase_IModule::CustomizeResults) {
 232     anOperationPrs->setPointMarker(5, 2.);
 233     anOperationPrs->setWidth(1);
 234   }
 235   else if (theFlag == ModuleBase_IModule::CustomizeHighlightedObjects)
 236     anAISPrs->useAISWidth();
 237
 238   if (anOperationPrs.get())
 239     myPresentations[theFlag] = anOperationPrs;
 240 }
 241
 242 Quantity_Color PartSet_CustomPrs::getShapeColor(
 243                                   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
 244 {
 245   Quantity_Color aColor;
 246   switch(theFlag) {
 247     case ModuleBase_IModule::CustomizeArguments:
 248       aColor = ModuleBase_Tools::color("Visualization", "operation_parameter_color");
 249     break;
 250     case ModuleBase_IModule::CustomizeResults:
 251       aColor = ModuleBase_Tools::color("Visualization", "operation_result_color");
 252     break;
 253     case ModuleBase_IModule::CustomizeHighlightedObjects:
 254       aColor = ModuleBase_Tools::color("Visualization", "operation_highlight_color");
 255     break;
 256     default:
 257     break;
 258   }
 259   return aColor;
 260 }
 261
 262 XGUI_Workshop* PartSet_CustomPrs::workshop() const
 263 {
 264   XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
 265   return aConnector->workshop();
 266 }