src/ModelAPI/ModelAPI_Feature.cpp

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include "ModelAPI_Feature.h"
  22 #include <ModelAPI_Events.h>
  23 #include <ModelAPI_Result.h>
  24 #include <ModelAPI_Data.h>
  25 #include <ModelAPI_Document.h>
  26 #include <ModelAPI_Session.h>
  27 #include <Events_Loop.h>
  28 #include <Config_Translator.h>
  29
  30 void ModelAPI_Feature::setError(const std::string& theError,
  31                                 bool isSend,
  32                                 bool isTranslate)
  33 {
  34   std::string anError = isTranslate ? Config_Translator::translate(getKind(), theError)
  35                                     : theError;
  36   data()->setError(anError, isSend);
  37 }
  38
  39 const std::list<std::shared_ptr<ModelAPI_Result> >& ModelAPI_Feature::results()
  40 {
  41   return myResults;
  42 }
  43
  44 std::shared_ptr<ModelAPI_Result> ModelAPI_Feature::firstResult() const
  45 {
  46   return myResults.empty() ? std::shared_ptr<ModelAPI_Result>() : *(myResults.begin());
  47 }
  48
  49 std::shared_ptr<ModelAPI_Result> ModelAPI_Feature::lastResult()
  50 {
  51   return myResults.empty() ? std::shared_ptr<ModelAPI_Result>() : *(myResults.rbegin());
  52 }
  53
  54 void ModelAPI_Feature::setResult(const std::shared_ptr<ModelAPI_Result>& theResult)
  55 {
  56   static Events_ID EVENT_UPD = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
  57   static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
  58
  59   if (firstResult() == theResult) {
  60     // nothing to change
  61   } else if (!myResults.empty()) {  // all except first become disabled
  62     std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  63     *aResIter = theResult;
  64     aECreator->sendUpdated(theResult, EVENT_UPD);
  65     for(aResIter++; aResIter != myResults.end(); aResIter++) {
  66       (*aResIter)->setDisabled((*aResIter), true);
  67     }
  68   } else {
  69     myResults.push_back(theResult);
  70   }
  71   // in any case result becomes enabled
  72   if (!isDisabled()) // disabled feature may be executed when it is added as not enabled (#2078)
  73     theResult->setDisabled(theResult, false);
  74 }
  75
  76 void ModelAPI_Feature::setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
  77                                  const int theIndex)
  78 {
  79   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  80   for (int anIndex = 0; anIndex < theIndex; anIndex++) {
  81     aResIter++;
  82   }
  83   if (aResIter == myResults.end()) {  // append
  84     myResults.push_back(theResult);
  85   } else {  // update
  86     *aResIter = theResult;
  87   }
  88   theResult->setDisabled(theResult, false);
  89 }
  90
  91 void ModelAPI_Feature::eraseResultFromList(const std::shared_ptr<ModelAPI_Result>& theResult)
  92 {
  93   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
  94   for(; aResIter != myResults.end(); aResIter++) {
  95     ResultPtr aRes = *aResIter;
  96     if (aRes == theResult) {
  97       std::string aGroup = aRes->groupName();
  98       aRes->setDisabled(aRes, true); // for complex results to disable all subs
  99       aRes->data()->erase();
 100       myResults.erase(aResIter);
 101
 102       static Events_Loop* aLoop = Events_Loop::loop();
 103       static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 104       static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
 105       aECreator->sendDeleted(document(), aGroup);
 106       aECreator->sendUpdated(aRes, EVENT_DISP);
 107       break;
 108     }
 109   }
 110 }
 111
 112 void ModelAPI_Feature::removeResults(
 113   const int theSinceIndex, const bool theForever, const bool theFlush)
 114 {
 115   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
 116   for(int anIndex = 0; anIndex < theSinceIndex && aResIter != myResults.end(); anIndex++)
 117     aResIter++;
 118
 119   std::string aGroup;
 120   std::list<std::shared_ptr<ModelAPI_Result> >::iterator aNextIter = aResIter;
 121   while( aNextIter != myResults.end()) {
 122     aGroup = (*aNextIter)->groupName();
 123     // remove previously erased results: to enable later if needed only actual (of history change)
 124     (*aNextIter)->setDisabled(*aNextIter, true); // just disable results
 125     if (theForever) {
 126       aNextIter = myResults.erase(aNextIter);
 127     } else {
 128       aNextIter++;
 129     }
 130   }
 131   if (!aGroup.empty() && theFlush) {
 132     // flush visualization changes
 133     static Events_Loop* aLoop = Events_Loop::loop();
 134     static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 135     aLoop->flush(aRedispEvent);
 136     static Events_ID aDelEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
 137     aLoop->flush(aDelEvent);
 138   }
 139 }
 140
 141 void ModelAPI_Feature::eraseResults(const bool theForever)
 142 {
 143   removeResults(0, theForever, true);
 144 }
 145
 146 const std::string& ModelAPI_Feature::documentToAdd()
 147 {
 148   // empty to use the current document
 149   static const std::string anEmpty;
 150   return anEmpty;
 151 }
 152
 153 void ModelAPI_Feature::erase()
 154 {
 155   // if this is the current feature, make the upper feature as current before removing
 156   if (document().get() && document()->currentFeature(false).get() == this) {
 157     document()->setCurrentFeatureUp();
 158   }
 159
 160   static Events_Loop* aLoop = Events_Loop::loop();
 161   static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 162   static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
 163
 164   while (!myResults.empty()) {  // remove one by one with messages
 165     std::shared_ptr<ModelAPI_Result> aRes = *(myResults.begin());
 166     aRes->setDisabled(aRes, true); // to avoid activation of the Part result
 167     if (!myResults.empty()) {// disabling result may erase the list (on undo of Part, issue 665)
 168       myResults.erase(myResults.begin());
 169       aRes->erase();
 170     }
 171   }
 172   ModelAPI_Object::erase();
 173 }
 174
 175 ModelAPI_Feature::~ModelAPI_Feature()
 176 {
 177   if (data() && data()->isValid())
 178     erase();
 179 }
 180
 181 FeaturePtr ModelAPI_Feature::feature(ObjectPtr theObject)
 182 {
 183   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 184   if (!aFeature) {
 185     ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 186     if (aResult) {
 187       DocumentPtr aDoc = aResult->document();
 188       return aDoc->feature(aResult);
 189     }
 190   }
 191   return aFeature;
 192 }
 193
 194 bool ModelAPI_Feature::isMacro() const
 195 {
 196   return false;
 197 }
 198
 199 bool ModelAPI_Feature::setDisabled(const bool theFlag)
 200 {
 201   if (myIsDisabled != theFlag) {
 202     myIsDisabled = theFlag;
 203     if (myIsDisabled) {
 204       removeResults(0, false, false); // flush will be in setCurrentFeature
 205     } else {
 206       // enable all disabled previously results
 207       std::list<std::shared_ptr<ModelAPI_Result> >::iterator aResIter = myResults.begin();
 208       for(; aResIter != myResults.end(); aResIter++) {
 209         (*aResIter)->setDisabled(*aResIter, false);
 210       }
 211       // update selection for the case something was updated higher in the history
 212       // while this feature was disabled
 213       static Events_Loop* aLoop = Events_Loop::loop();
 214       static Events_ID kUpdatedSel = aLoop->eventByName(EVENT_UPDATE_SELECTION);
 215       static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
 216       aECreator->sendUpdated(data()->owner(), kUpdatedSel, false);
 217     }
 218     return true;
 219   }
 220   return false;
 221 }
 222
 223 bool ModelAPI_Feature::isDisabled()
 224 {
 225   return myIsDisabled;
 226 }
 227
 228 // LCOV_EXCL_START
 229 bool ModelAPI_Feature::setStable(const bool theFlag)
 230 {
 231   if (myIsStable != theFlag) {
 232     myIsStable = theFlag;
 233     // send an event about the stability change (editing is started/finished)
 234     static Events_Loop* aLoop = Events_Loop::loop();
 235     static Events_ID EVENT_STAB = aLoop->eventByName(EVENT_STABILITY_CHANGED);
 236     std::shared_ptr<Events_Message> aMessage(new Events_Message(EVENT_STAB, this));
 237     aLoop->send(aMessage, false);
 238     return true;
 239   }
 240   return false;
 241 }
 242 // LCOV_EXCL_STOP
 243
 244 bool ModelAPI_Feature::isStable()
 245 {
 246   return myIsStable;
 247 }
 248
 249 bool ModelAPI_Feature::customAction(const std::string& theActionId)
 250 {
 251   return false;
 252 }
 253
 254 bool ModelAPI_Feature::isPreviewNeeded() const
 255 {
 256   return true;
 257 }
 258
 259 void ModelAPI_Feature::init()
 260 {
 261   myIsDisabled = false;
 262   myIsStable = true;
 263 }