1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #include "ModelAPI_Tools.h"
21 #include <ModelAPI_Session.h>
22 #include <ModelAPI_CompositeFeature.h>
23 #include <ModelAPI_Document.h>
24 #include <ModelAPI_Object.h>
25 #include <ModelAPI_AttributeDouble.h>
26 #include <ModelAPI_AttributeSelectionList.h>
27 #include <ModelAPI_ResultBody.h>
28 #include <ModelAPI_ResultParameter.h>
29 #include <ModelAPI_ResultPart.h>
30 #include <ModelAPI_ResultGroup.h>
31 #include <ModelAPI_AttributeDocRef.h>
32 #include <ModelAPI_Validator.h>
33 #include <ModelAPI_AttributeIntArray.h>
34 #include <ModelAPI_ResultConstruction.h>
35 #include <ModelAPI_AttributeBoolean.h>
41 // To support old types of GCC (less than 5.0), check the wide-string conversion is working
42 #if (__cplusplus >= 201103L || _MSVC_LANG >= 201103L) && \
43 (__cplusplus >= 201402L || !defined(__GLIBCXX__) || \
44 (defined(_GLIBCXX_RELEASE) && _GLIBCXX_RELEASE > 4))
45 #define HAVE_WORKING_WIDESTRING 1
47 #define HAVE_WORKING_WIDESTRING 0
50 #if HAVE_WORKING_WIDESTRING
54 #include <Events_Loop.h>
55 #include <ModelAPI_Events.h>
57 #include <GeomAPI_ShapeHierarchy.h>
58 #include <GeomAPI_ShapeIterator.h>
60 #define RECURSE_TOP_LEVEL 50
62 //#define DEBUG_REMOVE_FEATURES
63 //#define DEBUG_REMOVE_FEATURES_RECURSE
64 //#define DEBUG_CYCLING_1550
66 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
68 std::string getFeatureInfo(FeaturePtr theFeature)
70 if (!theFeature.get())
72 //std::ostringstream aPtrStr;
73 //aPtrStr << "[" << theFeature.get() << "] ";
74 std::string aFeatureInfo = /*aPtrStr.str() + */theFeature->name();
75 CompositeFeaturePtr aComposite = ModelAPI_Tools::compositeOwner(theFeature);
76 if (aComposite.get()) {
77 aFeatureInfo = aFeatureInfo + "[in " + aComposite->name() + "]";
83 #ifdef DEBUG_REMOVE_FEATURES
84 void printMapInfo(const std::map<FeaturePtr, std::set<FeaturePtr> >& theMainList,
85 const std::string& thePrefix)
87 std::map<FeaturePtr, std::set<FeaturePtr> >::const_iterator aMainIt = theMainList.begin(),
88 aMainLast = theMainList.end();
90 for (; aMainIt != aMainLast; aMainIt++) {
91 FeaturePtr aMainListFeature = aMainIt->first;
92 std::set<FeaturePtr> aMainRefList = aMainIt->second;
93 std::set<FeaturePtr>::const_iterator anIt = aMainRefList.begin(), aLast = aMainRefList.end();
94 std::string aRefsInfo;
95 for (; anIt != aLast; anIt++) {
96 aRefsInfo += (*anIt)->name().c_str();
100 if (!aRefsInfo.empty()) {
101 anInfo = anInfo + aMainListFeature->name().c_str() + ": " + aRefsInfo + "\n";
104 std::cout << thePrefix.c_str() << " [feature: references to]: \n" << anInfo.c_str() << std::endl;
107 void printListInfo(const std::set<FeaturePtr>& theMainList,
108 const std::string& thePrefix)
110 std::set<FeaturePtr>::const_iterator aMainIt = theMainList.begin(),
111 aMainLast = theMainList.end();
113 for (; aMainIt != aMainLast; aMainIt++) {
114 FeaturePtr aRefFeature = *aMainIt;
115 anInfo += aRefFeature->name().c_str();
116 if (aMainIt != aMainLast)
119 std::cout << thePrefix.c_str() << ": " << anInfo.c_str() << std::endl;
123 namespace ModelAPI_Tools {
125 std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult)
127 return theResult->shape();
131 const char* toString(ModelAPI_ExecState theExecState)
133 switch (theExecState) {
134 case ModelAPI_StateDone: return "Done";
135 case ModelAPI_StateMustBeUpdated: return "Must be updated";
136 case ModelAPI_StateExecFailed: return "Execution failed";
137 case ModelAPI_StateInvalidArgument: return "Invalid argument";
138 case ModelAPI_StateNothing: return "Empty state";
139 default: return "Unknown ExecState.";
143 std::string getFeatureError(const FeaturePtr& theFeature)
146 if (!theFeature.get() || !theFeature->data()->isValid() || theFeature->isAction())
149 // to be removed later, this error should be got from the feature
150 if (theFeature->data()->execState() == ModelAPI_StateDone ||
151 theFeature->data()->execState() == ModelAPI_StateMustBeUpdated)
154 // set error indication
155 anError = theFeature->error();
156 if (anError.empty()) {
157 bool isDone = ( theFeature->data()->execState() == ModelAPI_StateDone
158 || theFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
160 anError = toString(theFeature->data()->execState());
161 // If the feature is Composite and error is StateInvalidArgument,
162 // error text should include error of first invalid sub-feature. Otherwise
163 // it is not clear what is the reason of the invalid argument.
164 if (theFeature->data()->execState() == ModelAPI_StateInvalidArgument) {
165 CompositeFeaturePtr aComposite =
166 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
168 for (int i = 0, aSize = aComposite->numberOfSubs(); i < aSize; i++) {
169 FeaturePtr aSubFeature = aComposite->subFeature(i);
170 std::string aSubFeatureError = getFeatureError(aSubFeature);
171 if (!aSubFeatureError.empty()) {
172 anError = anError + " in " + aSubFeature->getKind() + ".\n" + aSubFeatureError;
185 ObjectPtr objectByName(const DocumentPtr& theDocument, const std::string& theGroup,
186 const std::string& theName)
188 std::wstring aName = toWString(theName);
189 for (int anIndex = 0; anIndex < theDocument->size(theGroup); ++anIndex) {
190 ObjectPtr anObject = theDocument->object(theGroup, anIndex);
191 if (anObject->data()->name() == aName)
198 bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,
199 const std::string& theName, double& outValue, ResultParameterPtr& theParam)
201 ObjectPtr aParamObj = objectByName(theDocument, ModelAPI_ResultParameter::group(), theName);
202 theParam = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(aParamObj);
205 // avoid usage of parameters created later than the initial parameter
207 if (theSearcher.get()) {
208 FeaturePtr aParamFeat = theDocument->feature(theParam);
209 if (aParamFeat == theSearcher || theDocument->isLater(aParamFeat, theSearcher))
212 AttributeDoublePtr aValueAttribute = theParam->data()->real(ModelAPI_ResultParameter::VALUE());
213 outValue = aValueAttribute->value();
217 bool findVariable(FeaturePtr theSearcher, const std::string& theName, double& outValue,
218 ResultParameterPtr& theParam, const DocumentPtr& theDocument)
220 SessionPtr aSession = ModelAPI_Session::get();
221 std::list<DocumentPtr> aDocList;
222 DocumentPtr aDocument = theDocument.get() ? theDocument : aSession->activeDocument();
223 if (findVariable(aDocument, theSearcher, theName, outValue, theParam))
225 DocumentPtr aRootDocument = aSession->moduleDocument();
226 if (aDocument != aRootDocument) {
227 // any parameters in PartSet is okindependently on the Part position (issu #1504)
228 if (findVariable(aRootDocument, FeaturePtr(), theName, outValue, theParam))
234 ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub)
236 // to optimize and avoid of crash on partset document close
237 // (don't touch the sub-document structure)
238 if (theMain != theSub) {
239 for (int a = theMain->size(ModelAPI_ResultPart::group()) - 1; a >= 0; a--) {
240 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(
241 theMain->object(ModelAPI_ResultPart::group(), a));
242 if (aPart && aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->value() == theSub) {
250 FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub)
252 // to optimize and avoid of crash on partset document close
253 // (don't touch the sub-document structure)
254 if (theMain != theSub) {
255 // iteration from top to bottom to avoid finding the movement documents before the original
256 int aSize = theMain->size(ModelAPI_Feature::group());
257 for (int a = 0; a < aSize; a++) {
258 FeaturePtr aPartFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(
259 theMain->object(ModelAPI_Feature::group(), a));
260 if (aPartFeat.get()) {
261 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aPartFeat->results();
262 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
263 for(; aRes != aResList.end(); aRes++) {
264 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
266 if (aPart->isActivated() && aPart->partDoc() == theSub)
268 } else break; // if the first is not Part, others are also not
276 CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature)
278 if (theFeature.get() && theFeature->data() && theFeature->data()->isValid()) {
279 const std::set<std::shared_ptr<ModelAPI_Attribute> >& aRefs = theFeature->data()->refsToMe();
280 std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator aRefIter = aRefs.begin();
281 for(; aRefIter != aRefs.end(); aRefIter++) {
282 CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>
283 ((*aRefIter)->owner());
284 if (aComp.get() && aComp->data()->isValid() && aComp->isSub(theFeature))
288 return CompositeFeaturePtr(); // not found
291 ResultBodyPtr bodyOwner(const ResultPtr& theSub, const bool theRoot)
294 ObjectPtr aParent = theSub->document()->parent(theSub);
296 if (theRoot) { // try to find parent of parent
297 ResultPtr aResultParent = std::dynamic_pointer_cast<ModelAPI_Result>(aParent);
298 ResultBodyPtr aGrandParent = bodyOwner(aResultParent, true);
299 if (aGrandParent.get())
300 aParent = aGrandParent;
302 return std::dynamic_pointer_cast<ModelAPI_ResultBody>(aParent);
305 return ResultBodyPtr(); // not found
308 int bodyIndex(const ResultPtr& theSub)
311 ResultBodyPtr aParent = bodyOwner(theSub);
313 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theSub);
314 if (aBody.get() && aParent->isSub(aBody, anIndex))
317 return anIndex; // not found
320 bool hasSubResults(const ResultPtr& theResult)
322 ResultBodyPtr aCompSolid = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
323 return aCompSolid.get() && aCompSolid->numberOfSubs() > 0;
326 void allSubs(const ResultBodyPtr& theResult, std::list<ResultPtr>& theResults,
327 const bool theLowerOnly) {
328 // iterate sub-bodies of compsolid
329 ResultBodyPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
331 int aNumSub = aComp->numberOfSubs();
332 for (int a = 0; a < aNumSub; a++) {
333 ResultBodyPtr aSub = aComp->subResult(a);
334 if (!theLowerOnly || aSub->numberOfSubs() == 0)
335 theResults.push_back(aSub);
336 allSubs(aSub, theResults);
341 void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults)
343 if (!theFeature.get()) // safety: for empty feature no results
345 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
346 std::list<ResultPtr>::const_iterator aRIter = aResults.begin();
347 for (; aRIter != aResults.cend(); aRIter++) {
348 theResults.push_back(*aRIter);
349 ResultBodyPtr aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(*aRIter);
350 allSubs(aResult, theResults);
354 //******************************************************************
355 bool allDocumentsActivated(std::wstring& theNotActivatedNames)
357 theNotActivatedNames = L"";
358 bool anAllPartActivated = true;
360 DocumentPtr aRootDoc = ModelAPI_Session::get()->moduleDocument();
361 int aSize = aRootDoc->size(ModelAPI_ResultPart::group());
362 for (int i = 0; i < aSize; i++) {
363 ObjectPtr aObject = aRootDoc->object(ModelAPI_ResultPart::group(), i);
364 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(aObject);
365 if (!aPart->isActivated()) {
366 anAllPartActivated = false;
367 if (!theNotActivatedNames.empty())
368 theNotActivatedNames += L", ";
369 theNotActivatedNames += aObject->data()->name().c_str();
372 return anAllPartActivated;
375 bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,
376 const bool theFlushRedisplay,
377 const bool theUseComposite,
378 const bool theUseRecursion)
380 #ifdef DEBUG_REMOVE_FEATURES
381 printListInfo(theFeatures, "selection: ");
384 std::map<FeaturePtr, std::set<FeaturePtr> > aReferences;
385 ModelAPI_Tools::findAllReferences(theFeatures, aReferences, theUseComposite, theUseRecursion);
386 #ifdef DEBUG_REMOVE_FEATURES
387 printMapInfo(aReferences, "allDependencies: ");
390 std::set<FeaturePtr> aFeaturesRefsTo;
391 ModelAPI_Tools::findRefsToFeatures(theFeatures, aReferences, aFeaturesRefsTo);
392 #ifdef DEBUG_REMOVE_FEATURES
393 printListInfo(aFeaturesRefsTo, "references: ");
396 std::set<FeaturePtr> aFeatures = theFeatures;
397 if (!aFeaturesRefsTo.empty())
398 aFeatures.insert(aFeaturesRefsTo.begin(), aFeaturesRefsTo.end());
399 #ifdef DEBUG_REMOVE_FEATURES
400 printListInfo(aFeatures, "removeFeatures: ");
403 return ModelAPI_Tools::removeFeatures(aFeatures, false);
406 //***********************************************************************
407 bool removeFeatures(const std::set<FeaturePtr>& theFeatures,
408 const bool theFlushRedisplay)
411 std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
412 aLast = theFeatures.end();
413 for (; anIt != aLast; anIt++) {
414 FeaturePtr aFeature = *anIt;
415 if (aFeature.get()) {
416 DocumentPtr aDoc = aFeature->document();
417 // flush REDISPLAY signal after remove feature
418 aDoc->removeFeature(aFeature);
422 if (isDone && theFlushRedisplay) {
423 // the redisplay signal should be flushed in order to erase
424 // the feature presentation in the viewer
425 // if should be done after removeFeature() of document
426 Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
431 //***********************************************************************
432 // Fills the references list by all references of the feature from the references map.
433 // This is a recusive method to find references by next found feature in the map of references.
434 // \param theFeature a feature to find references
435 // \param theReferencesMap a map of references
436 // \param theReferences an out container of references
437 void addRefsToFeature(const FeaturePtr& theFeature,
438 const std::map<FeaturePtr, std::set<FeaturePtr> >& theReferencesMap,
440 std::set<FeaturePtr>& theReferences)
442 if (theRecLevel > RECURSE_TOP_LEVEL)
446 if (theReferencesMap.find(theFeature) == theReferencesMap.end())
447 return; // this feature is not in the selection list, so exists without references to it
448 std::set<FeaturePtr> aMainReferences = theReferencesMap.at(theFeature);
450 std::set<FeaturePtr>::const_iterator anIt = aMainReferences.begin(),
451 aLast = aMainReferences.end();
452 for (; anIt != aLast; anIt++) {
453 FeaturePtr aRefFeature = *anIt;
454 if (theReferences.find(aRefFeature) == theReferences.end()) {
455 addRefsToFeature(aRefFeature, theReferencesMap, theRecLevel, theReferences);
456 theReferences.insert(aRefFeature);
461 // For each feature from the feature list it searches references to the feature and append them
462 // to the references map. This is a recusive method.
463 // \param theFeature a feature to find references
464 // \param theReferencesMap a map of references
465 // \param theReferences an out container of references
466 void findReferences(const std::set<FeaturePtr>& theFeatures,
467 std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
468 const bool theUseComposite, const bool theUseRecursion, int theRecLevel)
470 if (theRecLevel > RECURSE_TOP_LEVEL)
473 std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
474 aLast = theFeatures.end();
475 for (; anIt != aLast; anIt++) {
476 FeaturePtr aFeature = *anIt;
477 if (aFeature.get() && theReferences.find(aFeature) == theReferences.end()) {
478 DocumentPtr aSelFeatureDoc = aFeature->document();
479 std::set<FeaturePtr> aSelRefFeatures;
480 aSelFeatureDoc->refsToFeature(aFeature, aSelRefFeatures, false/*do not emit signals*/);
481 if (theUseComposite) { // do not filter selection
482 theReferences[aFeature] = aSelRefFeatures;
484 else { // filter references to skip composition features of the current feature
485 std::set<FeaturePtr> aFilteredFeatures;
486 std::set<FeaturePtr>::const_iterator anIt = aSelRefFeatures.begin(),
487 aLast = aSelRefFeatures.end();
488 for (; anIt != aLast; anIt++) {
489 FeaturePtr aCFeature = *anIt;
490 CompositeFeaturePtr aComposite =
491 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCFeature);
492 if (aComposite.get() && aComposite->isSub(aFeature))
493 continue; /// composite of the current feature should be skipped
494 aFilteredFeatures.insert(aCFeature);
496 theReferences[aFeature] = aFilteredFeatures;
498 if (theUseRecursion) {
499 #ifdef DEBUG_CYCLING_1550
500 findReferences(aSelRefFeatures, theReferences, theUseComposite,
501 theUseRecursion, theRecLevel);
503 findReferences(theReferences[aFeature], theReferences, theUseComposite, theUseRecursion,
511 void findAllReferences(const std::set<FeaturePtr>& theFeatures,
512 std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
513 const bool theUseComposite,
514 const bool theUseRecursion)
516 // For dependencies, find main_list:
517 // sk_1(ext_1, vertex_1)
518 // ext_1(bool_1, sk_3)
523 // Information: bool_1 is not selected, ext_2(bool_2) exists
524 // find all referenced features
525 std::map<FeaturePtr, std::set<FeaturePtr> > aMainList;
527 findReferences(theFeatures, aMainList, theUseComposite, theUseRecursion, aRecLevel);
529 #ifdef DEBUG_REMOVE_FEATURES
530 printMapInfo(aMainList, "firstDependencies");
532 // find all dependencies for each object:
533 // sk_1(ext_1, vertex_1) + (sk_3, bool_1)
534 // ext_1(bool_1, sk_3)
536 // sk_2(ext_2) + (bool_1)
539 std::map<FeaturePtr, std::set<FeaturePtr> >::const_iterator aMainIt = aMainList.begin(),
540 aMainLast = aMainList.end();
541 for (; aMainIt != aMainLast; aMainIt++) {
542 FeaturePtr aMainListFeature = aMainIt->first;
544 //std::string aName = aMainListFeature->name();
545 std::set<FeaturePtr> aMainRefList = aMainIt->second;
547 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
549 int n = sprintf(aBuf, "%d", aMainRefList.size());
550 std::string aSize(aBuf);
551 std::cout << "_findAllReferences for the Feature: " << getFeatureInfo(aMainListFeature)
552 << ", references size = " << aSize << std::endl;
554 std::set<FeaturePtr>::const_iterator anIt = aMainRefList.begin(),
555 aLast = aMainRefList.end();
556 std::set<FeaturePtr> aResultRefList;
557 aResultRefList.insert(aMainRefList.begin(), aMainRefList.end());
558 for (; anIt != aLast; anIt++) {
559 FeaturePtr aFeature = *anIt;
561 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
562 std::cout << " Ref: " << getFeatureInfo(aFeature) << std::endl;
565 addRefsToFeature(aFeature, aMainList,
566 aRecLevel, aResultRefList/*aMainRefList*/);
568 theReferences[aMainListFeature] = aResultRefList;
570 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
571 std::cout << std::endl;
574 #ifdef DEBUG_REMOVE_FEATURES
575 printMapInfo(theReferences, "allDependencies");
579 void findRefsToFeatures(const std::set<FeaturePtr>& theFeatures,
580 const std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
581 std::set<FeaturePtr>& theFeaturesRefsTo)
583 std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
584 aLast = theFeatures.end();
585 for (; anIt != aLast; anIt++) {
586 FeaturePtr aFeature = *anIt;
587 if (theReferences.find(aFeature) == theReferences.end())
589 std::set<FeaturePtr> aRefList = theReferences.at(aFeature);
590 std::set<FeaturePtr>::const_iterator aRefIt = aRefList.begin(), aRefLast = aRefList.end();
591 for (; aRefIt != aRefLast; aRefIt++) {
592 FeaturePtr aRefFeature = *aRefIt;
593 CompositeFeaturePtr aComposite =
594 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aRefFeature);
595 if (aComposite.get() && aComposite->isSub(aFeature))
596 continue; /// composite of the current feature should not be removed
598 if (theFeatures.find(aRefFeature) == theFeatures.end() && // it is not selected
599 theFeaturesRefsTo.find(aRefFeature) == theFeaturesRefsTo.end()) // it is not added
600 theFeaturesRefsTo.insert(aRefFeature);
605 void getConcealedResults(const FeaturePtr& theFeature,
606 std::list<std::shared_ptr<ModelAPI_Result> >& theResults)
608 SessionPtr aSession = ModelAPI_Session::get();
610 std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > > aRefs;
611 theFeature->data()->referencesToObjects(aRefs);
612 std::list<std::pair<std::string, std::list<ObjectPtr> > >::const_iterator
613 anIt = aRefs.begin(), aLast = aRefs.end();
614 std::set<ResultPtr> alreadyThere; // to avoid duplications
615 for (; anIt != aLast; anIt++) {
616 if (!aSession->validators()->isConcealed(theFeature->getKind(), anIt->first))
617 continue; // use only concealed attributes
618 std::list<ObjectPtr> anObjects = (*anIt).second;
619 std::list<ObjectPtr>::const_iterator anOIt = anObjects.begin(), anOLast = anObjects.end();
620 for (; anOIt != anOLast; anOIt++) {
621 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(*anOIt);
622 if (aResult && aResult->isConcealed()) {
623 if (alreadyThere.find(aResult) == alreadyThere.end()) // issue 1712, avoid duplicates
624 alreadyThere.insert(aResult);
626 theResults.push_back(aResult);
632 std::pair<std::wstring, bool> getDefaultName(const std::shared_ptr<ModelAPI_Result>& theResult,
633 const bool theInherited)
635 typedef std::list< std::pair < std::string, std::list<ObjectPtr> > > ListOfReferences;
637 SessionPtr aSession = ModelAPI_Session::get();
639 ResultBodyPtr anOwnerRes = bodyOwner(theResult);
641 // names of sub-solids in CompSolid should be default (for example,
642 // result of boolean operation 'Boolean_1_1' is a CompSolid which is renamed to 'MyBOOL',
643 // however, sub-elements of 'MyBOOL' should be named 'Boolean_1_1_1', 'Boolean_1_1_2' etc.)
644 std::wostringstream aDefaultName;
645 aDefaultName << getDefaultName(anOwnerRes).first;
646 aDefaultName << "_" << (bodyIndex(theResult) + 1);
647 return std::pair<std::wstring, bool>(aDefaultName.str(), false);
650 FeaturePtr anOwner = ModelAPI_Feature::feature(theResult->data()->owner());
651 DataPtr aData = anOwner->data();
653 ListOfReferences aReferences;
654 // find first result with user-defined name
655 ListOfReferences::const_iterator aFoundRef = aReferences.end();
657 aData->referencesToObjects(aReferences);
659 for (ListOfReferences::const_iterator aRefIt = aReferences.begin();
660 aRefIt != aReferences.end(); ++aRefIt) {
661 bool isConcealed = aSession->validators()->isConcealed(anOwner->getKind(), aRefIt->first);
662 bool isMainArg = isConcealed &&
663 aSession->validators()->isMainArgument(anOwner->getKind(), aRefIt->first);
665 // check the referred object is a Body
666 // (for example, ExtrusionCut has a sketch as a first attribute which is concealing)
667 bool isBody = aRefIt->second.size() > 1 || (aRefIt->second.size() == 1 &&
668 aRefIt->second.front().get() &&
669 aRefIt->second.front()->groupName() == ModelAPI_ResultBody::group());
670 if (isBody && (isMainArg || aFoundRef == aReferences.end() ||
671 aData->isPrecedingAttribute(aRefIt->first, aFoundRef->first)))
679 // get the result number in the feature
680 int anIndexInOwner = 0;
681 const std::list<ResultPtr>& anOwnerResults = anOwner->results();
682 std::list<ResultPtr>::const_iterator aResIt = anOwnerResults.cbegin();
683 for(; aResIt != anOwnerResults.cend(); aResIt++) {
684 if(*aResIt == theResult)
689 // find an object which is concealed by theResult
690 if (aFoundRef != aReferences.end() && !aFoundRef->second.empty()) {
691 // store number of references for each object
692 std::map<ResultPtr, int> aNbRefToObject;
693 // search the object by result index
694 std::list<ObjectPtr>::const_iterator anObjIt = aFoundRef->second.begin();
695 int aResultIndex = anIndexInOwner;
696 while (--aResultIndex >= 0) {
697 ResultPtr aCurRes = std::dynamic_pointer_cast<ModelAPI_Result>(*anObjIt);
698 ResultBodyPtr aParentBody = ModelAPI_Tools::bodyOwner(aCurRes);
700 aCurRes = aParentBody;
701 if (aNbRefToObject.find(aCurRes) == aNbRefToObject.end())
702 aNbRefToObject[aCurRes] = 1;
704 aNbRefToObject[aCurRes] += 1;
707 if (anObjIt == aFoundRef->second.end()) {
708 anObjIt = aFoundRef->second.begin();
712 // check the result is a Body
713 if ((*anObjIt)->groupName() == ModelAPI_ResultBody::group()) {
714 // check the result is part of CompSolid
715 ResultPtr anObjRes = std::dynamic_pointer_cast<ModelAPI_Result>(*anObjIt);
716 ResultBodyPtr aParentBody = ModelAPI_Tools::bodyOwner(anObjRes);
718 anObjRes = aParentBody;
720 // return name of reference result only if it has been renamed by the user,
721 // in other case compose a default name
722 if (anObjRes->data()->hasUserDefinedName()) {
723 std::wstringstream aName;
724 aName << anObjRes->data()->name();
725 std::map<ResultPtr, int>::iterator aFound = aNbRefToObject.find(anObjRes);
726 if (aFound != aNbRefToObject.end()) {
727 // to generate unique name, add suffix if there are several results
728 // referring to the same shape
729 aName << "_" << aFound->second + 1;
731 return std::pair<std::wstring, bool>(aName.str(), true);
736 // compose default name by the name of the feature and the index of result
737 std::wstringstream aDefaultName;
738 aDefaultName << anOwner->name();
739 // if there are several results (issue #899: any number of result),
740 // add unique prefix starting from second
741 if (anIndexInOwner > 0 || theResult->groupName() == ModelAPI_ResultBody::group())
742 aDefaultName << "_" << anIndexInOwner + 1;
743 return std::pair<std::wstring, bool>(aDefaultName.str(), false);
746 std::set<FeaturePtr> getParents(const FeaturePtr& theFeature)
748 std::set<FeaturePtr> aParents;
749 for (FeaturePtr aCurFeat = theFeature; aCurFeat; ) {
750 CompositeFeaturePtr aFoundComposite;
751 const std::set<AttributePtr>& aRefs = aCurFeat->data()->refsToMe();
752 for (std::set<AttributePtr>::const_iterator anIt = aRefs.begin();
753 anIt != aRefs.end(); ++anIt) {
754 FeaturePtr aF = ModelAPI_Feature::feature((*anIt)->owner());
755 aFoundComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aF);
756 if (aFoundComposite && aFoundComposite->isSub(aCurFeat))
759 aFoundComposite = CompositeFeaturePtr();
762 if (aFoundComposite) {
763 aParents.insert(aFoundComposite);
764 aCurFeat = aFoundComposite;
767 // add the part containing high-level feature
768 SessionPtr aSession = ModelAPI_Session::get();
769 DocumentPtr aPartSetDoc = aSession->moduleDocument();
770 std::list<FeaturePtr> aPartSetFeatures = aPartSetDoc->allFeatures();
771 for (std::list<FeaturePtr>::const_iterator anIt = aPartSetFeatures.begin();
772 anIt != aPartSetFeatures.end(); ++anIt) {
773 aFoundComposite = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
774 if (aFoundComposite && aFoundComposite->isSub(aCurFeat)) {
775 aParents.insert(aFoundComposite);
780 aCurFeat = FeaturePtr();
786 void fillShapeHierarchy(const GeomShapePtr& theShape,
787 const ResultPtr& theContext,
788 GeomAPI_ShapeHierarchy& theHierarchy)
790 ResultBodyPtr aResCompSolidPtr = ModelAPI_Tools::bodyOwner(theContext);
791 if (aResCompSolidPtr.get()) {
792 std::shared_ptr<GeomAPI_Shape> aContextShape = aResCompSolidPtr->shape();
793 if (aContextShape->shapeType() <= GeomAPI_Shape::COMPSOLID) {
794 theHierarchy.addParent(theShape, aContextShape);
795 fillShapeHierarchy(aContextShape, aResCompSolidPtr, theHierarchy);
801 void removeResults(const std::list<ResultPtr>& theResults)
803 // collect all documents where the results must be removed
804 std::map<DocumentPtr, std::list<ResultPtr> > aDocs;
806 std::list<ResultPtr>::const_iterator aResIter = theResults.cbegin();
807 for(; aResIter != theResults.cend(); aResIter++) {
808 DocumentPtr aDoc = (*aResIter)->document();
809 if (!aDocs.count(aDoc))
810 aDocs[aDoc] = std::list<ResultPtr>();
811 aDocs[aDoc].push_back(*aResIter);
813 // create a "remove" feature in each doc
814 std::map<DocumentPtr, std::list<ResultPtr> >::iterator aDoc = aDocs.begin();
815 for(; aDoc != aDocs.end(); aDoc++) {
816 FeaturePtr aRemove = aDoc->first->addFeature("RemoveResults");
818 for(aResIter = aDoc->second.cbegin(); aResIter != aDoc->second.cend(); aResIter++)
819 aRemove->selectionList("results")->append(*aResIter, GeomShapePtr());
827 //**************************************************************
828 void setDeflection(ResultPtr theResult, const double theDeflection)
830 if (!theResult.get())
833 AttributeDoublePtr aDeflectionAttr = theResult->data()->real(ModelAPI_Result::DEFLECTION_ID());
834 if (aDeflectionAttr.get() != NULL) {
835 aDeflectionAttr->setValue(theDeflection);
839 double getDeflection(const std::shared_ptr<ModelAPI_Result>& theResult)
841 double aDeflection = -1;
842 // get deflection from the attribute of the result
843 if (theResult.get() != NULL &&
844 theResult->data()->attribute(ModelAPI_Result::DEFLECTION_ID()).get() != NULL) {
845 AttributeDoublePtr aDoubleAttr = theResult->data()->real(ModelAPI_Result::DEFLECTION_ID());
846 if (aDoubleAttr.get() && aDoubleAttr->isInitialized()) {
847 double aValue = aDoubleAttr->value();
848 if (aValue > 0) /// zero value should not be used as a deflection(previous studies)
849 aDeflection = aDoubleAttr->value();
855 //******************************************************
856 void setColor(ResultPtr theResult, const std::vector<int>& theColor)
858 if (!theResult.get())
861 AttributeIntArrayPtr aColorAttr = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
862 if (aColorAttr.get() != NULL) {
863 if (!aColorAttr->size()) {
864 aColorAttr->setSize(3);
866 aColorAttr->setValue(0, theColor[0]);
867 aColorAttr->setValue(1, theColor[1]);
868 aColorAttr->setValue(2, theColor[2]);
872 void getColor(const std::shared_ptr<ModelAPI_Result>& theResult, std::vector<int>& theColor)
875 // get color from the attribute of the result
876 if (theResult.get() != NULL &&
877 theResult->data()->attribute(ModelAPI_Result::COLOR_ID()).get() != NULL) {
878 AttributeIntArrayPtr aColorAttr = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
879 if (aColorAttr.get() && aColorAttr->size()) {
880 theColor.push_back(aColorAttr->value(0));
881 theColor.push_back(aColorAttr->value(1));
882 theColor.push_back(aColorAttr->value(2));
887 //******************************************************
888 void getIsoLines(const std::shared_ptr<ModelAPI_Result>& theResult,
889 bool& isVisible, std::vector<int>& theNbLines)
893 if (!theResult.get())
895 if (theResult->groupName() == ModelAPI_ResultConstruction::group()) {
896 theNbLines.push_back(0);
897 theNbLines.push_back(0);
900 // get color from the attribute of the result
901 AttributeIntArrayPtr aAttr = theResult->data()->intArray(ModelAPI_Result::ISO_LINES_ID());
904 theNbLines.push_back(aAttr->value(0));
905 theNbLines.push_back(aAttr->value(1));
908 AttributeBooleanPtr aBoolAttr =
909 theResult->data()->boolean(ModelAPI_Result::SHOW_ISO_LINES_ID());
910 if (aBoolAttr.get()) {
911 isVisible = aBoolAttr->value();
916 //******************************************************
917 void setIsoLines(ResultPtr theResult, const std::vector<int>& theIso)
919 if (!theResult.get())
922 AttributeIntArrayPtr aAttr = theResult->data()->intArray(ModelAPI_Result::ISO_LINES_ID());
923 if (aAttr.get() != NULL) {
924 if (!aAttr->size()) {
927 aAttr->setValue(0, theIso[0]);
928 aAttr->setValue(1, theIso[1]);
932 //******************************************************
933 void showIsoLines(std::shared_ptr<ModelAPI_Result> theResult, bool theShow)
935 if (!theResult.get())
938 AttributeBooleanPtr aAttr = theResult->data()->boolean(ModelAPI_Result::SHOW_ISO_LINES_ID());
939 if (aAttr.get() != NULL) {
940 aAttr->setValue(theShow);
944 //******************************************************
945 bool isShownIsoLines(std::shared_ptr<ModelAPI_Result> theResult)
947 if (!theResult.get())
950 AttributeBooleanPtr aAttr = theResult->data()->boolean(ModelAPI_Result::SHOW_ISO_LINES_ID());
951 if (aAttr.get() != NULL) {
952 return aAttr->value();
957 //**************************************************************
958 void setTransparency(ResultPtr theResult, double theTransparency)
960 if (!theResult.get())
963 AttributeDoublePtr anAttribute = theResult->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
964 if (anAttribute.get() != NULL) {
965 anAttribute->setValue(theTransparency);
969 double getTransparency(const std::shared_ptr<ModelAPI_Result>& theResult)
971 double aTransparency = -1;
972 // get transparency from the attribute of the result
973 if (theResult.get() != NULL &&
974 theResult->data()->attribute(ModelAPI_Result::TRANSPARENCY_ID()).get() != NULL) {
975 AttributeDoublePtr aDoubleAttr = theResult->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
976 if (aDoubleAttr.get() && aDoubleAttr->isInitialized()) {
977 aTransparency = aDoubleAttr->value();
980 return aTransparency;
983 void copyVisualizationAttrs(
984 std::shared_ptr<ModelAPI_Result> theSource, std::shared_ptr<ModelAPI_Result> theDest)
987 AttributeIntArrayPtr aSourceColor = theSource->data()->intArray(ModelAPI_Result::COLOR_ID());
988 if (aSourceColor.get() && aSourceColor->isInitialized() && aSourceColor->size()) {
989 AttributeIntArrayPtr aDestColor = theDest->data()->intArray(ModelAPI_Result::COLOR_ID());
990 if (aDestColor.get()) {
991 aDestColor->setSize(aSourceColor->size());
992 for(int a = 0; a < aSourceColor->size(); a++)
993 aDestColor->setValue(a, aSourceColor->value(a));
997 AttributeIntArrayPtr aSource = theSource->data()->intArray(ModelAPI_Result::ISO_LINES_ID());
998 if (aSource.get() && aSource->isInitialized() && aSource->size()) {
999 AttributeIntArrayPtr aDest = theDest->data()->intArray(ModelAPI_Result::ISO_LINES_ID());
1001 aDest->setSize(aSource->size());
1002 for(int a = 0; a < aSource->size(); a++)
1003 aDest->setValue(a, aSource->value(a));
1007 AttributeDoublePtr aSourceDefl = theSource->data()->real(ModelAPI_Result::DEFLECTION_ID());
1008 if (aSourceDefl.get() && aSourceDefl->isInitialized()) {
1009 AttributeDoublePtr aDestDefl = theDest->data()->real(ModelAPI_Result::DEFLECTION_ID());
1010 if (aDestDefl.get()) {
1011 aDestDefl->setValue(aSourceDefl->value());
1015 AttributeDoublePtr aSourceTransp = theSource->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
1016 if (aSourceTransp.get() && aSourceTransp->isInitialized()) {
1017 AttributeDoublePtr aDestTransp = theDest->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
1018 if (aDestTransp.get()) {
1019 aDestTransp->setValue(aSourceTransp->value());
1024 std::list<FeaturePtr> referencedFeatures(
1025 std::shared_ptr<ModelAPI_Result> theTarget, const std::string& theFeatureKind,
1026 const bool theSortResults)
1028 std::set<FeaturePtr> aResSet; // collect in the set initially to avoid duplicates
1029 std::list<ResultPtr> allSubRes;
1030 allSubRes.push_back(theTarget);
1031 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theTarget);
1033 allSubs(aBody, allSubRes);
1034 std::list<ResultPtr>::iterator aSub = allSubRes.begin();
1035 for(; aSub != allSubRes.end(); aSub++) {
1036 const std::set<AttributePtr>& aRefs = (*aSub)->data()->refsToMe();
1037 std::set<AttributePtr>::const_iterator aRef = aRefs.cbegin();
1038 for(; aRef != aRefs.cend(); aRef++) {
1039 FeaturePtr aFeat = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRef)->owner());
1040 if (aFeat.get() && (theFeatureKind.empty() || aFeat->getKind() == theFeatureKind))
1041 aResSet.insert(aFeat);
1044 // add also feature of the target that may be referenced as a whole
1045 FeaturePtr aTargetFeature = theTarget->document()->feature(theTarget);
1046 const std::set<AttributePtr>& aRefs = aTargetFeature->data()->refsToMe();
1047 std::set<AttributePtr>::const_iterator aRef = aRefs.cbegin();
1048 for(; aRef != aRefs.cend(); aRef++) {
1049 FeaturePtr aFeat = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRef)->owner());
1050 if (aFeat.get() && (theFeatureKind.empty() || aFeat->getKind() == theFeatureKind))
1051 aResSet.insert(aFeat);
1053 // check also Group-operations that may refer to groups - add them for theFeatureKind "Group"
1054 if (theFeatureKind == "Group") {
1055 std::set<FeaturePtr> aGroupOperations;
1056 for(bool aNeedIterate = true; aNeedIterate; ) {
1057 std::set<FeaturePtr>::iterator aResIter = aResSet.begin();
1058 for(; aResIter != aResSet.end(); aResIter++) {
1059 std::list<ResultPtr>::const_iterator aGroupRes = (*aResIter)->results().cbegin();
1060 for(; aGroupRes != (*aResIter)->results().cend(); aGroupRes++) {
1061 const std::set<AttributePtr>& aRefs = (*aGroupRes)->data()->refsToMe();
1062 std::set<AttributePtr>::const_iterator aRef = aRefs.cbegin();
1063 for(; aRef != aRefs.cend(); aRef++) {
1064 FeaturePtr aFeat = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRef)->owner());
1065 if (aFeat.get() && !aGroupOperations.count(aFeat) && !aFeat->results().empty() &&
1066 aFeat->firstResult()->groupName() == ModelAPI_ResultGroup::group()) {
1067 // iterate results of this group operation because it may be without theTarget shape
1068 GeomShapePtr aTargetShape = theTarget->shape();
1069 bool anIsIn = false;
1070 std::list<ResultPtr>::const_iterator anOpRes = aFeat->results().cbegin();
1071 for(; anOpRes != aFeat->results().cend() && !anIsIn; anOpRes++) {
1072 GeomShapePtr anOpShape = (*anOpRes)->shape();
1073 if (!anOpShape.get() || anOpShape->isNull())
1075 for(GeomAPI_ShapeIterator aSubIt(anOpShape); aSubIt.more(); aSubIt.next()) {
1076 if (aTargetShape->isSubShape(aSubIt.current(), false)) {
1083 aGroupOperations.insert(aFeat);
1088 // insert all new group operations into result and if they are, check for next dependencies
1089 aNeedIterate = false;
1090 std::set<FeaturePtr>::iterator aGroupOpIter = aGroupOperations.begin();
1091 for(; aGroupOpIter != aGroupOperations.end(); aGroupOpIter++) {
1092 if (aResSet.find(*aGroupOpIter) == aResSet.end()) {
1093 aResSet.insert(*aGroupOpIter);
1094 aNeedIterate = true;
1100 std::list<FeaturePtr> aResList;
1101 std::set<FeaturePtr>::iterator aResIter = aResSet.begin();
1102 for(; aResIter != aResSet.end(); aResIter++) {
1103 if (theSortResults) { // sort results by creation-order
1104 std::list<FeaturePtr>::iterator aListIter = aResList.begin();
1105 for(; aListIter != aResList.end(); aListIter++) {
1106 if ((*aResIter)->document()->isLater(*aListIter, *aResIter))
1109 if (aListIter == aResList.end()) // goes to the end
1110 aResList.push_back(*aResIter);
1112 aResList.insert(aListIter, *aResIter);
1113 } else //just push to the end unsorted
1114 aResList.push_back(*aResIter);
1120 std::string toString(const std::wstring& theWStr)
1122 #if HAVE_WORKING_WIDESTRING
1123 static std::wstring_convert<std::codecvt_utf8<wchar_t> > aConvertor;
1124 return aConvertor.to_bytes(theWStr);
1126 char* aBuf = new char[2 * (theWStr.size() + 1)];
1127 size_t aNbChars = std::wcstombs(aBuf, theWStr.c_str(), theWStr.size());
1128 if (aNbChars != (size_t)-1)
1129 aBuf[aNbChars] = '\0';
1130 std::string aStr(aBuf);
1136 /*! Converts a byte string to an extended string
1137 * \param theStr a byte string
1139 std::wstring toWString(const std::string& theStr)
1141 #if HAVE_WORKING_WIDESTRING
1142 static std::wstring_convert<std::codecvt_utf8<wchar_t> > aConvertor;
1143 return aConvertor.from_bytes(theStr);
1145 wchar_t* aBuf = new wchar_t[theStr.size()];
1146 size_t aNbWChars = std::mbstowcs(aBuf, theStr.c_str(), theStr.size());
1147 if (aNbWChars != (size_t)-1)
1148 aBuf[aNbWChars] = '\0';
1149 std::wstring aWStr(aBuf);
1157 } // namespace ModelAPI_Tools