-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
-\r
-// File: ModelAPI_Tools.h\r
-// Created: 06 Aug 2014\r
-// Author: Vitaly Smetannikov\r
-\r
-#ifndef ModelAPI_Tools_HeaderFile\r
-#define ModelAPI_Tools_HeaderFile\r
-\r
-#include "ModelAPI.h"\r
-\r
-#include <ModelAPI_CompositeFeature.h>\r
-#include <ModelAPI_Document.h>\r
-#include <ModelAPI_Feature.h>\r
-#include <ModelAPI_Result.h>\r
-#include <ModelAPI_ResultParameter.h>\r
-#include <ModelAPI_ResultCompSolid.h>\r
-\r
-#include <GeomAPI_Shape.h>\r
-\r
-#include <vector>\r
-#include <map>\r
-#include <set>\r
-\r
-namespace ModelAPI_Tools {\r
-/// Returns shape from the given Result object\r
-MODELAPI_EXPORT std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult);\r
-\r
-/// Creates a container of shape of the feature results satisfied the given shape type\r
-/// \param theFeature a source feature\r
-/// \param theType shape type\r
-/// \param an output container for shapes\r
-MODELAPI_EXPORT void shapesOfType(const FeaturePtr& theFeature,\r
- const GeomAPI_Shape::ShapeType& theType,\r
- std::set<GeomShapePtr>& theShapes);\r
-\r
-/*! Returns the feature error generated according to feature error and exec state\r
- * \param theFeature a feature\r
- * \return error value or empty string\r
- */\r
-MODELAPI_EXPORT std::string getFeatureError(const FeaturePtr& theFeature);\r
-\r
-/*!\r
- * Searches for variable with name \param theName in \param theDocument. \r
- * If found, set it value in the \param outValue and returns true.\r
- * theSearcher must be located later in the history than the found variable.\r
- */\r
-MODELAPI_EXPORT bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,\r
- const std::string& theName, double& outValue, ResultParameterPtr& theParam);\r
-\r
-/*!\r
- * Searches for variable with name \param theName in the active document (Part), when\r
- * in the root document (PartSet). If found, set it value in the \param outValue\r
- * and returns true. If \param theDocument is empty active document is used.\r
- * theSearcher must be located later in the history than the found variable.\r
- */\r
-MODELAPI_EXPORT bool findVariable(FeaturePtr theSearcher, const std::string& theName,\r
- double& outValue, ResultParameterPtr& theParam,\r
- const DocumentPtr& theDocument = DocumentPtr());\r
-\r
-/*!\r
- * Returns the values of the next random color. The values are in range [0, 255]\r
- * \param theValues a container of component of RGB value: red, green, blue\r
- */\r
-MODELAPI_EXPORT void findRandomColor(std::vector<int>& theValues);\r
-\r
-/*!\r
- * Searches for Part result that contains the reference to the given document.\r
- * The result must be presented in the tree.\r
- * \param theMain document that contains the searched feature\r
- * \param theSub document that is searched, the resulting feature references to it\r
- * \returns null if not found\r
- */\r
-MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub);\r
-\r
-/*!\r
- * Searches for Part the feature that contains in result the reference to the given document.\r
- * The result may be disabled.\r
- * \param theMain document that contains the searched feature\r
- * \param theSub document that is searched, the resulting feature references to it\r
- * \returns null if not found\r
- */\r
-MODELAPI_EXPORT FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub);\r
-\r
-/*!\r
- * Returns the composite feature - parent of this feature.\r
- * \param theFeature the sub-element of composite\r
- * \returns null if it is not sub-element of composite\r
- */\r
-MODELAPI_EXPORT CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature);\r
-\r
-/*!\r
- * Returns the compsolid result - parent of this result.\r
- * \param theSub the sub-element of comp-solid\r
- * \returns null if it is not sub-element of composite\r
- */\r
-MODELAPI_EXPORT ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub);\r
-\r
-/*!\r
-* Returns true if the result contains a not empty list of sub results. It processes result compsolid.\r
-* \param theResult a result object\r
-* \returns boolean value\r
-*/\r
-MODELAPI_EXPORT bool hasSubResults(const ResultPtr& theResult);\r
-\r
-/*!\r
-* Adds the results of the given feature to theResults list: including disabled and sub-results\r
-*/\r
-MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults);\r
-\r
-/*!\r
- Returns true if there are no parts in the document, which are not activated\r
- \param theNotActivatedNames out string which contains not activated names\r
- \return a boolean value\r
- */\r
-MODELAPI_EXPORT bool allDocumentsActivated(std::string& theNotActivatedNames);\r
-\r
-\r
-/*! Removes features from the document\r
-* \param theFeatures a list of features to be removed\r
-* \param theFlushRedisplay a boolean value if the redisplay signal should be flushed\r
-* \return true if at least one feature is removed\r
-*/\r
-MODELAPI_EXPORT bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,\r
- const bool theFlushRedisplay = false,\r
- const bool theUseComposite = false,\r
- const bool theUseRecursion = true);\r
-\r
-/*! Removes features from the document\r
-* \param theFeatures a list of features to be removed\r
-* \param theFlushRedisplay a boolean value if the redisplay signal should be flushed\r
-* \return true if at least one feature is removed\r
-*/\r
-MODELAPI_EXPORT bool removeFeatures(const std::set<FeaturePtr>& theFeatures,\r
- const bool theFlushRedisplay);\r
-\r
-/*! Build a map of references for the given set of features\r
-* \param theFeatures a list of features\r
-* \param theReferences a map of all references to the features\r
-* \param theUseComposite state if the composite features of the reference should be in the map\r
-* \param theUseRecursion state if references for features out of the sources feature\r
- list are put into the result container. E.g. if theFeatures contains "Sketch_2", map will\r
- contain references to this feature also.\r
-*/\r
-MODELAPI_EXPORT void findAllReferences(const std::set<FeaturePtr>& theFeatures,\r
- std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,\r
- const bool theUseComposite = true,\r
- const bool theUseRecursion = true);\r
-\r
-/*! In the map of references find all features referenced to the source feature\r
-* \param theFeatures a list of features to find references\r
-* \param theReferences a map of all references to the features\r
-* \param theFeaturesRefsTo an out list of referenced features\r
-*/\r
-MODELAPI_EXPORT void findRefsToFeatures(const std::set<FeaturePtr>& aFeatures,\r
- const std::map<FeaturePtr, std::set<FeaturePtr> >& aReferences,\r
- std::set<FeaturePtr>& aFeaturesRefsTo);\r
-\r
-/*! Finds referenced of the feature to objects and collects concealed results.\r
-* \param theFeatures a model feature\r
-* \param theResults container for concealed results. It has no duplications\r
-*/\r
-MODELAPI_EXPORT void getConcealedResults(const FeaturePtr& theFeature,\r
- std::list<std::shared_ptr<ModelAPI_Result> >& theResults);\r
-}\r
-\r
-#endif\r
+// 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
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+#ifndef ModelAPI_Tools_HeaderFile
+#define ModelAPI_Tools_HeaderFile
+
+#include "ModelAPI.h"
+
+class ModelAPI_CompositeFeature;
+class ModelAPI_Document;
+class ModelAPI_Feature;
+class ModelAPI_Result;
+class ModelAPI_ResultParameter;
+class ModelAPI_ResultBody;
+
+class GeomAPI_Shape;
+class GeomAPI_ShapeHierarchy;
+
+#include <memory>
+#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 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 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 std::shared_ptr<ModelAPI_Document>& theDocument,
+ std::shared_ptr<ModelAPI_Feature> theSearcher,
+ const std::wstring& theName, double& outValue,
+ std::shared_ptr<ModelAPI_ResultParameter>& theParam);
+
+/*!
+ * 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.
+ * theSearcher must be located later in the history than the found variable.
+ */
+MODELAPI_EXPORT bool findVariable(std::shared_ptr<ModelAPI_Feature> theSearcher,
+ const std::wstring& 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.
+ * The result must be presented in the tree.
+ * \param theMain document that contains the searched feature
+ * \param theSub document that is searched, the resulting feature references to it
+ * \returns null if not found
+ */
+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.
+ * The result may be disabled.
+ * \param theMain document that contains the searched feature
+ * \param theSub document that is searched, the resulting feature references to it
+ * \returns null if not found
+ */
+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 std::shared_ptr<ModelAPI_CompositeFeature> compositeOwner(
+ const std::shared_ptr<ModelAPI_Feature>& theFeature);
+
+/*!
+ * Returns the result - parent of this result.
+ * \param theSub the sub-element of composit result
+ * \param theRoot if it is true, returns the root father
+ * \returns null if it is not sub-element of composite
+ */
+MODELAPI_EXPORT std::shared_ptr<ModelAPI_ResultBody>
+ bodyOwner(const std::shared_ptr<ModelAPI_Result>& theSub, const bool theRoot = false);
+/*!
+ * Returns index of this result in parent (if parent exists, returned by bodyOwner)
+ * \returns zero-base index, or -1 if not found
+ */
+MODELAPI_EXPORT int bodyIndex(const std::shared_ptr<ModelAPI_Result>& 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 std::shared_ptr<ModelAPI_Result>& theResult);
+
+/*!
+* collects recursively all subs of the given result
+*/
+MODELAPI_EXPORT void allSubs(const std::shared_ptr<ModelAPI_ResultBody>& theResult,
+ std::list<std::shared_ptr<ModelAPI_Result> >& theResults,
+ const bool theLowerOnly = false);
+
+/*!
+* Adds the results of the given feature to theResults list: including disabled and sub-results
+*/
+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
+ \param theNotActivatedNames out string which contains not activated names
+ \return a boolean value
+ */
+MODELAPI_EXPORT bool allDocumentsActivated(std::wstring& 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<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
+ const bool theFlushRedisplay = false,
+ const bool theUseComposite = false,
+ const bool theUseRecursion = true);
+
+/*! 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 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
+* \param theReferences a map of all references to the features
+* \param theUseComposite state if the composite features of the reference should be in the map
+* \param theUseRecursion state if references for features out of the sources feature
+ 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<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<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 std::shared_ptr<ModelAPI_Feature>& theFeature,
+ std::list<std::shared_ptr<ModelAPI_Result> >& theResults);
+
+/*! 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::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);
+
+/*! Returns current deflection in the given result
+* \param theResult a result object
+* \return a deflection value or -1 if it was not defined
+*/
+MODELAPI_EXPORT double getDeflection(const std::shared_ptr<ModelAPI_Result>& theResult);
+
+/*! Sets the deflection value
+* \param theResult a result object
+* \param a deflection value
+*/
+MODELAPI_EXPORT void setDeflection(std::shared_ptr<ModelAPI_Result> theResult,
+ const double theDeflection);
+
+/*! Returns current color of the current result
+* \param[in] theResult a result object
+* \param[out] theColor a color values if it is defined
+*/
+MODELAPI_EXPORT void getColor(const std::shared_ptr<ModelAPI_Result>& theResult,
+ std::vector<int>& theColor);
+
+/*! Set color of the result
+* \param[in] theResult a result object
+* \param[in] theColor a color values
+*/
+MODELAPI_EXPORT void setColor(std::shared_ptr<ModelAPI_Result> theResult,
+ const std::vector<int>& theColor);
+
+/*! Returns number of iso-lines of the current result
+* \param[in] theResult a result object
+* \param[out] theNbLines values of iso-lines
+*/
+MODELAPI_EXPORT void getIsoLines(const std::shared_ptr<ModelAPI_Result>& theResult,
+ bool& isVisible, std::vector<int>& theNbLines);
+
+/*! Set number of iso-lines of the result
+* \param[in] theResult a result object
+* \param[in] theIso nb iso-lines
+*/
+MODELAPI_EXPORT void setIsoLines(std::shared_ptr<ModelAPI_Result> theResult,
+ const std::vector<int>& theIso);
+
+/*! Set visibility of Iso lines
+* \param[in] theResult a result object
+* \param[in] theShow is a visibility flag
+*/
+MODELAPI_EXPORT void showIsoLines(std::shared_ptr<ModelAPI_Result> theResult, bool theShow);
+
+MODELAPI_EXPORT bool isShownIsoLines(std::shared_ptr<ModelAPI_Result> theResult);
+
+/*! Returns current transparency in the given result
+* \param theResult a result object
+* \return a transparency value or -1 if it was not defined
+*/
+MODELAPI_EXPORT double getTransparency(const std::shared_ptr<ModelAPI_Result>& theResult);
+
+/*! Set transparency for the given result
+* \param theResult a result object
+* \param a transparency value
+*/
+MODELAPI_EXPORT void setTransparency(std::shared_ptr<ModelAPI_Result> theResult,
+ double theTransparency);
+
+
+/*! Copies all visualization attributes from one result to another.
+* \param theSource a result that contains the copied attributes
+* \param theDest a destination result that takes the visualization attributes
+*/
+MODELAPI_EXPORT void copyVisualizationAttrs(std::shared_ptr<ModelAPI_Result> theSource,
+ std::shared_ptr<ModelAPI_Result> theDest);
+
+/*! Copies image attribute from one result to another.
+* \param theSource a result that contains the image data
+* \param theDest a destination result that takes the image data
+*/
+MODELAPI_EXPORT void copyImageAttribute(std::shared_ptr<ModelAPI_Result> theSource,
+ std::shared_ptr<ModelAPI_Result> theDest);
+
+/*! Produces list of features that reference to the given target (directly or through sub-results)
+* \param theTarget the referenced result
+* \param theFeatureKind the resulting features filter: the feature kind or all for the empty string
+* \param theSortResults to sort the resulting list of features by the features creation order
+*/
+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
