X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Tools.h;h=beb380f867d783603585ba9e5107744d543283ca;hb=a4a0d955055f7d26fda227ad47211eaaef645cc7;hp=0646e23eb4865f7f3474f635f9f9e6e32f6f9781;hpb=5a82acff74697623112b76b67c0200945a3e9976;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Tools.h b/src/ModelAPI/ModelAPI_Tools.h old mode 100755 new mode 100644 index 0646e23eb..beb380f86 --- a/src/ModelAPI/ModelAPI_Tools.h +++ b/src/ModelAPI/ModelAPI_Tools.h @@ -1,4 +1,4 @@ -// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// Copyright (C) 2014-2024 CEA, EDF // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public @@ -12,16 +12,16 @@ // // 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 +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // -// See http://www.salome-platform.org/ or -// email : webmaster.salome@opencascade.com +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // #ifndef ModelAPI_Tools_HeaderFile #define ModelAPI_Tools_HeaderFile #include "ModelAPI.h" +#include class ModelAPI_CompositeFeature; class ModelAPI_Document; @@ -30,7 +30,9 @@ class ModelAPI_Result; class ModelAPI_ResultParameter; class ModelAPI_ResultBody; +class GeomAlgoAPI_MakeShape; class GeomAPI_Shape; +class GeomAPI_ShapeHierarchy; #include #include @@ -49,14 +51,43 @@ MODELAPI_EXPORT std::shared_ptr shape( */ MODELAPI_EXPORT std::string getFeatureError(const std::shared_ptr& theFeature); +struct ResultBaseAlgo { + std::shared_ptr resultBody; + std::shared_ptr baseShape; + std::shared_ptr makeShape; +}; + +MODELAPI_EXPORT void loadModifiedShapes(std::shared_ptr theResultBody, + const std::list>& theBaseShapes, + const std::list>& theTools, + const std::shared_ptr& theMakeShape, + const std::shared_ptr theResultShape, + const std::string& theNamePrefix = ""); + +MODELAPI_EXPORT void loadModifiedShapes(std::shared_ptr theResultBody, + const std::shared_ptr& theBaseShape, + const std::shared_ptr& theMakeShape, + const std::string theName); +/// Stores deleted shapes. +MODELAPI_EXPORT void loadDeletedShapes(std::shared_ptr theResultBody, + const std::shared_ptr theBaseShape, + const std::list>& theTools, + const std::shared_ptr& theMakeShape, + const std::shared_ptr theResultShapesCompound); + +/// Stores deleted shapes. +MODELAPI_EXPORT void loadDeletedShapes(std::vector& theResultBaseAlgoList, + const std::list>& theTools, + const std::shared_ptr 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& theDocument, std::shared_ptr theSearcher, - const std::string& theName, double& outValue, + const std::wstring& theName, double& outValue, std::shared_ptr& theParam); /*! @@ -66,7 +97,7 @@ MODELAPI_EXPORT bool findVariable(const std::shared_ptr& theD * theSearcher must be located later in the history than the found variable. */ MODELAPI_EXPORT bool findVariable(std::shared_ptr theSearcher, - const std::string& theName, + const std::wstring& theName, double& outValue, std::shared_ptr& theParam, const std::shared_ptr& theDocument = std::shared_ptr()); @@ -103,10 +134,11 @@ MODELAPI_EXPORT std::shared_ptr compositeOwner( /*! * 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 - bodyOwner(const std::shared_ptr& theSub); + 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 @@ -125,7 +157,8 @@ MODELAPI_EXPORT bool hasSubResults(const std::shared_ptr& theRe * collects recursively all subs of the given result */ MODELAPI_EXPORT void allSubs(const std::shared_ptr& theResult, - std::list >& theResults); + std::list >& theResults, + const bool theLowerOnly = false); /*! * Adds the results of the given feature to theResults list: including disabled and sub-results @@ -138,7 +171,7 @@ MODELAPI_EXPORT void allResults(const std::shared_ptr& 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 @@ -196,9 +229,159 @@ MODELAPI_EXPORT void getConcealedResults(const std::shared_ptr /*! 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 getDefaultName( + const std::shared_ptr& theResult, + const bool theInherited = true, + const bool theRecursive = false); + +/*! Collect all parents for the given feature, including the Part + */ +MODELAPI_EXPORT std::set > + getParents(const std::shared_ptr& 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 std::pair getDefaultName( - const std::shared_ptr& theResult); +MODELAPI_EXPORT void fillShapeHierarchy( + const std::shared_ptr& theShape, + const std::shared_ptr& theContext, + GeomAPI_ShapeHierarchy& theHierarchy); + +/*! Creates a remove result features with the given results +*/ +MODELAPI_EXPORT void removeResults(const std::list >& 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& theResult); + +/*! Sets the deflection value +* \param theResult a result object +* \param a deflection value +*/ +MODELAPI_EXPORT void setDeflection(std::shared_ptr 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& theResult, + std::vector& 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 theResult, + const std::vector& 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& theResult, + bool& isVisible, std::vector& 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 theResult, + const std::vector& 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 theResult, bool theShow); + +MODELAPI_EXPORT bool isShownIsoLines(std::shared_ptr theResult); + +/*! Set visibility of edges direction +* \param[in] theResult a result object +* \param[in] theShow is a visibility flag +*/ +MODELAPI_EXPORT void showEdgesDirection(std::shared_ptr theResult, bool theShow); + +MODELAPI_EXPORT bool isShowEdgesDirection(std::shared_ptr theResult); + +/*! Set flag to bring result in front of other results +* \param[in] theResult a result object +* \param[in] theFlag is a flag +*/ +MODELAPI_EXPORT void bringToFront(std::shared_ptr theResult, bool theFlag); + +MODELAPI_EXPORT bool isBringToFront(std::shared_ptr 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& theResult); + +/*! Set transparency for the given result +* \param theResult a result object +* \param a transparency value +*/ +MODELAPI_EXPORT void setTransparency(std::shared_ptr 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 theSource, + std::shared_ptr 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 theSource, + std::shared_ptr 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 > referencedFeatures( + std::shared_ptr theTarget, const std::string& theFeatureKind, + const bool theSortResults); + +/*! + * Returns true if something in selection is presented in the results list + */ +MODELAPI_EXPORT bool isInResults(AttributeSelectionListPtr theSelection, + const std::list& theResults, + std::set& theCashedResults); + +/*! 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& theValues, bool theReset = false); + +/*! +* Checks the movement of features possibility. The feature cannot appear before the feature +* depended on it. Used in drag and drop part features. +* \param theAfter feature after which the moved features are placed, or null for the first place +* \param theMoved ordered list of the moved features +* \returns string with error text, dependencies that do not allow make movement or empty string +*/ +MODELAPI_EXPORT std::wstring validateMovement( + const FeaturePtr& theAfter, const std::list theMoved); + } #endif