Object Browser tree needed method implementation

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

diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h
index b99b9f87ed738955135c523b752f5d88b3422985..97b93c9d569c3bc479930c84d90125780f80b0d8 100644 (file)
--- a/src/ModelAPI/ModelAPI_Tools.h
+++ b/src/ModelAPI/ModelAPI_Tools.h
@@ -8,12 +8,15 @@
 #define ModelAPI_Tools_HeaderFile
 
 #include "ModelAPI.h"
-#include <ModelAPI_Result.h>
-#include <ModelAPI_ResultParameter.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>
+
 #include <GeomAPI_Shape.h>
-#include <ModelAPI_CompositeFeature.h>
 
 #include <vector>
 
@@ -22,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]
@@ -46,17 +49,24 @@ MODELAPI_EXPORT void findRandomColor(std::vector<int>& theValues);
  * Searches for Part result that contains the reference to the given document.
  * \param theMain document that contains the searched feature
  * \param theSub document that is searched, the resulting feature references to it
- * \returns numm if not found
+ * \returns null if not found
  */
 MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);
 
 /*!
- * Returns the cpomposite feature - parent of this feature.
+ * 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);
 
+/*!
+ * 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);
+
 }
 
 #endif