X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=ec085811af5813e56714504544f577c0791d5496;hb=fc72d43b677baa05ae7fd317346fd8b723b799ed;hp=b80583544021bd7afc1f74b9129df94f246166f5;hpb=fd4dd622a85a0dd19ff5616391f94e980abc26a1;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index b80583544..ec085811a 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_Feature.hxx -// Created: 21 Mar 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2023 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_Feature_H_ #define ModelAPI_Feature_H_ @@ -26,6 +39,11 @@ class ModelAPI_Feature : public ModelAPI_Object { ///< list of current results of this feature std::list > myResults; + ///< is feature disabled or not + bool myIsDisabled; + ///< is feature is stable (not editing) + bool myIsStable; + public: /// Returns the unique kind of a feature (like "Point") virtual const std::string& getKind() = 0; @@ -55,12 +73,12 @@ class ModelAPI_Feature : public ModelAPI_Object /// Computes the attribute value on the base of other attributes if the value can be computed /// \param theAttributeId an attribute index to be computed /// \return a boolean value about it is computed - virtual bool compute(const std::string& theAttributeId) { return false; }; + virtual bool compute(const std::string& /*theAttributeId*/) { return false; }; /// Registers error during the execution, causes the ExecutionFailed state - virtual void setError(const std::string& theError, bool isSend = true) { - data()->setError(theError, isSend); - } + MODELAPI_EXPORT virtual void setError(const std::string& theError, + bool isSend = true, + bool isTranslate = true); /// Returns error, arose during the execution virtual std::string error() const { @@ -70,7 +88,7 @@ class ModelAPI_Feature : public ModelAPI_Object /// returns the current results of the feature MODELAPI_EXPORT const std::list >& results(); /// returns the first result in the list or NULL reference - MODELAPI_EXPORT std::shared_ptr firstResult(); + MODELAPI_EXPORT std::shared_ptr firstResult() const; /// returns the last result in the list or NULL reference MODELAPI_EXPORT std::shared_ptr lastResult(); /// sets the alone result @@ -78,14 +96,19 @@ class ModelAPI_Feature : public ModelAPI_Object /// sets the result by index (zero based), results before this must be set before MODELAPI_EXPORT void setResult(const std::shared_ptr& theResult, const int theIndex); - /// removes the result from the feature - MODELAPI_EXPORT void removeResult(const std::shared_ptr& theResult); - /// removes all results starting from the gived index (zero-based) - MODELAPI_EXPORT void removeResults(const int theSinceIndex); + /// removes all results starting from the given index (zero-based) + /// \param theSinceIndex - index of the deleted result and all after also will be deleted + /// \param theForever - removes results for long period (not just because of feature disabling) + /// \param theFlush - if it is false, REDISPLAY message is not flushed + MODELAPI_EXPORT void removeResults(const int theSinceIndex, + const bool theForever = true, const bool theFlush = true); /// removes all results from the feature - MODELAPI_EXPORT void eraseResults(); + MODELAPI_EXPORT void eraseResults(const bool theForever = true); /// removes all fields from this feature: results, data, etc MODELAPI_EXPORT virtual void erase(); + /// removes the result from the list of feature (not doing in disabled): normally this + /// method is not used from features. only internally + MODELAPI_EXPORT void eraseResultFromList(const std::shared_ptr& theResult); /// Returns true if result is persistent (stored in document) and on undo-redo, save-open /// it is not needed to recompute it. @@ -98,9 +121,26 @@ class ModelAPI_Feature : public ModelAPI_Object return false; } + /// Returns true if this feature is used as macro: creates other features and then removed. + /// \returns false by default + MODELAPI_EXPORT virtual bool isMacro() const; + + /// Returns true if preview update during the edition needed. Otherwise the update-mechanism + /// calls the \a execute function only on "apply" of the operation + /// \returns true by default + MODELAPI_EXPORT virtual bool isPreviewNeeded() const; + /// Must return document where the new feature must be added to - /// By default it is null document: it is added to the document this method is called to - MODELAPI_EXPORT virtual std::shared_ptr documentToAdd(); + /// By default it is empty: it is added to the document this method is called to + MODELAPI_EXPORT virtual const std::string& documentToAdd(); + + /// Enables/disables the feature. The disabled feature has no results and does not participate in + /// any calculation. + /// \returns true if state is really changed + MODELAPI_EXPORT virtual bool setDisabled(const bool theFlag); + + /// Returns the feature is disabled or not. + MODELAPI_EXPORT virtual bool isDisabled(); /// To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_Feature(); @@ -108,11 +148,23 @@ class ModelAPI_Feature : public ModelAPI_Object /// Returns the feature by the object (result). MODELAPI_EXPORT static std::shared_ptr feature(ObjectPtr theObject); + /// Set the stable feature flag. If feature is currently editing then it is not stable. + /// \returns true if state is really changed + MODELAPI_EXPORT virtual bool setStable(const bool theFlag); + + /// Returns the feature is stable or not. + MODELAPI_EXPORT virtual bool isStable(); + + /// Performs some custom feature specific functionality (normally called by some GUI button) + /// \param theActionId an action key + /// \return a boolean value about it is performed + MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId); + // // Helper methods, aliases for data()->method() // ----------------------------------------------------------------------------------------------- /// Returns the name stored in the attribute - inline std::string name() + inline std::wstring name() { return data()->name(); } @@ -136,11 +188,21 @@ class ModelAPI_Feature : public ModelAPI_Object { return data()->integer(theID); } + /// Returns the integer array attribute by the identifier + inline std::shared_ptr intArray(const std::string& theID) + { + return data()->intArray(theID); + } /// Returns the reference attribute by the identifier inline std::shared_ptr refattr(const std::string& theID) { return data()->refattr(theID); } + /// Returns the refattrlist attribute by the identifier + inline std::shared_ptr refattrlist(const std::string& theID) + { + return data()->refattrlist(theID); + } /// Returns the reference attribute by the identifier inline std::shared_ptr reference(const std::string& theID) { @@ -166,16 +228,46 @@ class ModelAPI_Feature : public ModelAPI_Object { return data()->string(theID); } + /// Returns the string array attribute by the identifier + inline std::shared_ptr stringArray(const std::string& theID) + { + return data()->stringArray(theID); + } + /// Returns the tables attribute by the identifier + inline std::shared_ptr tables(const std::string& theID) + { + return data()->tables(theID); + } /// Returns the attribute by the identifier inline std::shared_ptr attribute(const std::string& theID) { return data()->attribute(theID); } - // ----------------------------------------------------------------------------------------------- + protected: + /// This method is called just after creation of the object: it must initialize + /// all fields, normally initialized in the constructor + MODELAPI_EXPORT virtual void init(); + + friend class Model_Document; + friend class Model_Objects; }; //! Pointer on feature object typedef std::shared_ptr FeaturePtr; -#endif +//! An interface for performing special copy actions. To give feature which is moved (a group) +//! over this feature. +class ModelAPI_FeatureCopyInterface { +public: + virtual ~ModelAPI_FeatureCopyInterface() {} + /// An algorithm to update the moved feature by the separate Copy feature + /// \param theContext the original context object + /// \param theValue the original shape + /// \param theCopies resulting copy-context will be appended here + virtual void getCopies(ObjectPtr theContext, std::shared_ptr theValue, + std::list& theCopyContext, + std::list >& theCopyVals) = 0; +}; + +#endif