Add tools

[modules/shaper.git] / src / ModelAPI / ModelAPI_Tools.h

diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h
old mode 100644 (file)
new mode 100755 (executable)
index f14029a..e404948
--- a/src/ModelAPI/ModelAPI_Tools.h
+++ b/src/ModelAPI/ModelAPI_Tools.h
@@ -14,6 +14,7 @@
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_Result.h>
 #include <ModelAPI_ResultParameter.h>
+#include <ModelAPI_ResultCompSolid.h>
 
 #include <GeomAPI_Shape.h>
 
@@ -24,19 +25,19 @@ namespace ModelAPI_Tools {
 MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);
 
 /*!
- * Searches for variable with name \param theName in the active document (Part), when
- * in the root document (PartSet). If found, set it value in the \param outValue
- * and returns true.
+ * Searches for variable with name \param theName in \param theDocument. 
+ * If found, set it value in the \param outValue and returns true.
  */
-MODELAPI_EXPORT bool findVariable(const std::string& theName, double& outValue, 
-  ResultParameterPtr& theParam);
+MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, 
+                                  const std::string& theName, double& outValue, ResultParameterPtr& theParam);
 
 /*!
- * Searches for variable with name \param theName in the document. 
- * If found, set it value in the \param outValue and returns true.
+ * Searches for variable with name \param theName in the active document (Part), when
+ * in the root document (PartSet). If found, set it value in the \param outValue
+ * and returns true. If \param theDocument is empty active document is used.
  */
-MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, const std::string& theName, 
-                                  double& outValue, ResultParameterPtr& theParam);
+MODELAPI_EXPORT bool findVariable(const std::string& theName, double& outValue, ResultParameterPtr& theParam,
+                                  const DocumentPtr& theDocument = DocumentPtr());
 
 /*!
  * Returns the values of the next random color. The values are in range [0, 255]
@@ -59,6 +60,20 @@ MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const Docum
  */
 MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& 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);
+
+/*!
+* 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);
+
 }
 
 #endif