]> SALOME platform Git repositories - modules/shaper.git/blobdiff - src/ModelAPI/ModelAPI_Tools.h
Salome HOME
#2027 Sketcher Trim Feature: 1. preview/selected attributes in trim; 2. avoid includi...
[modules/shaper.git] / src / ModelAPI / ModelAPI_Tools.h
index 573ee12a3849096d4a3023aff69fc3819e0c9d92..1bf2e2a4e235122e37685d2084afa7bb3c6c3dfd 100755 (executable)
@@ -9,44 +9,40 @@
 
 #include "ModelAPI.h"
 
-#include <ModelAPI_CompositeFeature.h>
-#include <ModelAPI_Document.h>
-#include <ModelAPI_Feature.h>
-#include <ModelAPI_Result.h>
-#include <ModelAPI_ResultParameter.h>
-#include <ModelAPI_ResultCompSolid.h>
+class ModelAPI_CompositeFeature;
+class ModelAPI_Document;
+class ModelAPI_Feature;
+class ModelAPI_Result;
+class ModelAPI_ResultParameter;
+class ModelAPI_ResultCompSolid;
 
-#include <GeomAPI_Shape.h>
+class GeomAPI_Shape;
 
 #include <vector>
 #include <map>
 #include <set>
+#include <list>
 
 namespace ModelAPI_Tools {
 /// Returns shape from the given Result object
-MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);
-
-/// Creates a container of shape of the feature results satisfied the given shape type
-/// \param theFeature a source feature
-/// \param theType shape type
-/// \param an output container for result of shapes
-MODELAPI_EXPORT void shapesOfType(const FeaturePtr& theFeature,
-                                  const GeomAPI_Shape::ShapeType& theType,
-                                  std::set<ResultPtr>& theShapeResults);
+MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(
+                                   const std::shared_ptr<ModelAPI_Result>& theResult);
 
 /*! Returns the feature error generated according to feature error and exec state
  * \param theFeature a feature
  * \return error value or empty string
  */
-MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature);
+MODELAPI_EXPORT std::string getFeatureError(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
 /*!
  * Searches for variable with name \param theName in \param theDocument. 
  * If found, set it value in the \param outValue and returns true.
  * theSearcher must be located later in the history than the found variable.
  */
-MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,
-  const std::string& theName, double& outValue, ResultParameterPtr& theParam);
+MODELAPI_EXPORT bool findVariable(const std::shared_ptr<ModelAPI_Document>& theDocument,
+                                  std::shared_ptr<ModelAPI_Feature> theSearcher,
+                                  const std::string& theName, double& outValue,
+                                  std::shared_ptr<ModelAPI_ResultParameter>& theParam);
 
 /*!
  * Searches for variable with name \param theName in the active document (Part), when
@@ -54,9 +50,10 @@ MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, FeaturePtr the
  * and returns true. If \param theDocument is empty active document is used.
  * theSearcher must be located later in the history than the found variable.
  */
-MODELAPI_EXPORT bool findVariable(FeaturePtr theSearcher, const std::string& theName,
-  double& outValue, ResultParameterPtr& theParam,
-  const DocumentPtr& theDocument = DocumentPtr());
+MODELAPI_EXPORT bool findVariable(std::shared_ptr<ModelAPI_Feature> theSearcher,
+  const std::string& theName,
+  double& outValue, std::shared_ptr<ModelAPI_ResultParameter>& theParam,
+  const std::shared_ptr<ModelAPI_Document>& theDocument = std::shared_ptr<ModelAPI_Document>());
 
 /*!
  * Searches for Part result that contains the reference to the given document.
@@ -65,7 +62,9 @@ MODELAPI_EXPORT bool findVariable(FeaturePtr theSearcher, const std::string& the
  * \param theSub document that is searched, the resulting feature references to it
  * \returns null if not found
  */
-MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);
+MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> findPartResult(
+                                              const std::shared_ptr<ModelAPI_Document>& theMain,
+                                              const std::shared_ptr<ModelAPI_Document>& theSub);
 
 /*!
  * Searches for Part the feature that contains in result the reference to the given document.
@@ -74,33 +73,39 @@ MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const Docum
  * \param theSub document that is searched, the resulting feature references to it
  * \returns null if not found
  */
-MODELAPI_EXPORT FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub);
+MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> findPartFeature(
+                                           const std::shared_ptr<ModelAPI_Document>& theMain,
+                                           const std::shared_ptr<ModelAPI_Document>& theSub);
 
 /*!
  * Returns the composite feature - parent of this feature.
  * \param theFeature the sub-element of composite
  * \returns null if it is not sub-element of composite
  */
-MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature);
+MODELAPI_EXPORT std::shared_ptr<ModelAPI_CompositeFeature> compositeOwner(
+                                        const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
 /*!
  * Returns the compsolid result - parent of this result.
  * \param theSub the sub-element of comp-solid
  * \returns null if it is not sub-element of composite
  */
-MODELAPI_EXPORT ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub);
+MODELAPI_EXPORT std::shared_ptr<ModelAPI_ResultCompSolid> compSolidOwner(
+                                            const std::shared_ptr<ModelAPI_Result>& theSub);
 
 /*!
-* Returns true if the result contains a not empty list of sub results. It processes result compsolid.
+* Returns true if the result contains a not empty list of sub results.
+* It processes result compsolid.
 * \param theResult a result object
 * \returns boolean value
 */
-MODELAPI_EXPORT bool hasSubResults(const ResultPtr& theResult);
+MODELAPI_EXPORT bool hasSubResults(const std::shared_ptr<ModelAPI_Result>& theResult);
 
 /*!
 * Adds the results of the given feature to theResults list: including disabled and sub-results
 */
-MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults);
+MODELAPI_EXPORT void allResults(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                                std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
 
 /*!
  Returns true if there are no parts in the document, which are not activated
@@ -109,13 +114,13 @@ MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPt
  */
 MODELAPI_EXPORT bool allDocumentsActivated(std::string& theNotActivatedNames);
 
-
 /*! Removes features from the document
 * \param theFeatures a list of features to be removed
 * \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
 * \return true if at least one feature is removed
 */
-MODELAPI_EXPORT bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,
+MODELAPI_EXPORT bool removeFeaturesAndReferences(
+                       const std::set<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
                                                  const bool theFlushRedisplay = false,
                                                  const bool theUseComposite = false,
                                                  const bool theUseRecursion = true);
@@ -125,8 +130,9 @@ MODELAPI_EXPORT bool removeFeaturesAndReferences(const std::set<FeaturePtr>& the
 * \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
 * \return true if at least one feature is removed
 */
-MODELAPI_EXPORT bool removeFeatures(const std::set<FeaturePtr>& theFeatures,
-                                    const bool theFlushRedisplay);
+MODELAPI_EXPORT bool removeFeatures(
+                            const std::set<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
+                            const bool theFlushRedisplay);
 
 /*! Build a map of references for the given set of features
 * \param theFeatures a list of features
@@ -136,26 +142,30 @@ MODELAPI_EXPORT bool removeFeatures(const std::set<FeaturePtr>& theFeatures,
          list are put into the result container. E.g. if theFeatures contains "Sketch_2", map will
          contain references to this feature also.
 */
-MODELAPI_EXPORT void findAllReferences(const std::set<FeaturePtr>& theFeatures,
-                                       std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
-                                       const bool theUseComposite = true,
-                                       const bool theUseRecursion = true);
+MODELAPI_EXPORT void findAllReferences(
+  const std::set<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
+  std::map<std::shared_ptr<ModelAPI_Feature>,
+  std::set<std::shared_ptr<ModelAPI_Feature> > >& theReferences,
+  const bool theUseComposite = true,
+  const bool theUseRecursion = true);
 
 /*! In the map of references find all features referenced to the source feature
 * \param theFeatures a list of features to find references
 * \param theReferences a map of all references to the features
 * \param theFeaturesRefsTo an out list of referenced features
 */
-MODELAPI_EXPORT void findRefsToFeatures(const std::set<FeaturePtr>& aFeatures,
-                                const std::map<FeaturePtr, std::set<FeaturePtr> >& aReferences,
-                                std::set<FeaturePtr>& aFeaturesRefsTo);
+MODELAPI_EXPORT void findRefsToFeatures(
+  const std::set<std::shared_ptr<ModelAPI_Feature> >& aFeatures,
+  const std::map<std::shared_ptr<ModelAPI_Feature>,
+                 std::set<std::shared_ptr<ModelAPI_Feature> > >& aReferences,
+  std::set<std::shared_ptr<ModelAPI_Feature> >& aFeaturesRefsTo);
 
 /*! Finds referenced of the feature to objects and collects concealed results.
 * \param theFeatures a model feature
 * \param theResults container for concealed results. It has no duplications
 */
-MODELAPI_EXPORT void getConcealedResults(const FeaturePtr& theFeature,
-                                         std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
+MODELAPI_EXPORT void getConcealedResults(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                                   std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
 }
 
 #endif