src/Model/Model_ResultBody.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 <Model_ResultBody.h>
  22
  23 #include <Model_Document.h>
  24 #include <Model_Objects.h>
  25 #include <Model_BodyBuilder.h>
  26 #include <Model_Document.h>
  27 #include <ModelAPI_Object.h>
  28 #include <ModelAPI_Events.h>
  29 #include <ModelAPI_Tools.h>
  30 #include <Model_Data.h>
  31 #include <Events_Loop.h>
  32
  33 #include <TopoDS_Shape.hxx>
  34 #include <TopExp_Explorer.hxx>
  35 #include <TDataStd_UAttribute.hxx>
  36
  37 // if this attribute exists, the shape is connected topology
  38 Standard_GUID kIsConnectedTopology("e51392e0-3a4d-405d-8e36-bbfe19858ef5");
  39 // if this attribute exists, the connected topology flag must be recomputed
  40 Standard_GUID kUpdateConnectedTopology("01ef7a45-0bec-4266-b0b4-4aa570921818");
  41
  42 Model_ResultBody::Model_ResultBody() : ModelAPI_ResultBody()
  43 {
  44   myBuilder = new Model_BodyBuilder(this);
  45   myLastConcealed = false;
  46   updateSubs(shape()); // in case of open, etc.
  47 }
  48
  49 Model_ResultBody::~Model_ResultBody()
  50 {
  51   updateSubs(std::shared_ptr<GeomAPI_Shape>()); // erase sub-results
  52   delete myBuilder;
  53 }
  54
  55 void Model_ResultBody::loadAndOrientModifiedShapes(GeomAlgoAPI_MakeShape* theMS,
  56     std::shared_ptr<GeomAPI_Shape> theShapeIn, const int  theKindOfShape, const int  theTag,
  57     const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes,
  58     const bool theIsStoreSeparate,
  59     const bool theIsStoreAsGenerated,
  60     const bool theSplitInSubs)
  61 {
  62   if (theSplitInSubs && mySubs.size()) { // consists of subs
  63     // optimization of getting of new shapes for specific sub-result
  64     if (!theMS->newShapesCollected(theShapeIn, theKindOfShape))
  65       theMS->collectNewShapes(theShapeIn, theKindOfShape);
  66     std::vector<ResultBodyPtr>::const_iterator aSubIter = mySubs.cbegin();
  67     for(; aSubIter != mySubs.cend(); aSubIter++) {
  68       // check that sub-shape was also created as modification of ShapeIn
  69       /* to find when it is needed later to enable: to store modification of sub-bodies not only as primitives
  70       GeomShapePtr aSubGeomShape = (*aSubIter)->shape();
  71       if (!theIsStoreAsGenerated && aSubGeomShape.get() && !aSubGeomShape->isNull()) {
  72         TopoDS_Shape aSubShape = aSubGeomShape->impl<TopoDS_Shape>();
  73         TopoDS_Shape aWholeIn = theShapeIn->impl<TopoDS_Shape>();
  74         for(TopExp_Explorer anExp(aWholeIn, aSubShape.ShapeType()); anExp.More(); anExp.Next()) {
  75           ListOfShape aHistory;
  76           std::shared_ptr<GeomAPI_Shape> aSubIn(new GeomAPI_Shape());
  77           aSubIn->setImpl((new TopoDS_Shape(anExp.Current())));
  78           theMS->modified(aSubIn, aHistory);
  79           std::list<std::shared_ptr<GeomAPI_Shape> >::const_iterator anIt = aHistory.begin();
  80           for (; anIt != aHistory.end(); anIt++) {
  81             if ((*anIt)->isSame(aSubGeomShape)) {
  82               (*aSubIter)->storeModified(aSubIn, aSubGeomShape, -2); // -2 is to avoid clearing
  83             }
  84           }
  85         }
  86       }*/
  87       (*aSubIter)->loadAndOrientModifiedShapes(
  88         theMS, theShapeIn, theKindOfShape, theTag, theName, theSubShapes, theIsStoreSeparate,
  89         theIsStoreAsGenerated, theSplitInSubs);
  90     }
  91   } else { // do for this directly
  92     myBuilder->loadAndOrientModifiedShapes(
  93       theMS, theShapeIn, theKindOfShape, theTag, theName, theSubShapes, theIsStoreSeparate,
  94         theIsStoreAsGenerated);
  95   }
  96 }
  97
  98 int Model_ResultBody::numberOfSubs(bool forTree) const
  99 {
 100   return int(mySubs.size());
 101 }
 102
 103 ResultBodyPtr Model_ResultBody::subResult(const int theIndex, bool forTree) const
 104 {
 105   if (theIndex >= int(mySubs.size()))
 106     return ResultBodyPtr();
 107   return mySubs.at(theIndex);
 108 }
 109
 110 bool Model_ResultBody::isSub(ObjectPtr theObject, int& theIndex) const
 111 {
 112   std::map<ObjectPtr, int>::const_iterator aFound = mySubsMap.find(theObject);
 113   if (aFound != mySubsMap.end()) {
 114     theIndex = aFound->second;
 115     return true;
 116   }
 117   return false;
 118 }
 119
 120 void Model_ResultBody::colorConfigInfo(std::string& theSection, std::string& theName,
 121   std::string& theDefault)
 122 {
 123   theSection = "Visualization";
 124   theName = "result_body_color";
 125   theDefault = DEFAULT_COLOR();
 126 }
 127
 128 bool Model_ResultBody::setDisabled(std::shared_ptr<ModelAPI_Result> theThis, const bool theFlag)
 129 {
 130   bool aChanged = ModelAPI_ResultBody::setDisabled(theThis, theFlag);
 131   if (aChanged) { // state is changed, so modifications are needed
 132     myBuilder->evolutionToSelection(theFlag);
 133     updateSubs(shape(), false); // to set disabled/enabled
 134   }
 135   return aChanged;
 136 }
 137
 138 bool Model_ResultBody::isConcealed()
 139 {
 140   return myLastConcealed;
 141 }
 142
 143 void Model_ResultBody::setIsConcealed(const bool theValue)
 144 {
 145   if (ModelAPI_ResultBody::isConcealed() != theValue) {
 146     ModelAPI_ResultBody::setIsConcealed(theValue);
 147     updateConcealment();
 148   }
 149 }
 150
 151 // recursively check all subs for concealment flag, returns true if everybody have "flag" state,
 152 // in theAll returns results with "flag" state
 153 static bool checkAllSubs(ResultBodyPtr theParent, bool theFlag, std::list<ResultBodyPtr>& theAll)
 154 {
 155   if (theParent->isConcealed() != theFlag)
 156     theAll.push_back(theParent);
 157   bool aResult = theParent->ModelAPI_ResultBody::isConcealed() == theFlag;
 158   for(int a = 0; a < theParent->numberOfSubs(); a++) {
 159     bool aSubRes = checkAllSubs(theParent->subResult(a), theFlag, theAll);
 160     if (theFlag)
 161       aResult = aResult || aSubRes; // concealed: one makes concealed everyone
 162     else
 163       aResult = aResult && aSubRes; // not concealed: all must be not concealed
 164   }
 165   return aResult;
 166 }
 167
 168 void Model_ResultBody::updateConcealment()
 169 {
 170   if (myLastConcealed != ModelAPI_ResultBody::isConcealed()) {
 171     // check the whole tree of results: if one is concealed, everybody are concealed
 172     ResultBodyPtr anOwner = std::dynamic_pointer_cast<ModelAPI_ResultBody>(data()->owner());
 173     if (!anOwner.get())
 174       return; // "this" is invalid
 175     ResultBodyPtr aParent = ModelAPI_Tools::bodyOwner(anOwner);
 176     while(aParent.get()) {
 177       anOwner = aParent;
 178       aParent = ModelAPI_Tools::bodyOwner(anOwner);
 179     }
 180     // iterate all results and collect all results whose state may be updated
 181     std::list<ResultBodyPtr> anUpdated;
 182     bool aNewFlag = !myLastConcealed;
 183     if (checkAllSubs(anOwner, aNewFlag, anUpdated)) { // state of everyone must be updated
 184       std::list<ResultBodyPtr>::iterator aRes = anUpdated.begin();
 185       for(; aRes != anUpdated.end(); aRes++) {
 186         bool aLastConcealed = (*aRes)->isConcealed();
 187         if (aNewFlag != aLastConcealed) {
 188           std::dynamic_pointer_cast<Model_ResultBody>(*aRes)->myLastConcealed = aNewFlag;
 189           if (aNewFlag) { // become concealed, behaves like removed
 190             ModelAPI_EventCreator::get()->sendDeleted(document(), groupName());
 191           } else { // become not-concealed, behaves like created
 192             static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
 193             ModelAPI_EventCreator::get()->sendUpdated(*aRes, anEvent);
 194           }
 195           static Events_ID EVENT_DISP = // must be redisplayed in any case
 196             Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 197           ModelAPI_EventCreator::get()->sendUpdated(*aRes, EVENT_DISP);
 198         }
 199       }
 200     }
 201   }
 202 }
 203
 204 void Model_ResultBody::updateSubs(const std::shared_ptr<GeomAPI_Shape>& theThisShape,
 205                                   const bool theShapeChanged)
 206 {
 207   static Events_Loop* aLoop = Events_Loop::loop();
 208   static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 209   static Events_ID EVENT_UPD = aLoop->eventByName(EVENT_OBJECT_UPDATED);
 210   static const ModelAPI_EventCreator* aECreator = ModelAPI_EventCreator::get();
 211   // erase flag that topology is connected: the shape is new
 212   if (theShapeChanged && data().get()) {
 213     TDF_Label aDataLab = std::dynamic_pointer_cast<Model_Data>(data())->label();
 214     if (!aDataLab.IsNull()) {
 215       TDataStd_UAttribute::Set(aDataLab, kUpdateConnectedTopology);
 216     }
 217   }
 218   // iterate all sub-solids of compsolid to make sub-results synchronized with them
 219   TopoDS_Shape aThisShape;
 220   if (theThisShape.get()) aThisShape = theThisShape->impl<TopoDS_Shape>();
 221   if (!aThisShape.IsNull() && (aThisShape.ShapeType() == TopAbs_COMPSOLID ||
 222        aThisShape.ShapeType() == TopAbs_COMPOUND)) {
 223     bool aWasEmpty = mySubs.empty();
 224     Model_Objects* anObjects = std::dynamic_pointer_cast<Model_Document>(document())->objects();
 225     unsigned int aSubIndex = 0;
 226     TopoDS_Iterator aShapesIter(aThisShape);
 227     for(; aShapesIter.More(); aShapesIter.Next(), aSubIndex++) {
 228       std::shared_ptr<GeomAPI_Shape> aShape(new GeomAPI_Shape);
 229       aShape->setImpl(new TopoDS_Shape(aShapesIter.Value()));
 230       ResultBodyPtr aSub;
 231       if (mySubs.size() <= aSubIndex) { // it is needed to create a new sub-result
 232         aSub = anObjects->createBody(this->data(), aSubIndex);
 233         mySubs.push_back(aSub);
 234         mySubsMap[aSub] = int(mySubs.size() - 1);
 235         if (isConcealed()) { // for issue #2579 note7
 236           aSub->ModelAPI_ResultBody::setIsConcealed(true);
 237           std::dynamic_pointer_cast<Model_ResultBody>(aSub)->updateConcealment();
 238         }
 239       } else { // just update shape of this result
 240         aSub = mySubs[aSubIndex];
 241       }
 242       if (!aShape->isEqual(aSub->shape())) {
 243         aSub->store(aShape, false);
 244         aECreator->sendUpdated(aSub, EVENT_DISP);
 245         aECreator->sendUpdated(aSub, EVENT_UPD);
 246       }
 247       aSub->setDisabled(aSub, isDisabled());
 248     }
 249     // erase left, unused results
 250     while(mySubs.size() > aSubIndex) {
 251       ResultBodyPtr anErased = *(mySubs.rbegin());
 252       if (anErased->ModelAPI_ResultBody::isConcealed()) {
 253         anErased->ModelAPI_ResultBody::setIsConcealed(false);
 254         std::dynamic_pointer_cast<Model_ResultBody>(anErased)->updateConcealment();
 255       }
 256       anErased->setDisabled(anErased, true);
 257       mySubsMap.erase(anErased);
 258       mySubs.pop_back();
 259     }
 260     if (aWasEmpty) { // erase all subs
 261       // redisplay this because result with and without subs are displayed differently
 262       aECreator->sendUpdated(data()->owner(), EVENT_DISP);
 263     }
 264   } else if (!mySubs.empty()) { // erase all subs
 265     while(!mySubs.empty()) {
 266       ResultBodyPtr anErased = *(mySubs.rbegin());
 267       if (anErased->ModelAPI_ResultBody::isConcealed()) {
 268         anErased->ModelAPI_ResultBody::setIsConcealed(false);
 269         std::dynamic_pointer_cast<Model_ResultBody>(anErased)->updateConcealment();
 270       }
 271       anErased->setDisabled(anErased, true); // even if it is invalid (to erase subs on abort/undo)
 272       mySubs.pop_back();
 273     }
 274     mySubsMap.clear();
 275     // redisplay this because result with and without subs are displayed differently
 276     aECreator->sendUpdated(data()->owner(), EVENT_DISP);
 277   }
 278 }
 279
 280 bool Model_ResultBody::isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape)
 281 {
 282   if (myBuilder->isLatestEqual(theShape))
 283     return true;
 284   // also check that it is asked for sub-elements
 285   std::vector<ResultBodyPtr>::const_iterator aSubIter = mySubs.cbegin();
 286   for(; aSubIter != mySubs.cend(); aSubIter++) {
 287     if (aSubIter->get() && (*aSubIter)->isLatestEqual(theShape)) {
 288       return true;
 289     }
 290   }
 291   return false;
 292 }
 293
 294 bool Model_ResultBody::isConnectedTopology()
 295 {
 296   TDF_Label aDataLab = std::dynamic_pointer_cast<Model_Data>(data())->label();
 297   if (!aDataLab.IsNull()) {
 298     if (aDataLab.IsAttribute(kUpdateConnectedTopology)) { // recompute state
 299       aDataLab.ForgetAttribute(kUpdateConnectedTopology);
 300       GeomShapePtr aShape = shape();
 301       if (aShape.get() && aShape->isConnectedTopology()) {
 302         TDataStd_UAttribute::Set(aDataLab, kIsConnectedTopology);
 303       } else {
 304         aDataLab.ForgetAttribute(kIsConnectedTopology);
 305       }
 306     }
 307     return aDataLab.IsAttribute(kIsConnectedTopology);
 308   }
 309   return false; // invalid case
 310 }