X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Tools.h;h=9d544cbf8e4afac7941e6ba851f1abf37e308c61;hb=868158fe6d39b25e60ac528295b1c908821e4af5;hp=9d63757ea0f5ee85d6ed85ccc6560e68d5108df8;hpb=fc1a9c802c59a0e853dc43125362e513b6f6358f;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 9d63757ea..9d544cbf8 --- a/src/ModelAPI/ModelAPI_Tools.h +++ b/src/ModelAPI/ModelAPI_Tools.h @@ -8,19 +8,76 @@ #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. + * 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 bool findVariable(const std::string& theName, double& outValue); +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); + +/*! +* 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); }