X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=f00d87a013f238ac23ac0d02bba7650157ffcd31;hb=392e617e3add41f698281c14ce5701cfd9f41e9c;hp=7ec9e073ec262be0a5a82217f35cabf9c7f15418;hpb=a24b7e6f4d112d5e7889fd76f030298fc428cd01;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 7ec9e073e..f00d87a01 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -11,18 +11,15 @@ #include #include #include +#include #include -#include -#include #include #include class Handle_Model_Document; - -// for TDF_Label map usage -static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper); -static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2); +class Model_Objects; +class ModelAPI_AttributeSelectionList; /**\class Model_Document * \ingroup DataModel @@ -39,15 +36,20 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual const std::string& kind() const {return myKind;} //! Loads the OCAF document from the file. - //! \param theFileName full name of the file to load + //! \param theDirName directory of the loaded file + //! \param theFileName a name of the file to load + //! \param theThis the common shared pointer to the document to manage with it later //! \returns true if file was loaded successfully - MODEL_EXPORT virtual bool load(const char* theFileName); + MODEL_EXPORT virtual bool load( + const char* theDirName, const char* theFileName, DocumentPtr theThis); //! Saves the OCAF document to the file. - //! \param theFileName full name of the file to store + //! \param theDirName directory where the document will be saved + //! \param theFileName a name of the document file to store //! \param theResults the result full file names that were stored by "save" //! \returns true if file was stored successfully - MODEL_EXPORT virtual bool save(const char* theFileName, std::list& theResults); + MODEL_EXPORT virtual bool save( + const char* theDirName, const char* theFileName, std::list& theResults); //! Removes document data //! \param theForever if it is false, document is just hiden (to keep possibility make it back on Undo/Redo) @@ -76,7 +78,8 @@ class Model_Document : public ModelAPI_Document //! Adds to the document the new feature of the given feature id //! \param theID creates feature and puts it in the document - MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID); + //! \param theMakeCurrent to make current this new feature in this document + MODEL_EXPORT virtual FeaturePtr addFeature(std::string theID, const bool theMakeCurrent = true); //! Return a list of features, which refers to the feature //! \param theFeature a feature @@ -87,25 +90,31 @@ class Model_Document : public ModelAPI_Document const bool isSendError = true); //! Removes the feature from the document (with result) + //! It is necessary to flush REDISPLAY signal manually after this method because + //! the method sends it, but for the performance purpose does not flush it //! \param theFeature a removed feature MODEL_EXPORT virtual void removeFeature(FeaturePtr theFeature); - //! Returns the existing feature by the label - //! \param theLabel base label of the feature - MODEL_EXPORT virtual FeaturePtr feature(TDF_Label& theLabel) const; + //! Moves the feature to make it after the given one in the history. + MODEL_EXPORT virtual void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis); - //! Returns the existing object: result or feature - //! \param theLabel base label of the object - MODEL_EXPORT virtual ObjectPtr object(TDF_Label theLabel); + //! 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 + MODEL_EXPORT virtual std::shared_ptr objectByName( + const std::string& theGroupID, const std::string& theName); - //! Adds a new sub-document by the identifier, or returns existing one if it is already exist - MODEL_EXPORT virtual std::shared_ptr subDocument(std::string theDocID); + //! Returns the object index in the group. Object must be visible. Otherwise returns -1. + //! \param theObject object of this document + //! \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); //! Internal sub-document by ID - MODEL_EXPORT virtual std::shared_ptr subDoc(std::string theDocID); + MODEL_EXPORT virtual std::shared_ptr subDoc(int theDocID); - ///! Returns the id of hte document - MODEL_EXPORT virtual const std::string& id() const + ///! Returns the id of the document + MODEL_EXPORT virtual const int id() const { return myID; } @@ -113,13 +122,40 @@ 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 - //! \param theHidden if it is true, it counts also the features that are not in tree - MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex, - const bool theHidden = false); + MODEL_EXPORT virtual ObjectPtr object(const std::string& theGroupID, const int theIndex); //! Returns the number of features in the group - //! If theHidden is true, it counts also the features that are not in tree - MODEL_EXPORT virtual int size(const std::string& theGroupID, const bool theHidden = false); + MODEL_EXPORT virtual int size(const std::string& theGroupID); + + //! Returns the feature that is currently edited in this document, normally + //! this is the latest created feature + //! \param theVisible use visible features only: flag is true for Object Browser functionality + //! \returns null if next created feature must be the first + MODEL_EXPORT virtual std::shared_ptr currentFeature(const bool theVisible); + + //! Sets the current feature: all features below will be disabled, new features + //! will be appended after this one. + //! \param theCurrent the selected feature as current: blow it everythin become disabled + //! \param theVisible use visible features only: flag is true for Object Browser functionality + MODEL_EXPORT virtual void setCurrentFeature(std::shared_ptr theCurrent, + const bool theVisible); + + //! Makes the current feature one feature upper + MODEL_EXPORT virtual void setCurrentFeatureUp(); + + //! Returns the number of all features: in the history or not + MODEL_EXPORT virtual int numInternalFeatures(); + //! Returns the feature by zero-based index: features in the history or not + 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 + 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 MODEL_EXPORT virtual std::shared_ptr createConstruction( @@ -130,9 +166,16 @@ class Model_Document : public ModelAPI_Document /// Creates a part results MODEL_EXPORT virtual std::shared_ptr createPart( const std::shared_ptr& theFeatureData, const int theIndex = 0); - /// Creates a group results + //! Copies a part result, keeping the reference to origin + MODEL_EXPORT virtual std::shared_ptr copyPart( + const std::shared_ptr& theOrigin, + const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a group result MODEL_EXPORT virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0); + /// Creates a parameter result + MODEL_EXPORT virtual std::shared_ptr createParameter( + const std::shared_ptr& theFeatureData, const int theIndex = 0); //! Returns a feature by result (owner of result) MODEL_EXPORT virtual std::shared_ptr @@ -140,7 +183,7 @@ class Model_Document : public ModelAPI_Document ///! Returns true if parametric updater need to execute feature on recomputartion ///! On abort, undo or redo it is not necessary: results in document are updated automatically - bool executeFeatures() {return myExecuteFeatures;} + bool& executeFeatures() {return myExecuteFeatures;} //! Registers the name of the shape for the topological naming needs void addNamingName(const TDF_Label theLabel, std::string theName); @@ -150,24 +193,38 @@ class Model_Document : public ModelAPI_Document //! selection by name. ResultPtr findByName(const std::string theName); - protected: + ///! Returns all features 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 > allFeatures(); + + /// 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(); - //! Returns (creates if needed) the features label - TDF_Label featuresLabel() const; + /// Returns the last feature in the document (even not visible or disabled) + /// \returns null if there is no features + FeaturePtr lastFeature(); - //! Initializes feature with a unique name in this group (unique name is generated as - //! feature type + "_" + index - void setUniqueName(FeaturePtr theFeature); + /// Returns the feature that produced the given face of the given result. + MODEL_EXPORT virtual std::shared_ptr producedByFeature( + std::shared_ptr theResult, + const std::shared_ptr& theShape); - //! Synchronizes myFeatures list with the updated document - //! \param theMarkUpdated causes the "update" event for all features - //! \param theUpdateReferences causes the update of back-references - void synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences); - //! Synchronizes the BackReferences list in Data of Features and Results - void synchronizeBackRefs(); + /// Returns true if theLater is in history of features creation later than theCurrent + MODEL_EXPORT virtual bool isLater(FeaturePtr theLater, FeaturePtr theCurrent) const; + + protected: + //! Returns (creates if needed) the general label + TDF_Label generalLabel() const; //! Creates new document with binary file format - Model_Document(const std::string theID, const std::string theKind); + Model_Document(const int theID, const std::string theKind); //! Returns the internal OCCT document of this interface Handle_TDocStd_Document document() @@ -179,22 +236,8 @@ class Model_Document : public ModelAPI_Document //! \returns true if resulting transaction is not empty and can be undoed void compactNested(); - //! Initializes the data fields of the feature - void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag); - - //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree) - MODEL_EXPORT virtual void storeResult(std::shared_ptr theFeatureData, - std::shared_ptr theResult, - const int theResultIndex = 0); - - //! returns the label of result by index; creates this label if it was not created before - TDF_Label resultLabel(const std::shared_ptr& theFeatureData, const int theResultIndex); - - //! Updates the results list of the feature basing on the current data tree - void updateResults(FeaturePtr theFeature); - - //! Returns all sub documents - const std::set subDocuments(const bool theActivatedOnly) const; + //! Returns all loaded sub documents + const std::set subDocuments() const; //! The implementation of undo: with or without recoursive calls in the sub-documents void undoInternal(const bool theWithSubs, const bool theSynchronize); @@ -208,46 +251,76 @@ class Model_Document : public ModelAPI_Document //! Returns the list of Ids of the operations that can be redoed (called for the root document) std::list redoList() const; - /// Internally makes document know that feature was removed or added in history after creation - MODEL_EXPORT virtual void addToHistory(const std::shared_ptr theObject); + //! Internally makes document know that feature was removed or added in history after creation + virtual void updateHistory(const std::shared_ptr theObject); + //! Internally makes document know that feature was removed or added in history after creation + virtual void updateHistory(const std::string theGroup); + + //! Returns true if the document is root module document + bool isRoot() const; + + //! Sets shared pointer to this + void setThis(DocumentPtr theDoc); + + //! Returns the objects manager + Model_Objects* objects() {return myObjs;} + + ///! Informs the document that it becomes active and some actions must be performed + virtual void setActive(const bool theFlag); + //! Returns true if this document is currently active + virtual bool isActive() const; + + //! Returns the selection attribute that is used for calculation of selection externally from the document + std::shared_ptr selectionInPartFeature(); friend class Model_Application; friend class Model_Session; friend class Model_Update; friend class Model_AttributeReference; + friend class Model_AttributeRefAttr; + friend class Model_AttributeRefList; + friend class Model_AttributeRefAttrList; + friend class Model_AttributeSelection; + friend class Model_ResultPart; + friend class Model_ResultCompSolid; friend class DFBrowser; private: - std::string myID; ///< identifier of the document in the application + int myID; ///< identifier of the document in the application std::string myKind; ///< kind of the document in the application Handle_TDocStd_Document myDoc; ///< OCAF document - /// counter value of transaction on the last "save" call, used for "IsModified" method + Model_Objects *myObjs; ///< data manager of this 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) - /// the list is empty if not nested transaction is performed + //! number of nested transactions performed (list becasue may be nested inside of nested) + //! the list is empty if not nested transaction is performed std::list myNestedNum; - /// Information related to the every user-transaction + //! Information related to the every user-transaction struct Transaction { int myOCAFNum; ///< number of OCAF transactions related to each "this" transaction, may be 0 std::string myId; ///< user-identifier string of transaction - /// default constructor with default Id + //! default constructor with default Id Transaction(): myOCAFNum(0), myId("") {} }; - /// transaction indexes (related to myTransactionsAfterSave) and info about the real transactions - /// in myDocument connected to this operation (may be zero for empty transaction) + //! transaction indexes (related to myTransactionsAfterSave) and info about the real transactions + //! in myDocument connected to this operation (may be zero for empty transaction) std::list myTransactions; - /// list of info about transactions undone (first is oldest undone) + //! list of info about transactions undone (first is oldest undone) std::list myRedos; - /// All features managed by this document (not only in history of OB) - /// For optimization mapped by labels - NCollection_DataMap myObjs; - /// Optimization for finding the shape-label by topological naming names + + //! Optimization for finding the shape-label by topological naming names std::map myNamingNames; - /// If it is true, features are not executed on update (on abort, undo, redo) + //! If it is true, features are not executed on update (on abort, undo, redo) bool myExecuteFeatures; + + bool myIsActive; ///< flag that stores the active/not active state + + //! The selection feature, if needed + FeaturePtr mySelectionFeature; }; #endif