X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Objects.h;h=b9b8d7f181b7af15719cb4ff689895a943358567;hb=48c18f7fc10322e9976878236f5e19413a755a65;hp=15b8ed61888ca79a297e8f66bf34dadaf2d833c4;hpb=7ab55ab9035e1f5c3249ec8d76993bb6aff006df;p=modules%2Fshaper.git diff --git a/src/Model/Model_Objects.h b/src/Model/Model_Objects.h index 15b8ed618..b9b8d7f18 100644 --- a/src/Model/Model_Objects.h +++ b/src/Model/Model_Objects.h @@ -1,4 +1,4 @@ -// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// Copyright (C) 2014-2019 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 @@ -12,10 +12,9 @@ // // 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 Model_Objects_H_ @@ -24,6 +23,7 @@ #include #include #include +#include #include #include @@ -39,6 +39,8 @@ static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper); static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2); +extern int kUNDEFINED_FEATURE_INDEX; + /**\class Model_Objects * \ingroup DataModel * \brief Manager of objects of the document. Normally one this class corresponds to @@ -48,7 +50,7 @@ static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLa class Model_Objects { public: - //! Registers the fieature in the data structure + //! Registers the feature in the data structure //! \param theFeature feature that must be added to the data structure //! \param theAfterThis the feature will be added after this feature; //! if it is null, the added feature will be the first @@ -90,8 +92,10 @@ class Model_Objects //! 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 - const int index(std::shared_ptr theObject); + const int index(std::shared_ptr theObject, + const bool theAllowFolder = false); //! Returns the feature in the group by the index (started from zero) //! \param theGroupID group that contains a feature @@ -106,6 +110,10 @@ class Model_Objects //! \param theAllowFolder take into account grouping feature by folders int size(const std::string& theGroupID, const bool theAllowFolder = false); + //! 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. + std::shared_ptr parent(const std::shared_ptr theChild); + //! Returns all (and disabled) results of the given type. //! Not fast method (iterates all features). void allResults(const std::string& theGroupID, std::list& theResults); @@ -115,10 +123,6 @@ class Model_Objects //! Returns the feature by zero-based index: features in the history or not std::shared_ptr internalFeature(const int theIndex); - //! Returns feature by the id of the feature (produced by the Data "featureId" method) - std::shared_ptr featureById(const int theId); - - /// Creates a construction result std::shared_ptr createConstruction( const std::shared_ptr& theFeatureData, const int theIndex = 0); @@ -149,6 +153,37 @@ class Model_Objects /// Creates a folder (group of the features in the object browser) std::shared_ptr createFolder( const std::shared_ptr& theBeforeThis); + //! Removes the folder from the document (all features in the folder will be kept). + void removeFolder(std::shared_ptr theFolder); + //! Search a folder applicable for the list of features + //! (it means the list of features stored in the folder should be consequential) + //! \param theFeatures list of features to be added to folder + //! \param theBelow search the folder below the features (if \c false, search above) + //! \return Empty pointer if there is no applicable folder + std::shared_ptr findFolder( + const std::list >& theFeatures, + const bool theBelow); + //! 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. + std::shared_ptr findContainingFolder( + const std::shared_ptr& theFeature, + int& theIndexInFolder); + //! 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 + bool moveToFolder(const std::list >& theFeatures, + const std::shared_ptr& theFolder); + //! 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 + bool removeFromFolder(const std::list >& theFeatures, + const bool theBefore = true); //! Sets the owner of this manager void setOwner(DocumentPtr theDoc); @@ -156,7 +191,7 @@ class Model_Objects //! Returns the owner of this manager DocumentPtr owner() {return myDoc;} - //! Deletes all managed features wit hemmitting of corresponded signal + //! Deletes all managed features with emitting of corresponded signal ~Model_Objects(); protected: @@ -168,12 +203,15 @@ class Model_Objects //! feature type + "_" + index void setUniqueName(FeaturePtr theFeature); + //! Initializes the folder with an unique name ("Folder_" + index) + void setUniqueName(FolderPtr theFolder); + //! Synchronizes myFeatures list with the updated document - //! \param theUpdated list of labels that are marked as modified, so featrues must be also + //! \param theUpdated list of labels that are marked as modified, so features must be also //! \param theUpdateReferences causes the update of back-references //! \param theExecuteFeatures requires re-execute modified persistent features //! (not needed on undo/redo/abort/open) - //! \param theOpen - on open nothing must be reexecuted, except not persistent results + //! \param theOpen - on open nothing must be re-executed, except not persistent results //! \param theFlush makes flush all events in the end of all modifications of this method void synchronizeFeatures(const TDF_LabelList& theUpdated, const bool theUpdateReferences, const bool theOpen, const bool theExecuteFeatures, const bool theFlush); @@ -214,8 +252,9 @@ class Model_Objects /// 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 reverced order (next becomes previous) - FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false); + /// \param theReverse if it is true, iterates in reversed order (next becomes previous) + /// \param theIndex may be used for optimization: index of theCurrent in references array + FeaturePtr nextFeature(FeaturePtr theCurrent, int& theIndex, const bool theReverse = false); /// Returns to the first (from the history point of view) feature, any: invisible or disabled FeaturePtr firstFeature(); /// Returns to the last (from the history point of view) feature, any: invisible or disabled @@ -225,8 +264,8 @@ class Model_Objects /// Returns the next or previous label /// \param theCurrent given label - /// \param theReverse if it is true, iterates in reverced order (next becomes previous) - TDF_Label nextLabel(TDF_Label theCurrent, const bool theReverse = false); + /// \param theReverse if it is true, iterates in reversed order (next becomes previous) + TDF_Label nextLabel(TDF_Label theCurrent, int& theIndex, const bool theReverse = false); /// Returns the result group identifier of the given feature (for this at least one result must /// be created before) @@ -240,14 +279,14 @@ class Model_Objects //! history. Not very fast method, for calling once, not in big cycles. std::list > allObjects(); - //! synchronises back references for the given object basing on the collected data + //! synchronizes back references for the given object basing on the collected data void synchronizeBackRefsForObject( const std::set>& theNewRefs, ObjectPtr theObject); /// Just removes all features without touching the document data (to be able undo) virtual void eraseAllFeatures(); - // Check whether the pre-image of the result had user-defined name. + // Check whether the predefined-image of the result had user-defined name. // If yes, return this name. bool hasCustomName(DataPtr theFeatureData, ResultPtr theResult, @@ -255,12 +294,12 @@ class Model_Objects std::string& theParentName) const; /// Return object representing a folder or empty pointer - ObjectPtr folder(TDF_Label theLabel) const; + const ObjectPtr& folder(TDF_Label theLabel) const; private: TDF_Label myMain; ///< main label of the data storage - DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation + DocumentPtr myDoc; ///< document, owner of this objects manager: needed for events creation /// All managed features (not only in history of OB) /// For optimization mapped by labels @@ -270,7 +309,7 @@ class Model_Objects NCollection_DataMap myFolders; /// Map from group id to the array that contains all objects located in history. - /// Each array is updated by demand from scratch, by browing all the features in the history. + /// Each array is updated by demand from scratch, by browsing all the features in the history. std::map > myHistory; friend class Model_Document;