Naming functions were from FeaturesPlugin_Tools to ModelAPI_Tools

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

diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h
index 96e024985ca9fa63e9eeea2c470c474f48c57594..29f6554845cfe8a9b6bda6dea97a4756d95992d2 100644 (file)
--- a/src/ModelAPI/ModelAPI_Tools.h
+++ b/src/ModelAPI/ModelAPI_Tools.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2021  CEA/DEN, EDF R&D
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -29,7 +29,9 @@ class ModelAPI_Result;
 class ModelAPI_ResultParameter;
 class ModelAPI_ResultBody;
 
+class GeomAlgoAPI_MakeShape;
 class GeomAPI_Shape;
+class GeomAPI_ShapeHierarchy;
 
 #include <memory>
 #include <vector>
@@ -48,14 +50,43 @@ MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(
  */
 MODELAPI_EXPORT std::string getFeatureError(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
+MODELAPI_EXPORT struct ResultBaseAlgo {
+  std::shared_ptr<ModelAPI_ResultBody> resultBody;
+  std::shared_ptr<GeomAPI_Shape> baseShape;
+  std::shared_ptr<GeomAlgoAPI_MakeShape> makeShape;
+};
+
+MODELAPI_EXPORT void loadModifiedShapes(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
+  const std::list<std::shared_ptr<GeomAPI_Shape>>& theBaseShapes,
+  const std::list<std::shared_ptr<GeomAPI_Shape>>& theTools,
+  const std::shared_ptr<GeomAlgoAPI_MakeShape>& theMakeShape,
+  const std::shared_ptr<GeomAPI_Shape> theResultShape,
+  const std::string& theNamePrefix = "");
+
+MODELAPI_EXPORT void loadModifiedShapes(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
+  const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
+  const std::shared_ptr<GeomAlgoAPI_MakeShape>& theMakeShape,
+  const std::string theName);
+/// Stores deleted shapes.
+MODELAPI_EXPORT void loadDeletedShapes(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
+  const std::shared_ptr<GeomAPI_Shape> theBaseShape,
+  const std::list<std::shared_ptr<GeomAPI_Shape>>& theTools,
+  const std::shared_ptr<GeomAlgoAPI_MakeShape>& theMakeShape,
+  const std::shared_ptr<GeomAPI_Shape> theResultShapesCompound);
+
+/// Stores deleted shapes.
+MODELAPI_EXPORT void loadDeletedShapes(std::vector<ResultBaseAlgo>& theResultBaseAlgoList,
+  const std::list<std::shared_ptr<GeomAPI_Shape>>& theTools,
+  const std::shared_ptr<GeomAPI_Shape> theResultShapesCompound);
+
 /*!
- * Searches for variable with name \param theName in \param theDocument. 
+ * 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 std::shared_ptr<ModelAPI_Document>& theDocument,
                                   std::shared_ptr<ModelAPI_Feature> theSearcher,
-                                  const std::string& theName, double& outValue,
+                                  const std::wstring& theName, double& outValue,
                                   std::shared_ptr<ModelAPI_ResultParameter>& theParam);
 
 /*!
@@ -65,7 +96,7 @@ MODELAPI_EXPORT bool findVariable(const std::shared_ptr<ModelAPI_Document>& theD
  * theSearcher must be located later in the history than the found variable.
  */
 MODELAPI_EXPORT bool findVariable(std::shared_ptr<ModelAPI_Feature> theSearcher,
-  const std::string& theName,
+  const std::wstring& theName,
   double& outValue, std::shared_ptr<ModelAPI_ResultParameter>& theParam,
   const std::shared_ptr<ModelAPI_Document>& theDocument = std::shared_ptr<ModelAPI_Document>());
 
@@ -139,7 +170,7 @@ MODELAPI_EXPORT void allResults(const std::shared_ptr<ModelAPI_Feature>& theFeat
  \param theNotActivatedNames out string which contains not activated names
  \return a boolean value
  */
-MODELAPI_EXPORT bool allDocumentsActivated(std::string& theNotActivatedNames);
+MODELAPI_EXPORT bool allDocumentsActivated(std::wstring& theNotActivatedNames);
 
 /*! Removes features from the document
 * \param theFeatures a list of features to be removed
@@ -197,15 +228,28 @@ MODELAPI_EXPORT void getConcealedResults(const std::shared_ptr<ModelAPI_Feature>
 /*! Return the default name of the result according the features it depends or name of the feature.
  *  Return also whether the name is get from the concealing result of parent object
  *  (means that concealing result has user-defined name).
+ * \param[in] theRecursive  recursively check the concealed results if they have user-defined names
  */
-MODELAPI_EXPORT std::pair<std::string, bool> getDefaultName(
-  const std::shared_ptr<ModelAPI_Result>& theResult, const bool theInherited = true);
+MODELAPI_EXPORT std::pair<std::wstring, bool> getDefaultName(
+  const std::shared_ptr<ModelAPI_Result>& theResult,
+  const bool theInherited = true,
+  const bool theRecursive = false);
 
 /*! Collect all parents for the given feature, including the Part
  */
 MODELAPI_EXPORT std::set<std::shared_ptr<ModelAPI_Feature> >
     getParents(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
+/*! Store shape and its parent shape to the hierarchy data structure
+ *  \param[in] theShape      the shape to store
+ *  \param[in] theContext    the result (parent shape) for the given shape
+ *  \param[out] theHierarchy container for shape hierarchy
+ */
+MODELAPI_EXPORT void fillShapeHierarchy(
+    const std::shared_ptr<GeomAPI_Shape>& theShape,
+    const std::shared_ptr<ModelAPI_Result>& theContext,
+    GeomAPI_ShapeHierarchy& theHierarchy);
+
 /*! Creates a remove result features with the given results
 */
 MODELAPI_EXPORT void removeResults(const std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
@@ -289,6 +333,15 @@ MODELAPI_EXPORT std::list<std::shared_ptr<ModelAPI_Feature> > referencedFeatures
   std::shared_ptr<ModelAPI_Result> theTarget, const std::string& theFeatureKind,
   const bool theSortResults);
 
+
+/*! Returns a container with the current color value.
+*   These are tree int values for RGB definition.
+*   It returns the next random color.
+* \param theValues vector of values
+* \param theReset flag to call when disabling Auto-color
+*/
+MODELAPI_EXPORT void findRandomColor(std::vector<int>& theValues, bool theReset = false);
+
 }
 
 #endif