X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=a5ad181f06e2d1387d02f4e10ff4529c6e7b4302;hb=207f4e84daf9c78020f5f250a33a63c71f0b0556;hp=427b332671e649461e7bef7ddad2798e9d2511f9;hpb=83f696896f289f92128194a96a0fb667b487e72e;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 427b33267..a5ad181f0 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -1,8 +1,21 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_Document.cxx -// Created: 28 Feb 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2022 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_Document_H_ #define ModelAPI_Document_H_ @@ -17,6 +30,7 @@ #include class ModelAPI_Feature; +class ModelAPI_Folder; class ModelAPI_Object; class ModelAPI_Result; class ModelAPI_ResultConstruction; @@ -31,8 +45,8 @@ class GeomAPI_Shape; /**\class ModelAPI_Document * \ingroup DataModel * \brief Document for internal data structure of any object storage. - * Document contains all data that must be stored/retrived in the file. - * Also it provides acces to this data: open/save, transactions management etc. + * Document contains all data that must be stored/retrieved in the file. + * Also it provides access to this data: open/save, transactions management etc. */ class ModelAPI_Document: public ModelAPI_Entity { @@ -43,7 +57,7 @@ public: virtual const std::string& kind() const = 0; //! Removes document data - //! \param theForever if it is false, document is just hiden + //! \param theForever if it is false, document is just hidden //! (to keep possibility make it back on Undo/Redo) virtual void close(const bool theForever = false) = 0; @@ -67,7 +81,8 @@ public: //! Moves the feature to make it after the given one in the history. virtual void moveFeature(std::shared_ptr theMoved, - std::shared_ptr theAfterThis) = 0; + std::shared_ptr theAfterThis, + const bool theSplit = false) = 0; ///! Returns the id of the document virtual const int id() const = 0; @@ -75,23 +90,34 @@ public: //! Returns the object in the group by the index (started from zero) //! \param theGroupID group that contains an object //! \param theIndex zero-based index of feature in the group + //! \param theAllowFolder take into account grouping feature by folders virtual std::shared_ptr object(const std::string& theGroupID, - const int theIndex) = 0; + const int theIndex, + const bool theAllowFolder = false) = 0; //! Returns the first found object in the group by the object name //! \param theGroupID group that contains an object //! \param theName name of the object to search //! \returns null if such object is not found virtual std::shared_ptr objectByName(const std::string& theGroupID, - const std::string& theName) = 0; + const std::wstring& theName) = 0; //! Returns the object index in the group. Object must be visible. Otherwise returns -1. //! \param theObject object of this document + //! \param theAllowFolder take into account grouping feature by folders //! \returns index started from zero, or -1 if object is invisible or belongs to another document - virtual const int index(std::shared_ptr theObject) = 0; + virtual const int index(std::shared_ptr theObject, + const bool theAllowFolder = false) = 0; //! Returns the number of objects in the group of objects - virtual int size(const std::string& theGroupID) = 0; + //! \param theGroupID group of objects + //! \param theAllowFolder take into account grouping feature by folders + virtual int size(const std::string& theGroupID, const bool theAllowFolder = false) = 0; + + //! Returns the parent object of this child. This may be result or feature, parent of a + //! top result. Fast method, that uses internal data structure specifics. + virtual std::shared_ptr parent( + const std::shared_ptr theChild) = 0; //! Returns the feature that is currently edited in this document, normally //! this is the latest created feature @@ -102,7 +128,7 @@ public: //! Sets the current feature: all features below will be disabled, new features //! will be appended after this one. This method does not flushes the events appeared: //! it will be done by the finishOperation, or direct flushes - //! \param theCurrent the selected feature as current: blow it everythin become disabled + //! \param theCurrent the selected feature as current: blow it everything become disabled //! \param theVisible use visible features only: flag is true for Object Browser functionality virtual void setCurrentFeature(std::shared_ptr theCurrent, const bool theVisible) = 0; @@ -115,13 +141,10 @@ public: virtual std::shared_ptr internalFeature(const int theIndex) = 0; //! Performs synchronization of transactions with the module document: //! If some document is not active (by undo of activation) but in memory, - //! on activation the transactions must be synchronised because all redos performed - //! wihtout this participation + //! on activation the transactions must be synchronized because all redo-s performed + //! without this participation virtual void synchronizeTransactions() = 0; - //! Returns feature by the id of the feature (produced by the Data "featureId" method) - virtual std::shared_ptr featureById(const int theId) = 0; - //! To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_Document(); @@ -156,6 +179,50 @@ public: //! history. Not very fast method, for calling once, not in big cycles. virtual std::list > allFeatures() = 0; + //! Returns all objects of the document including the hidden features which are not in + //! history. Not very fast method, for calling once, not in big cycles. + virtual std::list > allObjects() = 0; + + //! Creates a folder (group of the features in the object browser) + //! \param theAddBefore a feature, the folder is added before + //! (if empty, the folder is added after the last feature) + virtual std::shared_ptr addFolder( + std::shared_ptr theAddBefore = std::shared_ptr()) = 0; + //! Removes the folder from the document (all features in the folder will be kept). + virtual void removeFolder(std::shared_ptr theFolder) = 0; + //! Search a folder above the list of features applicable to store them + //! (it means the list of features stored in the folder should be consequential) + //! \return Empty pointer if there is no applicable folder + virtual std::shared_ptr findFolderAbove( + const std::list >& theFeatures) = 0; + //! Search a folder below the list of features applicable to store them + //! (it means the list of features stored in the folder should be consequential) + //! \return Empty pointer if there is no applicable folder + virtual std::shared_ptr findFolderBelow( + const std::list >& theFeatures) = 0; + //! Search a folder containing the given feature. + //! Additionally calculates a zero-based index of the feature in this folder. + //! \param theFeature feature to search + //! \param theIndexInFolder zero-based index in the folder or -1 if the feature is top-level. + //! \return the folder containing the feature or empty pointer if the feature is top-level. + virtual std::shared_ptr findContainingFolder( + const std::shared_ptr& theFeature, + int& theIndexInFolder) = 0; + //! Add a list of features to the folder. The correctness of the adding is not performed + //! (such checks have been done in corresponding find.. method). + //! \return \c true if the movement is successful + virtual bool moveToFolder(const std::list >& theFeatures, + const std::shared_ptr& theFolder) = 0; + //! Remove features from the folder + //! \param theFeatures list of features to be removed + //! \param theBefore extract features before the folder (this parameter is applicable only + //! when all features in the folder are taking out, + //! in other cases the direction is taken automatically) + //! \return \c true if the features have been moved out + virtual bool removeFromFolder( + const std::list >& theFeatures, + const bool theBefore = true) = 0; + //! Informs the document that it becomes active and some actions must be performed virtual void setActive(const bool theFlag) = 0; //! Returns true if this document is currently active @@ -180,10 +247,36 @@ public: /// Normally is called outside of the transaction, just before "save". MODELAPI_EXPORT virtual void storeNodesState(const std::list& theStates) = 0; - /// Returns the stored nodes states. Normally it is calles just after "open". + /// Returns the stored nodes states. Normally it is calls just after "open". /// Appends the values to theStates list. MODELAPI_EXPORT virtual void restoreNodesState(std::list& theStates) const = 0; + /// Just removes all features without touching the document data (to be able undo) + MODELAPI_EXPORT virtual void eraseAllFeatures() = 0; + + /// Returns the next (from the history point of view) feature, any: invisible or disabled + /// \param theCurrent previous to the resulting feature + /// \param theReverse if it is true, iterates in reversed order (next becomes previous) + MODELAPI_EXPORT virtual std::shared_ptr nextFeature( + std::shared_ptr theCurrent, const bool theReverse = false) const = 0; + + /// Loads the OCAF document from the file into the current document. + /// All the features are added after the active feature. + /// \param theFileName name of the file to import + /// \param theImported list of features imported from the file + /// \param theCheckOnly verify the document does not contain unappropriate features + /// (useful for import to PartSet), but do not import it + /// \returns true if file was loaded successfully + MODELAPI_EXPORT virtual bool importPart(const char* theFileName, + std::list >& theImported, + bool theCheckOnly = false) = 0; + + /// Export the list of features to the file + /// \param theFilename path to save the file + /// \param theExportFeatures list of features to export + MODELAPI_EXPORT virtual bool save(const char* theFilename, + const std::list >& theExportFeatures) const = 0; + protected: //! Only for SWIG wrapping it is here MODELAPI_EXPORT ModelAPI_Document();