X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Document.h;h=0e1c89a475478947d6ec1e10621fc355704aed18;hb=b0196aeefbaa53754b1052fab904386707caad87;hp=6114e759b03422ec0bd2c8083573683a23c43431;hpb=146cb80b58bc450adca2610b0c39622a987c7b3e;p=modules%2Fshaper.git diff --git a/src/Model/Model_Document.h b/src/Model/Model_Document.h index 6114e759b..0e1c89a47 100644 --- a/src/Model/Model_Document.h +++ b/src/Model/Model_Document.h @@ -122,8 +122,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 +139,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 @@ -199,9 +211,53 @@ class Model_Document : public ModelAPI_Document MODEL_EXPORT virtual std::shared_ptr feature(const std::shared_ptr& theResult); + //! 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. + //! Addtionally 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 successfull + 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 recomputartion ///! On abort, undo or redo it is not necessary: results in document are updated automatically - bool& executeFeatures() {return myExecuteFeatures;} + bool executeFeatures() {return myExecuteFeatures;} + + ///! On abort, undo or redo it is not necessary: results in document are updated automatically + void setExecuteFeatures(const bool theFlag); //! Registers the name of the shape for the topological naming needs void addNamingName(const TDF_Label theLabel, std::string theName); @@ -209,15 +265,22 @@ class Model_Document : public ModelAPI_Document void changeNamingName(std::string theOldName, const std::string theNewName, const TDF_Label& theLabel); //! Returns the label, keeper of the name for the topological naming needs - TDF_Label findNamingName(std::string theName); + TDF_Label findNamingName(std::string theName, ResultPtr theContext); + //! Returns the number of the name in the history relatively to the given object (by label). + //! Start from 1 (this object). + int numberOfNameInHistory(const ObjectPtr& theNameObject, const TDF_Label& theStartFrom); //! Returns the result by name of the result (names of results must be unique, used for naming //! selection by name. - ResultPtr findByName(const std::string theName); + ResultPtr findByName(std::string& theName, std::string& theSubShapeName, bool& theUniqueContext); ///! 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 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 @@ -310,6 +373,22 @@ class Model_Document : public ModelAPI_Document /// Label that constains 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 + bool isLaterByDep(FeaturePtr theThis, FeaturePtr theOther); + + /// appends the latest transaction to the previous one (used for AutoUpdate enabling transaction) + void appendTransactionToPrevious(); + + /// Sets the automatic recomutation flag: true means enabled + void setAutoRecomutationState(const bool theState); + /// Returns the current automatic recomutation flag: true means enabled + bool autoRecomutationState() const; + friend class Model_Application; friend class Model_Session; friend class Model_Update; @@ -319,7 +398,7 @@ class Model_Document : public ModelAPI_Document friend class Model_AttributeRefAttrList; friend class Model_AttributeSelection; friend class Model_ResultPart; - friend class Model_ResultCompSolid; + friend class Model_ResultBody; friend class Model_ResultConstruction; friend class Model_SelectionNaming; friend class DFBrowser; @@ -361,6 +440,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