X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Document.h;h=4edc005c95ef320cd3cbb13d242d89116ac723a9;hb=506a83727ca8f8297fc1dcdf4ea40d7865c35450;hp=4248ea23a084771ad055728a52758e0dc50cbde2;hpb=96912644cf6607688466ac69f1f098fd2fff37b7;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Document.h b/src/ModelAPI/ModelAPI_Document.h index 4248ea23a..4edc005c9 100644 --- a/src/ModelAPI/ModelAPI_Document.h +++ b/src/ModelAPI/ModelAPI_Document.h @@ -7,7 +7,9 @@ #ifndef ModelAPI_Document_H_ #define ModelAPI_Document_H_ -#include +#include "ModelAPI.h" +#include "ModelAPI_Entity.h" + #include #include #include @@ -30,7 +32,7 @@ class ModelAPI_Data; * Document contains all data that must be stored/retrived in the file. * Also it provides acces to this data: open/save, transactions management etc. */ -class ModelAPI_Document +class ModelAPI_Document: public ModelAPI_Entity { public: //! Returns the kind of the document: "PartSet", "Part", or something else. @@ -44,7 +46,9 @@ public: //! Adds to the document the new feature of the given feature id //! \param theID creates feature and puts it in the document (if it is not action) - virtual std::shared_ptr addFeature(std::string theID) = 0; + //! \param theMakeCurrent to make current this new feature in this document + virtual std::shared_ptr addFeature(std::string theID, + const bool theMakeCurrent = true) = 0; //! Return a list of features, which refers to the feature //! \param theFeature a feature @@ -58,6 +62,10 @@ public: //! \param theFeature a feature to be removed virtual void removeFeature(std::shared_ptr theFeature) = 0; + //! 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; + ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist virtual std::shared_ptr subDocument(std::string theDocID) = 0; @@ -97,23 +105,40 @@ public: //! \param theVisible use visible features only: flag is true for Object Browser functionality virtual void setCurrentFeature(std::shared_ptr theCurrent, const bool theVisible) = 0; + //! Makes the current feature one feature upper + virtual void setCurrentFeatureUp() = 0; + + //! Returns the number of all features: in the history or not + virtual int numInternalFeatures() = 0; + //! Returns the feature by zero-based index: features in the history or not + 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 + virtual void synchronizeTransactions() = 0; - /// To virtually destroy the fields of successors + + //! To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_Document(); - /// Creates a construction cresults + //! Creates a construction cresult virtual std::shared_ptr createConstruction( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - /// Creates a body results + //! Creates a body result virtual std::shared_ptr createBody( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - /// Creates a part results + //! Creates a part result virtual std::shared_ptr createPart( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - /// Creates a group results + //! Copies a part result, keeping the reference to the origin + virtual std::shared_ptr copyPart( + const std::shared_ptr& theOrigin, + const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; + //! Creates a group result virtual std::shared_ptr createGroup( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; - + //! Creates a parameter result virtual std::shared_ptr createParameter( const std::shared_ptr& theFeatureData, const int theIndex = 0) = 0; @@ -121,13 +146,26 @@ public: virtual std::shared_ptr feature( const std::shared_ptr& theResult) = 0; + //! 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. + virtual std::list > allFeatures() = 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 + virtual bool isActive() const = 0; + + /// Returns true if document is opened and valid + virtual bool isOpened() = 0; + + protected: - /// Only for SWIG wrapping it is here + //! Only for SWIG wrapping it is here MODELAPI_EXPORT ModelAPI_Document(); - /// Internally makes document know that feature was removed or added in history after creation + //! Internally makes document know that feature was removed or added in history after creation MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr theObject) = 0; - /// Internally makes document know that feature was removed or added in history after creation + //! Internally makes document know that feature was removed or added in history after creation MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0; friend class ModelAPI_Object; // to add or remove from the history