X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Tools.h;h=0b21a3c2eace9a55a4c442259fd127a57fee550e;hb=d2034a988bc73596aab1bb256ddb02ce9ad2bd5a;hp=00f6cd4fd570611ac0d997cd911bbdf913e5a273;hpb=58ed04fa9426f8dd99fcf76a1f3ef9e60c5f3b9b;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h index 00f6cd4fd..0b21a3c2e 100755 --- a/src/ModelAPI/ModelAPI_Tools.h +++ b/src/ModelAPI/ModelAPI_Tools.h @@ -1,44 +1,63 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_Tools.h -// Created: 06 Aug 2014 -// Author: Vitaly Smetannikov +// Copyright (C) 2014-2017 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" -#include -#include -#include -#include -#include -#include +class ModelAPI_CompositeFeature; +class ModelAPI_Document; +class ModelAPI_Feature; +class ModelAPI_Result; +class ModelAPI_ResultParameter; +class ModelAPI_ResultBody; -#include +class GeomAPI_Shape; +#include #include #include #include +#include namespace ModelAPI_Tools { /// Returns shape from the given Result object -MODELAPI_EXPORT std::shared_ptr shape(const ResultPtr& theResult); +MODELAPI_EXPORT std::shared_ptr shape( + const std::shared_ptr& 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& 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& theDocument, + std::shared_ptr theSearcher, + const std::string& theName, double& outValue, + std::shared_ptr& theParam); /*! * Searches for variable with name \param theName in the active document (Part), when @@ -46,15 +65,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()); - -/*! - * Returns the values of the next random color. The values are in range [0, 255] - * \param theValues a container of component of RGB value: red, green, blue - */ -MODELAPI_EXPORT void findRandomColor(std::vector& theValues); +MODELAPI_EXPORT bool findVariable(std::shared_ptr theSearcher, + const std::string& theName, + double& outValue, std::shared_ptr& theParam, + const std::shared_ptr& theDocument = std::shared_ptr()); /*! * Searches for Part result that contains the reference to the given document. @@ -63,7 +77,9 @@ MODELAPI_EXPORT void findRandomColor(std::vector& theValues); * \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 findPartResult( + const std::shared_ptr& theMain, + const std::shared_ptr& theSub); /*! * Searches for Part the feature that contains in result the reference to the given document. @@ -72,33 +88,51 @@ 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 findPartFeature( + const std::shared_ptr& theMain, + const std::shared_ptr& 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 compositeOwner( + const std::shared_ptr& theFeature); /*! - * Returns the compsolid result - parent of this result. - * \param theSub the sub-element of comp-solid + * 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 ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub); +MODELAPI_EXPORT std::shared_ptr + bodyOwner(const std::shared_ptr& 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& 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& theResult); + +/*! +* collects recursively all subs of the given result +*/ +MODELAPI_EXPORT void allSubs(const std::shared_ptr& theResult, + std::list >& theResults); /*! * Adds the results of the given feature to theResults list: including disabled and sub-results */ -MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list& theResults); +MODELAPI_EXPORT void allResults(const std::shared_ptr& theFeature, + std::list >& theResults); /*! Returns true if there are no parts in the document, which are not activated @@ -107,13 +141,13 @@ MODELAPI_EXPORT void allResults(const FeaturePtr& theFeature, std::list& theFeatures, +MODELAPI_EXPORT bool removeFeaturesAndReferences( + const std::set >& theFeatures, const bool theFlushRedisplay = false, const bool theUseComposite = false, const bool theUseRecursion = true); @@ -123,8 +157,9 @@ MODELAPI_EXPORT bool removeFeaturesAndReferences(const std::set& 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& theFeatures, - const bool theFlushRedisplay); +MODELAPI_EXPORT bool removeFeatures( + const std::set >& theFeatures, + const bool theFlushRedisplay); /*! Build a map of references for the given set of features * \param theFeatures a list of features @@ -134,19 +169,42 @@ MODELAPI_EXPORT bool removeFeatures(const std::set& 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& theFeatures, - std::map >& theReferences, - const bool theUseComposite = true, - const bool theUseRecursion = true); +MODELAPI_EXPORT void findAllReferences( + const std::set >& theFeatures, + std::map, + std::set > >& 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& aFeatures, - const std::map >& aReferences, - std::set& aFeaturesRefsTo); +MODELAPI_EXPORT void findRefsToFeatures( + const std::set >& aFeatures, + const std::map, + std::set > >& aReferences, + std::set >& 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& theFeature, + std::list >& 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). + */ +MODELAPI_EXPORT std::pair getDefaultName( + const std::shared_ptr& theResult, const bool theInherited = true); + +/*! Collect all parents for the given feature, including the Part + */ +MODELAPI_EXPORT std::set > + getParents(const std::shared_ptr& theFeature); } #endif