src/ModelAPI/ModelAPI_Feature.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Feature.cpp
   4 // Created:     17 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #include "ModelAPI_Feature.h"
   8 #include <ModelAPI_Events.h>
   9 #include <ModelAPI_Result.h>
  10 #include <ModelAPI_Data.h>
  11 #include <ModelAPI_Document.h>
  12 #include <ModelAPI_Session.h>
  13 #include <Events_Loop.h>
  14
  15 const std::list<std::shared_ptr<ModelAPI_Result> >& ModelAPI_Feature::results()
  16 {
  17   return myResults;
  18 }
  19
  20 std::shared_ptr<ModelAPI_Result> ModelAPI_Feature::firstResult()
  21 {
  22   return myResults.empty() ? std::shared_ptr<ModelAPI_Result>() : *(myResults.begin());
  23 }
  24
  25 std::shared_ptr<ModelAPI_Result> ModelAPI_Feature::lastResult()
  26 {
  27   return myResults.empty() ? std::shared_ptr<ModelAPI_Result>() : *(myResults.rbegin());
  28 }
  29
  30 void ModelAPI_Feature::setResult(const std::shared_ptr<ModelAPI_Result>& theResult)
  31 {
  32   static Events_ID EVENT_UPD = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
  33   static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
  34
  35   if (firstResult() == theResult) {
  36     // nothing to change
  37   } else if (!myResults.empty()) {  // all except first become disabled
  38     std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  39     *aResIter = theResult;
  40     aECreator->sendUpdated(theResult, EVENT_UPD);
  41     for(aResIter++; aResIter != myResults.end(); aResIter++) {
  42       (*aResIter)->setDisabled((*aResIter), true);
  43     }
  44   } else {
  45     myResults.push_back(theResult);
  46   }
  47   // in any case result becomes enabled
  48   theResult->setDisabled(theResult, false);
  49 }
  50
  51 void ModelAPI_Feature::setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
  52                                  const int theIndex)
  53 {
  54   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  55   for (int anIndex = 0; anIndex < theIndex; anIndex++) {
  56     aResIter++;
  57   }
  58   if (aResIter == myResults.end()) {  // append
  59     myResults.push_back(theResult);
  60   } else {  // update
  61     *aResIter = theResult;
  62   }
  63   theResult->setDisabled(theResult, false);
  64 }
  65
  66 void ModelAPI_Feature::removeResult(const std::shared_ptr<ModelAPI_Result>& theResult)
  67 {
  68   theResult->setDisabled(theResult, true);
  69   // flush visualisation changes
  70   static Events_Loop* aLoop = Events_Loop::loop();
  71   static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
  72   aLoop->flush(aRedispEvent);
  73 }
  74
  75 void ModelAPI_Feature::eraseResultFromList(const std::shared_ptr<ModelAPI_Result>& theResult)
  76 {
  77   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  78   for(; aResIter != myResults.end(); aResIter++) {
  79     ResultPtr aRes = *aResIter;
  80     if (aRes == theResult) {
  81       std::string aGroup = aRes->groupName();
  82       aRes->data()->erase();
  83       myResults.erase(aResIter);
  84
  85       static Events_Loop* aLoop = Events_Loop::loop();
  86       static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
  87       static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
  88       ModelAPI_EventCreator::get()->sendDeleted(document(), aGroup);
  89       aECreator->sendUpdated(aRes, EVENT_DISP);
  90       break;
  91     }
  92   }
  93 }
  94
  95 void ModelAPI_Feature::removeResults(const int theSinceIndex, const bool theFlush)
  96 {
  97   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  98   for(int anIndex = 0; anIndex < theSinceIndex && aResIter != myResults.end(); anIndex++)
  99     aResIter++;
 100
 101   std::string aGroup;
 102   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aNextIter = aResIter;
 103   while( aNextIter != myResults.end()) {
 104     aGroup = (*aNextIter)->groupName();
 105     // remove previously erased results: to enable later if needed only actual (of history change)
 106     if (theSinceIndex == 0 && (*aNextIter)->isDisabled()) {
 107       aNextIter = myResults.erase(aNextIter);
 108     } else {
 109       (*aNextIter)->setDisabled(*aNextIter, true); // just disable results
 110       aNextIter++;
 111     }
 112   }
 113   if (!aGroup.empty() && theFlush) {
 114     // flush visualisation changes
 115     static Events_Loop* aLoop = Events_Loop::loop();
 116     static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 117     aLoop->flush(aRedispEvent);
 118     static Events_ID aDelEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
 119     aLoop->flush(aDelEvent);
 120   }
 121 }
 122
 123 void ModelAPI_Feature::eraseResults()
 124 {
 125   removeResults(0);
 126 }
 127
 128 const std::string& ModelAPI_Feature::documentToAdd()
 129 {
 130   // empty to use the current document
 131   static const std::string anEmpty;
 132   return anEmpty;
 133 }
 134
 135 void ModelAPI_Feature::erase()
 136 {
 137   // if this is the current feature, make the upper feature as current before removing
 138   if (document().get() && document()->currentFeature(false).get() == this) {
 139     document()->setCurrentFeatureUp();
 140   }
 141
 142   static Events_Loop* aLoop = Events_Loop::loop();
 143   static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 144   static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
 145
 146   while (!myResults.empty()) {  // remove one by one with messages
 147     std::shared_ptr<ModelAPI_Result> aRes = *(myResults.begin());
 148     aRes->setDisabled(aRes, true); // to avoid activation of the Part result
 149     if (!myResults.empty()) // disabling result may erase the list (on undo of Part, issue 665)
 150       myResults.erase(myResults.begin());
 151   }
 152   ModelAPI_Object::erase();
 153 }
 154
 155 ModelAPI_Feature::~ModelAPI_Feature()
 156 {
 157   erase();
 158 }
 159
 160 FeaturePtr ModelAPI_Feature::feature(ObjectPtr theObject)
 161 {
 162   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 163   if (!aFeature) {
 164     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 165     if (aResult) {
 166       DocumentPtr aDoc = aResult->document();
 167       return aDoc->feature(aResult);
 168     }
 169   }
 170   return aFeature;
 171 }
 172
 173 bool ModelAPI_Feature::isMacro() const
 174 {
 175   return false;
 176 }
 177
 178 bool ModelAPI_Feature::setDisabled(const bool theFlag)
 179 {
 180   if (myIsDisabled != theFlag) {
 181     myIsDisabled = theFlag;
 182     if (myIsDisabled) {
 183       removeResults(0, false); // flush will be in setCurrentFeature
 184     } else {
 185       // enable all disabled previously results
 186       std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
 187       for(; aResIter != myResults.end(); aResIter++) {
 188         (*aResIter)->setDisabled(*aResIter, false);
 189       }
 190     }
 191     return true;
 192   }
 193   return false;
 194 }
 195
 196 bool ModelAPI_Feature::isDisabled() const
 197 {
 198   return myIsDisabled;
 199 }
 200
 201 bool ModelAPI_Feature::isPreviewNeeded() const
 202 {
 203   return true;
 204 }