X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=277c822ba629730adc39a796a6a78192f72afcc2;hb=bdfef16c6cd1f7cb83c1a1117e3e3d76b7063c26;hp=b6358eb4f18f44a03bd781f75483020d3e404a25;hpb=7c8c1517e8638583eadf37db82ac57f21441973e;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index b6358eb4f..277c822ba 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.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_Document_H_ @@ -38,8 +37,8 @@ class ModelAPI_AttributeSelectionList; /**\class Model_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 Model_Document : public ModelAPI_Document { @@ -57,6 +56,17 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual bool load( const char* theDirName, const char* theFileName, DocumentPtr theThis); + //! 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 + MODEL_EXPORT virtual bool importPart(const char* theFileName, + std::list >& theImported, + bool theCheckOnly = false); + //! Saves the OCAF document to the file. //! \param theDirName directory where the document will be saved //! \param theFileName a name of the document file to store @@ -65,12 +75,18 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual bool save( const char* theDirName, const char* theFileName, std::list& theResults); + //! Export the list of features to the file + //! \param theFilename path to save the file + //! \param theExportFeatures list of features to export + MODEL_EXPORT virtual bool save(const char* theFilename, + const std::list >& theExportFeatures) const; + //! 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) MODEL_EXPORT virtual void close(const bool theForever = false); - //! Starts a new operation (opens a tansaction) + //! Starts a new operation (opens a transaction) MODEL_EXPORT virtual void startOperation(); //! Finishes the previously started operation (closes the transaction) //! \returns true if transaction in this document is not empty and really was performed @@ -82,11 +98,11 @@ class Model_Document : public ModelAPI_Document //! Returns true if document was modified (since creation/opening) MODEL_EXPORT virtual bool isModified(); - //! Returns True if there are available Undos + //! Returns True if there are available Undo-s MODEL_EXPORT virtual bool canUndo(); //! Undoes last operation MODEL_EXPORT virtual void undo(); - //! Returns True if there are available Redos + //! Returns True if there are available Redo-s MODEL_EXPORT virtual bool canRedo(); //! Redoes last operation MODEL_EXPORT virtual void redo(); @@ -111,7 +127,8 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature); //! Moves the feature to make it after the given one in the history. - MODEL_EXPORT virtual void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis); + MODEL_EXPORT virtual void moveFeature( + FeaturePtr theMoved, FeaturePtr theAfterThis, const bool theSplit = false); //! Returns the first found object in the group by the object name //! \param theGroupID group that contains an object @@ -122,8 +139,10 @@ class Model_Document : public ModelAPI_Document //! 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 - MODEL_EXPORT virtual const int index(std::shared_ptr theObject); + MODEL_EXPORT virtual const int index(std::shared_ptr theObject, + const bool theAllowFolder = false); //! Internal sub-document by ID MODEL_EXPORT virtual std::shared_ptr subDoc(int theDocID); @@ -137,10 +156,20 @@ class Model_Document : public ModelAPI_Document //! Returns the feature in the group by the index (started from zero) //! \param theGroupID group that contains a feature //! \param theIndex zero-based index of feature in the group - MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex); + //! \param theAllowFolder take into account grouping feature by folders + MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, + const int theIndex, + const bool theAllowFolder = false); //! Returns the number of features in the group - MODEL_EXPORT virtual int size(const std::string& theGroupID); + //! \param theGroupID group of objects + //! \param theAllowFolder take into account grouping feature by folders + MODEL_EXPORT virtual 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. + MODEL_EXPORT virtual std::shared_ptr parent( + const std::shared_ptr theChild); //! Returns the feature that is currently edited in this document, normally //! this is the latest created feature @@ -164,15 +193,11 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual std::shared_ptr internalFeature(const int theIndex); //! 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 MODEL_EXPORT virtual void synchronizeTransactions(); - //! Returns feature by the id of the feature (produced by the Data "featureId" method) - MODEL_EXPORT virtual std::shared_ptr featureById(const int theId); - - - /// Creates a construction cresults + /// Creates construction results MODEL_EXPORT virtual std::shared_ptr createConstruction( const std::shared_ptr& theFeatureData, const int theIndex = 0); /// Creates a body results @@ -199,7 +224,48 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual std::shared_ptr feature(const std::shared_ptr& theResult); - ///! Returns true if parametric updater need to execute feature on recomputartion + //! 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) + MODEL_EXPORT virtual std::shared_ptr addFolder( + std::shared_ptr theAddBefore = std::shared_ptr()); + //! Removes the folder from the document (all features in the folder will be kept). + MODEL_EXPORT virtual void removeFolder(std::shared_ptr theFolder); + //! 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 + MODEL_EXPORT virtual std::shared_ptr findFolderAbove( + const std::list >& theFeatures); + //! 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 + MODEL_EXPORT virtual std::shared_ptr findFolderBelow( + const std::list >& theFeatures); + //! 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. + MODEL_EXPORT virtual 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 + MODEL_EXPORT virtual 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 + MODEL_EXPORT virtual bool removeFromFolder( + const std::list >& theFeatures, + const bool theBefore = true); + + ///! Returns true if parametric updater need to execute feature on recomputation ///! On abort, undo or redo it is not necessary: results in document are updated automatically bool executeFeatures() {return myExecuteFeatures;} @@ -224,12 +290,14 @@ class Model_Document : public ModelAPI_Document ///! history. Not very fast method, for calling once, not in big cycles. MODEL_EXPORT virtual std::list > allFeatures(); + //! 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. + MODEL_EXPORT virtual std::list > allObjects(); + /// Returns the global identifier of the current transaction (needed for the update algo) MODEL_EXPORT virtual int transactionID(); /// Increases the transaction ID MODEL_EXPORT virtual void incrementTransactionID(); - /// Decreases the transaction ID - MODEL_EXPORT virtual void decrementTransactionID(); /// Returns true if document is opened and valid MODEL_EXPORT virtual bool isOpened(); @@ -249,6 +317,11 @@ class Model_Document : public ModelAPI_Document /// Just removes all features without touching the document data (to be able undo) MODEL_EXPORT virtual void eraseAllFeatures(); + /// 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) + MODEL_EXPORT virtual std::shared_ptr nextFeature( + std::shared_ptr theCurrent, const bool theReverse = false) const; protected: //! Returns (creates if needed) the general label @@ -264,22 +337,22 @@ class Model_Document : public ModelAPI_Document } //! performs compactification of all nested operations into one - //! \returns true if resulting transaction is not empty and can be undoed + //! \returns true if resulting transaction is not empty and can be undone void compactNested(); //! Returns all loaded sub documents const std::set subDocuments() const; - //! The implementation of undo: with or without recoursive calls in the sub-documents + //! The implementation of undo: with or without recursive calls in the sub-documents void undoInternal(const bool theWithSubs, const bool theSynchronize); //! Stores the Id of the current operation (normally is called for the root document) void operationId(const std::string& theId); - //! Returns the list of Ids of the operations that can be undoed (called for the root document) + //! Returns the list of Ids of the operations that can be undone (called for the root document) std::list undoList() const; - //! Returns the list of Ids of the operations that can be redoed (called for the root document) + //! Returns the list of Ids of the operations that can be redone (called for the root document) std::list redoList() const; //! Internally makes document know that feature was removed or added in history after creation @@ -309,19 +382,29 @@ class Model_Document : public ModelAPI_Document /// Normally is called outside of the transaction, just before "save". virtual void storeNodesState(const std::list& theStates); - /// Returns the stored nodes states. Normally it is calles just after "open". + /// Returns the stored nodes states. Normally it is called just after "open". /// Appends the values to theStates list. virtual void restoreNodesState(std::list& theStates) const; - /// Label that constains structures for selection of constructions of another document + /// Label that contains structures for selection of constructions of another document TDF_Label extConstructionsLabel() const; /// searches in this document feature that contains this label FeaturePtr featureByLab(const TDF_Label& theLab); + /// searches in this document result that contains this label + ResultPtr resultByLab(const TDF_Label& theLab); - /// returns true if theThis is later in the features trre and dependencies than theOther + /// returns true if theThis is later in the features tree and dependencies than theOther bool isLaterByDep(FeaturePtr theThis, FeaturePtr theOther); + /// appends the latest transaction to the previous one (used for AutoUpdate enabling transaction) + void appendTransactionToPrevious(); + + /// Sets the automatic recomputation flag: true means enabled + void setAutoRecomutationState(const bool theState); + /// Returns the current automatic recomputation flag: true means enabled + bool autoRecomutationState() const; + friend class Model_Application; friend class Model_Session; friend class Model_Update; @@ -330,10 +413,12 @@ class Model_Document : public ModelAPI_Document friend class Model_AttributeRefList; friend class Model_AttributeRefAttrList; friend class Model_AttributeSelection; + friend class Model_AttributeSelectionList; friend class Model_ResultPart; - friend class Model_ResultCompSolid; + friend class Model_ResultBody; friend class Model_ResultConstruction; friend class Model_SelectionNaming; + friend class Model_BodyBuilder; friend class DFBrowser; private: @@ -345,7 +430,7 @@ class Model_Document : public ModelAPI_Document //! counter value of transaction on the last "save" call, used for "IsModified" method int myTransactionSave; - //! number of nested transactions performed (list becasue may be nested inside of nested) + //! number of nested transactions performed (list because may be nested inside of nested) //! the list is empty if not nested transaction is performed std::list myNestedNum; @@ -373,6 +458,8 @@ class Model_Document : public ModelAPI_Document //! The selection feature, if needed FeaturePtr mySelectionFeature; + + bool myIsSetCurrentFeature; ///< flag that my current feature is changed right now (recursion) }; #endif