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       break;
 100     case ModuleBase_IModule::CustomizeHighlightedObjects:
 101       PartSet_OperationPrs::getHighlightedShapes(myWorkshop, aFeatureShapes);
 102       break;
 103     default:
 104       return isModified;
 105   }
 106   NCollection_DataMap<TopoDS_Shape, Handle_AIS_InteractiveObject>& aShapeMap =
 107                                                                  anOperationPrs->shapesMap();
 108   PartSet_OperationPrs::fillShapeList(aFeatureShapes, myWorkshop, aShapeMap);
 109
 110   myPresentationIsEmpty = false;
 111   // redisplay AIS objects
 112   bool aRedisplayed = false;
 113   Handle(AIS_InteractiveContext) aContext = myWorkshop->viewer()->AISContext();
 114   if (!aContext.IsNull() && !aContext->IsDisplayed(anOperationPrs)) {
 115     // when the feature can not be visualized in the module, the operation preview should not
 116     // be visualized also
 117     if (anOperationPrs->hasShapes() && myWorkshop->module()->canDisplayObject(myFeature)) {
 118       // set color here because it can be changed in preferences
 119       Quantity_Color aShapeColor = getShapeColor(theFlag);
 120       anOperationPrs->setShapeColor(aShapeColor);
 121
 122       PartSet_Module* aModule = dynamic_cast<PartSet_Module*>(myWorkshop->module());
 123       XGUI_Workshop* aWorkshop = workshop();
 124       aRedisplayed = aWorkshop->displayer()->displayAIS(myPresentations[theFlag],
 125                                          false/*load object in selection*/, false);
 126       aContext->SetZLayer(anOperationPrs, aModule->getVisualLayerId());
 127       isModified = true;
 128     }
 129   }
 130   else {
 131     // when the feature can not be visualized in the module, the operation preview should not
 132     // be visualized also
 133     if (!anOperationPrs->hasShapes() || !myWorkshop->module()->canDisplayObject(myFeature)) {
 134       aRedisplayed = erasePresentation(theFlag, false);
 135       isModified = true;
 136     }
 137     else {
 138       anOperationPrs->Redisplay();
 139       isModified = true;
 140       aRedisplayed = true;
 141     }
 142   }
 143   if (myPresentationIsEmpty) {
 144     aRedisplayed = erasePresentation(theFlag, false);
 145   }
 146   if (aRedisplayed && theUpdateViewer)
 147     workshop()->displayer()->updateViewer();
 148
 149   return isModified;
 150 }
 151
 152 bool PartSet_CustomPrs::erasePresentation(
 153                           const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 154                           const bool theUpdateViewer)
 155 {
 156   bool isErased = false;
 157   XGUI_Workshop* aWorkshop = workshop();
 158   if (myPresentations.contains(theFlag))
 159     isErased = aWorkshop->displayer()->eraseAIS(myPresentations[theFlag], theUpdateViewer);
 160   return isErased;
 161 }
 162
 163 void PartSet_CustomPrs::clearPresentation(
 164   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
 165 {
 166   AISObjectPtr aPresentation = getPresentation(theFlag, false);
 167   if (aPresentation.get()) {
 168     Handle(AIS_InteractiveObject) anAISIO = aPresentation->impl<Handle(AIS_InteractiveObject)>();
 169     Handle(PartSet_OperationPrs) anOperationPrs = Handle(PartSet_OperationPrs)::DownCast(anAISIO);
 170
 171     anOperationPrs->shapesMap().Clear();
 172     if (!anOperationPrs.IsNull())
 173       anOperationPrs.Nullify();
 174     myPresentations.remove(theFlag);
 175   }
 176 }
 177
 178 AISObjectPtr PartSet_CustomPrs::getPresentation(
 179                                        const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 180                                        const bool theToCreate)
 181 {
 182   Handle(PartSet_OperationPrs) aPresentation;
 183
 184   AISObjectPtr anOperationPrs;
 185   if (myPresentations.contains(theFlag))
 186     anOperationPrs = myPresentations[theFlag];
 187
 188   if (!anOperationPrs.get() && theToCreate) {
 189     initPresentation(theFlag);
 190     anOperationPrs = myPresentations[theFlag];
 191   }
 192
 193   return anOperationPrs;
 194 }
 195
 196 bool PartSet_CustomPrs::redisplay(const ObjectPtr& theObject,
 197                                   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag,
 198                                   const bool theUpdateViewer)
 199 {
 200 #ifdef DO_NOT_VISUALIZE_CUSTOM_PRESENTATION
 201   return false;
 202 #endif
 203   bool aRedisplayed = false;
 204   if (myIsActive[theFlag])
 205     aRedisplayed = displayPresentation(theFlag, theUpdateViewer);
 206
 207   return aRedisplayed;
 208 }
 209
 210 void PartSet_CustomPrs::clearPrs()
 211 {
 212   clearPresentation(ModuleBase_IModule::CustomizeArguments);
 213   clearPresentation(ModuleBase_IModule::CustomizeResults);
 214   clearPresentation(ModuleBase_IModule::CustomizeHighlightedObjects);
 215 }
 216
 217 void PartSet_CustomPrs::processEvent(const std::shared_ptr<Events_Message>& theMessage)
 218 {
 219   if (theMessage->eventID() == Events_Loop::eventByName(EVENT_EMPTY_OPERATION_PRESENTATION))
 220     myPresentationIsEmpty = true; /// store state to analize it after display/erase is finished
 221 }
 222
 223 void PartSet_CustomPrs::initPresentation(
 224   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
 225 {
 226   AISObjectPtr anOperationPrs = AISObjectPtr(new GeomAPI_AISObject());
 227   Handle(PartSet_OperationPrs) anAISPrs = new PartSet_OperationPrs(myWorkshop);
 228   anOperationPrs->setImpl(new Handle(AIS_InteractiveObject)(anAISPrs));
 229   if (theFlag == ModuleBase_IModule::CustomizeArguments ||
 230       theFlag == ModuleBase_IModule::CustomizeResults) {
 231     anOperationPrs->setPointMarker(5, 2.);
 232     anOperationPrs->setWidth(1);
 233   }
 234   else if (theFlag == ModuleBase_IModule::CustomizeHighlightedObjects)
 235     anAISPrs->useAISWidth();
 236
 237   if (anOperationPrs.get())
 238     myPresentations[theFlag] = anOperationPrs;
 239 }
 240
 241 Quantity_Color PartSet_CustomPrs::getShapeColor(
 242                                   const ModuleBase_IModule::ModuleBase_CustomizeFlag& theFlag)
 243 {
 244   Quantity_Color aColor;
 245   switch(theFlag) {
 246     case ModuleBase_IModule::CustomizeArguments:
 247       aColor = ModuleBase_Tools::color("Visualization", "operation_parameter_color",
 248                                        OPERATION_PARAMETER_COLOR());
 249     break;
 250     case ModuleBase_IModule::CustomizeResults:
 251       aColor = ModuleBase_Tools::color("Visualization", "operation_result_color",
 252                                        OPERATION_RESULT_COLOR());
 253     break;
 254     case ModuleBase_IModule::CustomizeHighlightedObjects:
 255       aColor = ModuleBase_Tools::color("Visualization", "operation_highlight_color",
 256                                        OPERATION_HIGHLIGHT_COLOR());
 257     break;
 258     default:
 259     break;
 260   }
 261   return aColor;
 262 }
 263
 264 XGUI_Workshop* PartSet_CustomPrs::workshop() const
 265 {
 266   XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
 267   return aConnector->workshop();
 268 }