]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelAPI/ModelAPI_Tools.h
Salome HOME
Porting to SALOME_8.2.0 : Debug visualization selection for AIS_Trihedron axes.
[modules/shaper.git] / src / ModelAPI / ModelAPI_Tools.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelAPI_Tools.h
4 // Created:     06 Aug 2014
5 // Author:      Vitaly Smetannikov
6
7 #ifndef ModelAPI_Tools_HeaderFile
8 #define ModelAPI_Tools_HeaderFile
9
10 #include "ModelAPI.h"
11
12 #include <ModelAPI_CompositeFeature.h>
13 #include <ModelAPI_Document.h>
14 #include <ModelAPI_Feature.h>
15 #include <ModelAPI_Result.h>
16 #include <ModelAPI_ResultParameter.h>
17 #include <ModelAPI_ResultCompSolid.h>
18
19 #include <GeomAPI_Shape.h>
20
21 #include <vector>
22 #include <map>
23 #include <set>
24
25 namespace ModelAPI_Tools {
26 /// Returns shape from the given Result object
27 MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);
28
29 /// Creates a container of shape of the feature results satisfied the given shape type
30 /// \param theFeature a source feature
31 /// \param theType shape type
32 /// \param an output container for shapes
33 MODELAPI_EXPORT void shapesOfType(const FeaturePtr& theFeature,
34                                   const GeomAPI_Shape::ShapeType& theType,
35                                   std::set<GeomShapePtr>& theShapes);
36
37 /*! Returns the feature error generated according to feature error and exec state
38  * \param theFeature a feature
39  * \return error value or empty string
40  */
41 MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature);
42
43 /*!
44  * Searches for variable with name \param theName in \param theDocument. 
45  * If found, set it value in the \param outValue and returns true.
46  * theSearcher must be located later in the history than the found variable.
47  */
48 MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,
49   const std::string& theName, double& outValue, ResultParameterPtr& theParam);
50
51 /*!
52  * Searches for variable with name \param theName in the active document (Part), when
53  * in the root document (PartSet). If found, set it value in the \param outValue
54  * and returns true. If \param theDocument is empty active document is used.
55  * theSearcher must be located later in the history than the found variable.
56  */
57 MODELAPI_EXPORT bool findVariable(FeaturePtr theSearcher, const std::string& theName,
58   double& outValue, ResultParameterPtr& theParam,
59   const DocumentPtr& theDocument = DocumentPtr());
60
61 /*!
62  * Searches for Part result that contains the reference to the given document.
63  * The result must be presented in the tree.
64  * \param theMain document that contains the searched feature
65  * \param theSub document that is searched, the resulting feature references to it
66  * \returns null if not found
67  */
68 MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);
69
70 /*!
71  * Searches for Part the feature that contains in result the reference to the given document.
72  * The result may be disabled.
73  * \param theMain document that contains the searched feature
74  * \param theSub document that is searched, the resulting feature references to it
75  * \returns null if not found
76  */
77 MODELAPI_EXPORT FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub);
78
79 /*!
80  * Returns the composite feature - parent of this feature.
81  * \param theFeature the sub-element of composite
82  * \returns null if it is not sub-element of composite
83  */
84 MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature);
85
86 /*!
87  * Returns the compsolid result - parent of this result.
88  * \param theSub the sub-element of comp-solid
89  * \returns null if it is not sub-element of composite
90  */
91 MODELAPI_EXPORT ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub);
92
93 /*!
94 * Returns true if the result contains a not empty list of sub results. It processes result compsolid.
95 * \param theResult a result object
96 * \returns boolean value
97 */
98 MODELAPI_EXPORT bool hasSubResults(const ResultPtr& theResult);
99
100 /*!
101 * Adds the results of the given feature to theResults list: including disabled and sub-results
102 */
103 MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults);
104
105 /*!
106  Returns true if there are no parts in the document, which are not activated
107  \param theNotActivatedNames out string which contains not activated names
108  \return a boolean value
109  */
110 MODELAPI_EXPORT bool allDocumentsActivated(std::string& theNotActivatedNames);
111
112
113 /*! Removes features from the document
114 * \param theFeatures a list of features to be removed
115 * \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
116 * \return true if at least one feature is removed
117 */
118 MODELAPI_EXPORT bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,
119                                                  const bool theFlushRedisplay = false,
120                                                  const bool theUseComposite = false,
121                                                  const bool theUseRecursion = true);
122
123 /*! Removes features from the document
124 * \param theFeatures a list of features to be removed
125 * \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
126 * \return true if at least one feature is removed
127 */
128 MODELAPI_EXPORT bool removeFeatures(const std::set<FeaturePtr>& theFeatures,
129                                     const bool theFlushRedisplay);
130
131 /*! Build a map of references for the given set of features
132 * \param theFeatures a list of features
133 * \param theReferences a map of all references to the features
134 * \param theUseComposite state if the composite features of the reference should be in the map
135 * \param theUseRecursion state if references for features out of the sources feature
136          list are put into the result container. E.g. if theFeatures contains "Sketch_2", map will
137          contain references to this feature also.
138 */
139 MODELAPI_EXPORT void findAllReferences(const std::set<FeaturePtr>& theFeatures,
140                                        std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
141                                        const bool theUseComposite = true,
142                                        const bool theUseRecursion = true);
143
144 /*! In the map of references find all features referenced to the source feature
145 * \param theFeatures a list of features to find references
146 * \param theReferences a map of all references to the features
147 * \param theFeaturesRefsTo an out list of referenced features
148 */
149 MODELAPI_EXPORT void findRefsToFeatures(const std::set<FeaturePtr>& aFeatures,
150                                 const std::map<FeaturePtr, std::set<FeaturePtr> >& aReferences,
151                                 std::set<FeaturePtr>& aFeaturesRefsTo);
152
153 /*! Finds referenced of the feature to objects and collects concealed results.
154 * \param theFeatures a model feature
155 * \param theResults container for concealed results. It has no duplications
156 */
157 MODELAPI_EXPORT void getConcealedResults(const FeaturePtr& theFeature,
158                                          std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
159 }
160
161 #endif