src/ModelAPI/ModelAPI_Tools.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Tools.cpp
   4 // Created:     06 Aug 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #include "ModelAPI_Tools.h"
   8 #include <ModelAPI_Session.h>
   9 #include <ModelAPI_Document.h>
  10 #include <ModelAPI_Object.h>
  11 #include <ModelAPI_AttributeDouble.h>
  12 #include <ModelAPI_ResultParameter.h>
  13 #include <ModelAPI_ResultPart.h>
  14 #include <ModelAPI_AttributeDocRef.h>
  15 #include <list>
  16 #include <map>
  17
  18 namespace ModelAPI_Tools {
  19
  20 std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult)
  21 {
  22   return theResult->shape();
  23 }
  24
  25 const char* toString(ModelAPI_ExecState theExecState)
  26 {
  27 #define TO_STRING(__NAME__) case __NAME__: return #__NAME__;
  28   switch (theExecState) {
  29   TO_STRING(ModelAPI_StateDone)
  30   TO_STRING(ModelAPI_StateMustBeUpdated)
  31   TO_STRING(ModelAPI_StateExecFailed)
  32   TO_STRING(ModelAPI_StateInvalidArgument)
  33   TO_STRING(ModelAPI_StateNothing)
  34   default: return "Unknown ExecState.";
  35   }
  36 #undef TO_STRING
  37 }
  38
  39 std::string getFeatureError(const FeaturePtr& theFeature)
  40 {
  41   std::string anError;
  42   if (!theFeature.get() || !theFeature->data()->isValid() || theFeature->isAction())
  43     return anError;
  44
  45   // to be removed later, this error should be got from the feature
  46   if (theFeature->data()->execState() == ModelAPI_StateDone ||
  47       theFeature->data()->execState() == ModelAPI_StateMustBeUpdated)
  48     return anError;
  49
  50   // set error indication
  51   anError = theFeature->error();
  52   if (anError.empty()) {
  53     bool isDone = ( theFeature->data()->execState() == ModelAPI_StateDone
  54                  || theFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
  55     if (!isDone) {
  56       anError = toString(theFeature->data()->execState());
  57       // If the feature is Composite and error is StateInvalidArgument,
  58       // error text should include error of first invalid sub-feature. Otherwise
  59       // it is not clear what is the reason of the invalid argument.
  60       if (theFeature->data()->execState() == ModelAPI_StateInvalidArgument) {
  61         CompositeFeaturePtr aComposite =
  62                     std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
  63         if (aComposite) {
  64           for (int i = 0, aSize = aComposite->numberOfSubs(); i < aSize; i++) {
  65             FeaturePtr aSubFeature = aComposite->subFeature(i);
  66             std::string aSubFeatureError = getFeatureError(aSubFeature);
  67             if (!aSubFeatureError.empty()) {
  68               anError = anError + " in " + aSubFeature->getKind() + ".\n" + aSubFeatureError;
  69               break;
  70             }
  71           }
  72         }
  73       }
  74     }
  75   }
  76
  77   return anError;
  78 }
  79
  80 ObjectPtr objectByName(const DocumentPtr& theDocument, const std::string& theGroup, const std::string& theName)
  81 {
  82   for (int anIndex = 0; anIndex < theDocument->size(theGroup); ++anIndex) {
  83     ObjectPtr anObject = theDocument->object(theGroup, anIndex);
  84     if (anObject->data()->name() == theName)
  85       return anObject;
  86   }
  87   // not found
  88   return ObjectPtr();
  89 }
  90
  91 bool findVariable(const DocumentPtr& theDocument,
  92                   const std::string& theName, double& outValue, ResultParameterPtr& theParam)
  93 {
  94   ObjectPtr aParamObj = objectByName(theDocument, ModelAPI_ResultParameter::group(), theName);
  95   theParam = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(aParamObj);
  96   if (!theParam.get())
  97     return false;
  98   AttributeDoublePtr aValueAttribute = theParam->data()->real(ModelAPI_ResultParameter::VALUE());
  99   outValue = aValueAttribute->value();
 100   return true;
 101 }
 102
 103 bool findVariable(const std::string& theName, double& outValue, ResultParameterPtr& theParam,
 104                   const DocumentPtr& theDocument /*= DocumentPtr()*/)
 105 {
 106   SessionPtr aSession = ModelAPI_Session::get();
 107   std::list<DocumentPtr> aDocList;
 108   DocumentPtr aDocument = theDocument.get() ? theDocument : aSession->activeDocument();
 109   DocumentPtr aRootDocument = aSession->moduleDocument();
 110   aDocList.push_back(aDocument);
 111   if (aDocument != aRootDocument) {
 112     aDocList.push_back(aRootDocument);
 113   }
 114   for(std::list<DocumentPtr>::const_iterator it = aDocList.begin(); it != aDocList.end(); ++it) {
 115     if (findVariable(*it, theName, outValue, theParam))
 116       return true;
 117   }
 118   return false;
 119 }
 120
 121 static std::map<int, std::vector<int> > myColorMap;
 122
 123 void appendValues(std::vector<int>& theRGB, const int theRed, const int theGreen, const int theBlue)
 124 {
 125   theRGB.push_back(theRed);
 126   theRGB.push_back(theGreen);
 127   theRGB.push_back(theBlue);
 128 }
 129
 130 bool containsValues(std::map<int, std::vector<int> >& theColorMap, std::vector<int>& theValues)
 131 {
 132   std::map<int, std::vector<int> >::const_iterator anIt = theColorMap.begin(), aLast = theColorMap.end();
 133   bool isFound = false;
 134   for (; anIt != aLast && !isFound; anIt++) {
 135     std::vector<int> aValues = anIt->second;
 136     isFound = aValues[0] == theValues[0] &&
 137               aValues[1] == theValues[1] &&
 138               aValues[2] == theValues[2];
 139   }
 140   return isFound;
 141 }
 142
 143 std::vector<int> HSVtoRGB(int theH, int theS, int theV)
 144 {
 145   std::vector<int> aRGB;
 146   if (theH < 0 || theH > 360 ||
 147       theS < 0 || theS > 100 ||
 148       theV < 0 || theV > 100)
 149     return aRGB;
 150
 151   int aHi = (int)theH/60;
 152
 153   double aV = theV;
 154   double aVmin = (100 - theS)*theV/100;
 155
 156   double anA = (theV - aVmin)* (theH % 60) / 60;
 157
 158   double aVinc = aVmin + anA;
 159   double aVdec = theV - anA;
 160
 161   double aPercentToValue = 255./100;
 162   int aV_int    = (int)(aV*aPercentToValue);
 163   int aVinc_int = (int)(aVinc*aPercentToValue);
 164   int aVmin_int = (int)(aVmin*aPercentToValue);
 165   int aVdec_int = (int)(aVdec*aPercentToValue);
 166
 167   switch(aHi) {
 168     case 0: appendValues(aRGB, aV_int,    aVinc_int, aVmin_int); break;
 169     case 1: appendValues(aRGB, aVdec_int, aV_int,    aVmin_int); break;
 170     case 2: appendValues(aRGB, aVmin_int, aV_int,    aVinc_int); break;
 171     case 3: appendValues(aRGB, aVmin_int, aVdec_int, aV_int); break;
 172     case 4: appendValues(aRGB, aVinc_int, aVmin_int, aV_int); break;
 173     case 5: appendValues(aRGB, aV_int,    aVmin_int, aVdec_int); break;
 174     default: break;
 175   }
 176   return aRGB;
 177 }
 178
 179
 180 void fillColorMap()
 181 {
 182   if (!myColorMap.empty())
 183     return;
 184
 185   int i = 0;
 186   for (int s = 100; s > 0; s = s - 50)
 187   {
 188     for (int v = 100; v >= 40; v = v - 20)
 189     {
 190       for (int h = 0; h < 359 ; h = h + 60)
 191       {
 192         std::vector<int> aColor = HSVtoRGB(h, s, v);
 193         if (containsValues(myColorMap, aColor))
 194           continue;
 195         myColorMap[i] = aColor;
 196         i++;
 197       }
 198     }
 199   }
 200 }
 201
 202 void findRandomColor(std::vector<int>& theValues)
 203 {
 204   theValues.clear();
 205   if (myColorMap.empty()) {
 206     fillColorMap();
 207   }
 208
 209   size_t aSize = myColorMap.size();
 210   int anIndex = rand() % aSize;
 211   if (myColorMap.find(anIndex) != myColorMap.end()) {
 212     theValues = myColorMap.at(anIndex);
 213   }
 214 }
 215
 216 ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub)
 217 {
 218   if (theMain != theSub) { // to optimize and avoid of crash on partset document close (don't touch the sub-document structure)
 219     for (int a = theMain->size(ModelAPI_ResultPart::group()) - 1; a >= 0; a--) {
 220       ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(
 221           theMain->object(ModelAPI_ResultPart::group(), a));
 222       if (aPart && aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->value() == theSub) {
 223         return aPart;
 224       }
 225     }
 226   }
 227   return ResultPtr();
 228 }
 229
 230 FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub)
 231 {
 232   if (theMain != theSub) { // to optimize and avoid of crash on partset document close (don't touch the sub-document structure)
 233     for (int a = theMain->size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
 234       FeaturePtr aPartFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(
 235           theMain->object(ModelAPI_Feature::group(), a));
 236       if (aPartFeat.get()) {
 237         const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aPartFeat->results();
 238         std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
 239         for(; aRes != aResList.end(); aRes++) {
 240           ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
 241           if (aPart.get()) {
 242             if (aPart->isActivated() && aPart->partDoc() == theSub)
 243               return aPartFeat;
 244           } else break; // if the first is not Part, others are also not
 245         }
 246       }
 247     }
 248   }
 249   return FeaturePtr();
 250 }
 251
 252 CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature)
 253 {
 254   if (theFeature.get() && theFeature->data()->isValid()) {
 255     const std::set<std::shared_ptr<ModelAPI_Attribute> >& aRefs = theFeature->data()->refsToMe();
 256     std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator aRefIter = aRefs.begin();
 257     for(; aRefIter != aRefs.end(); aRefIter++) {
 258       CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>
 259         ((*aRefIter)->owner());
 260       if (aComp.get() && aComp->data()->isValid() && aComp->isSub(theFeature))
 261         return aComp;
 262     }
 263   }
 264   return CompositeFeaturePtr(); // not found
 265 }
 266
 267 ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub)
 268 {
 269   ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theSub);
 270   if (aBody.get()) {
 271     FeaturePtr aFeatureOwner = aBody->document()->feature(aBody);
 272     if (aFeatureOwner.get()) {
 273       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aResIter =
 274         aFeatureOwner->results().cbegin();
 275       for(; aResIter != aFeatureOwner->results().cend(); aResIter++) {
 276         ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aResIter);
 277         if (aComp && aComp->isSub(aBody))
 278           return aComp;
 279       }
 280     }
 281   }
 282   return ResultCompSolidPtr(); // not found
 283 }
 284
 285 bool hasSubResults(const ResultPtr& theResult)
 286 {
 287   ResultCompSolidPtr aCompSolid = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(theResult);
 288   return aCompSolid.get() && aCompSolid->numberOfSubs() > 0;
 289 }
 290
 291 void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults)
 292 {
 293   const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
 294   std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
 295   for (; aRIter != aResults.cend(); aRIter++) {
 296     theResults.push_back(*aRIter);
 297     // iterate sub-bodies of compsolid
 298     ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRIter);
 299     if (aComp.get()) {
 300       int aNumSub = aComp->numberOfSubs();
 301       for(int a = 0; a < aNumSub; a++) {
 302         theResults.push_back(aComp->subResult(a));
 303       }
 304     }
 305   }
 306 }
 307
 308 } // namespace ModelAPI_Tools
 309
 310