src/Model/Model_AttributeSelection.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef Model_AttributeSelection_H_
  21 #define Model_AttributeSelection_H_
  22
  23 #include "Model.h"
  24 #include "Model_AttributeReference.h"
  25 #include <ModelAPI_AttributeSelection.h>
  26 #include <Selector_NameGenerator.h>
  27 #include <TDF_LabelMap.hxx>
  28 #include <TopoDS_Shape.hxx>
  29 #include <TopTools_ListOfShape.hxx>
  30
  31 class Model_AttributeSelectionList;
  32 class Model_Document;
  33
  34 /**\class Model_AttributeSelection
  35  * \ingroup DataModel
  36  * \brief Attribute that contains reference to the sub-shape of some result, the selected shape.
  37  */
  38 class Model_AttributeSelection : public ModelAPI_AttributeSelection,
  39                                  public Selector_NameGenerator
  40 {
  41   Model_AttributeReference myRef;  ///< The reference functionality re-usage
  42   /// temporarily storages to avoid keeping in the data structure if not needed
  43   ObjectPtr myTmpContext;
  44   /// temporarily storages to avoid keeping in the data structure if not needed
  45   std::shared_ptr<GeomAPI_Shape> myTmpSubShape;
  46   /// temporarily storages to avoid keeping in the data structure if not needed
  47   CenterType myTmpCenterType;
  48   /// Reference to the parent attribute, if any (to split selection compounds in issue 1799)
  49   Model_AttributeSelectionList* myParent;
  50
  51   /// current document to restore by name
  52   std::shared_ptr<Model_Document> myRestoreDocument;
  53   /// If true attribute selects geometry instead of shape.
  54   bool myIsGeometricalSelection;
  55
  56 public:
  57   /// Defines the result and its selected sub-shape
  58   /// \param theContext object where the sub-shape was selected
  59   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  60   /// \param theTemporarily if it is true, do not store and name the added in the data framework
  61   ///           (used to remove immediately, without the following updates)
  62   /// \returns true if attribute was updated
  63   MODEL_EXPORT virtual bool setValue(
  64     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  65     const bool theTemporarily = false);
  66
  67   /// Same as SetValue, but it takes an edge (on circular or elliptic curve)
  68   /// and stores the vertex of the central point (for ellipse the first or the second focus point)
  69   MODEL_EXPORT virtual void setValueCenter(
  70     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Edge>& theEdge,
  71     const CenterType theCenterType,
  72     const bool theTemporarily = false);
  73
  74   /// Makes this selection attribute selects the same as in theSource selection
  75   MODEL_EXPORT virtual void selectValue(
  76     const std::shared_ptr<ModelAPI_AttributeSelection>& theSource);
  77
  78   /// Reset temporary stored values
  79   virtual void removeTemporaryValues();
  80
  81   /// Returns the selected subshape
  82   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> value();
  83
  84   /// Returns the context of the selection (the whole shape owner)
  85   MODEL_EXPORT virtual ResultPtr context();
  86
  87   /// Returns the context of the selection if the whole feature was selected
  88   MODEL_EXPORT virtual FeaturePtr contextFeature();
  89   /// Returns the context of the selection : result or feature
  90   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> contextObject();
  91
  92   /// Sets the feature object
  93   MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
  94
  95   /// Updates the selection due to the changes in the referenced objects
  96   /// \returns false if update is failed
  97   MODEL_EXPORT virtual bool update();
  98
  99   /// Returns a textual string of the selection
 100   /// \param theDefaultValue a name, which is returned if the naming name can not be obtained
 101   MODEL_EXPORT virtual std::wstring namingName(const std::wstring& theDefaultValue = L"");
 102
 103   /// Defines the sub-shape by Id
 104   MODEL_EXPORT virtual void setId(int theID);
 105
 106   /// Selects (i.e. creates Naming data structure) of sub-shape specified by textual name
 107   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
 108                                            const std::wstring& theSubShapeName);
 109
 110   /// Selects sub-shape by its inner point
 111   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
 112                                            const std::shared_ptr<GeomAPI_Pnt>& thePoint);
 113   /// Selects sub-shape by weak naming index
 114   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
 115     const std::wstring& theContextName, const int theIndex);
 116
 117   /// Returns true if attribute was  initialized by some value
 118   MODEL_EXPORT virtual bool isInitialized();
 119
 120   /// Returns true if recompute of selection become impossible
 121   MODEL_EXPORT virtual bool isInvalid();
 122
 123   /// Updates the arguments of selection if something was affected by creation
 124   /// or reorder of features upper in the history line (issue #1757)
 125   /// Returns theRemove true if this attribute must be removed (become deleted)
 126   MODEL_EXPORT virtual void updateInHistory(bool& theRemove) override;
 127
 128   // Implementation of the name generator method from the Selector package
 129   // This method returns the context name by the label of the sub-selected shape
 130   MODEL_EXPORT virtual std::wstring contextName(const TDF_Label theSelectionLab) override;
 131
 132   /// This method restores by the context and value name the context label and
 133   /// sub-label where the value is. Returns true if it is valid.
 134   MODEL_EXPORT virtual bool restoreContext(std::wstring theName,
 135     TDF_Label& theContext, TDF_Label& theValue) override;
 136
 137   /// Returns true if the first result is newer than the second one in the tree of features
 138   MODEL_EXPORT virtual bool isLater(const TDF_Label theResult1, const TDF_Label theResult2)
 139     const override;
 140
 141   /// Returns the name by context. Adds the part name if the context is located in other document
 142   MODEL_EXPORT virtual std::wstring contextName(const ResultPtr& theContext) const;
 143
 144   /// Makes the current local selection becomes all sub-shapes with same base geometry.
 145   MODEL_EXPORT virtual void combineGeometrical();
 146
 147   /// Resets attribute to deafult state
 148   MODEL_EXPORT virtual void reset();
 149
 150 protected:
 151   /// Objects are created for features automatically
 152   MODEL_EXPORT Model_AttributeSelection(TDF_Label& theLabel);
 153
 154   /// Returns the selected subshape, internal method that works without knowledge
 155   /// about special selection of circle and ellipse focuses (for that the public value
 156   /// method calls this and makes additional processing).
 157   /// Returns theType type of the center, or NOT_CENTER if it is not.
 158   std::shared_ptr<GeomAPI_Shape> internalValue(CenterType& theType);
 159
 160   /// Performs the selection for the body result (TNaming selection)
 161   virtual void selectBody(
 162     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
 163
 164   /// Performs the selection for the part result (selection by name of body result inside of part)
 165   /// \param theContext the result - owner of the selection
 166   /// \param theSubShape selected shape
 167   /// \param theUpdate flag that shows that it must be just update, theShape is null
 168   /// \returns true if everything is selected correctly
 169   virtual bool selectPart(
 170     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
 171     const bool theUpdate = false);
 172
 173   /// Returns the label where TNaming_Selection results are stored
 174   /// Note: there must be no attributes stored at the same label because Selector clears this lab
 175   TDF_Label selectionLabel();
 176
 177   /// Sets the ID of the attribute in Data (called from Data): here it is used for myRef ID setting
 178   MODEL_EXPORT virtual void setID(const std::string theID);
 179
 180   /// Sets the parent attribute
 181   void setParent(Model_AttributeSelectionList* theParent);
 182
 183   /// Splits theNewShape into sub-shapes of theType type (for the list parent of this attribute)
 184   void split(ResultPtr theContext, TopoDS_Shape theNewShape, TopAbs_ShapeEnum theType);
 185
 186   /// When group position is updated, searches the new context and new values
 187   bool searchNewContext(std::shared_ptr<Model_Document> theDoc, const TopoDS_Shape theContShape,
 188                         ResultPtr theContext, TopoDS_Shape theValShape, TDF_Label theAccessLabel,
 189                         std::list<ResultPtr>& theResults, TopTools_ListOfShape& theValShapes);
 190
 191   /// Searches for the newest context, modification of the current, that contains theValue
 192   ResultPtr newestContext(
 193     const ResultPtr theCurrent, const std::shared_ptr<GeomAPI_Shape> theValue);
 194
 195   /// computes theShapes list - shapes that were generated/modified/deleted the theValShape
 196   /// during creation from new to old context
 197   void computeValues(ResultPtr theOldContext, ResultPtr theNewContext, TopoDS_Shape theValShape,
 198     TopTools_ListOfShape& theShapes);
 199
 200   /// Returns true if is geometrical selection.
 201   virtual bool isGeometricalSelection() const {
 202     return myIsGeometricalSelection;
 203   };
 204
 205   /// Returns the module document label if this selection attribute is not in this document.
 206   /// Returns null label otherwise.
 207   TDF_Label baseDocumentLab();
 208
 209   /// Returns features that conceals theFeature and located in history before theStop
 210   /// theResultOfFeature if not null defines exact referenced result of a feature
 211   void concealedFeature(
 212     const FeaturePtr theFeature, const FeaturePtr theStop, const bool theCheckCopy,
 213     std::list<FeaturePtr>& theConcealers, const ResultPtr theResultOfFeature,
 214     const bool theCheckWholeFeature = false);
 215
 216   friend class Model_Data;
 217   friend class Model_AttributeSelectionList;
 218 };
 219
 220 #endif