X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FModelAPI%2FModelAPI_Tools.h;h=e404948351996280801243db79916e95448ee942;hb=5303dd1fa6ad4411e38f8d36103c72109957e05c;hp=5fce98955aed466bc43e23bcaf695532cad9a82d;hpb=4783f146b71a48c651523fcf0e12367bcf3d1fa8;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h old mode 100644 new mode 100755 index 5fce98955..e40494835 --- a/src/ModelAPI/ModelAPI_Tools.h +++ b/src/ModelAPI/ModelAPI_Tools.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Tools.h // Created: 06 Aug 2014 // Author: Vitaly Smetannikov @@ -6,13 +8,72 @@ #define ModelAPI_Tools_HeaderFile #include "ModelAPI.h" + +#include +#include +#include #include +#include +#include + #include +#include + namespace ModelAPI_Tools { /// Returns shape from the given Result object MODELAPI_EXPORT std::shared_ptr shape(const ResultPtr& theResult); + +/*! + * 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 DocumentPtr& theDocument, + const std::string& theName, double& outValue, ResultParameterPtr& 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. + */ +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] + * \param theValues a container of component of RGB value: red, green, blue + */ +MODELAPI_EXPORT void findRandomColor(std::vector& 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 null if not found + */ +MODELAPI_EXPORT ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& 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); + +/*! + * 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