src/Model/Model_AttributeSelection.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_AttributeSelection.h
   4 // Created:     8 May 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_AttributeSelection_H_
   8 #define Model_AttributeSelection_H_
   9
  10 #include "Model.h"
  11 #include "Model_AttributeReference.h"
  12 #include <ModelAPI_AttributeSelection.h>
  13 #include <TDF_LabelMap.hxx>
  14
  15 /**\class Model_AttributeSelection
  16  * \ingroup DataModel
  17  * \brief Attribute that contains reference to the sub-shape of some result, the selected shape.
  18  */
  19
  20 class Model_AttributeSelection : public ModelAPI_AttributeSelection
  21 {
  22   Model_AttributeReference myRef;  ///< The reference functionality reusage
  23   TDF_LabelMap myScope; ///< the map of valid labels for naming selection solving
  24   /// temporarily storages to avoid keeping in the data structure if not needed
  25   ResultPtr myTmpContext;
  26   /// temporarily storages to avoid keeping in the data structure if not needed
  27   std::shared_ptr<GeomAPI_Shape> myTmpSubShape;
  28 public:
  29   /// Defines the result and its selected sub-shape
  30   /// \param theContext object where the sub-shape was selected
  31   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  32   /// \param theTemporarily if it is true, do not store and name the added in the data framework
  33   ///           (used to remove immideately, without the following updates)
  34   MODEL_EXPORT virtual void setValue(
  35     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  36     const bool theTemporarily = false);
  37
  38   /// Reset temporary stored values
  39   virtual void removeTemporaryValues();
  40
  41   /// Returns the selected subshape
  42   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> value();
  43
  44   /// Returns the context of the selection (the whole shape owner)
  45   MODEL_EXPORT virtual ResultPtr context();
  46
  47   /// Sets the feature object
  48   MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
  49
  50   /// Updates the underlied selection due to the changes in the referenced objects
  51   /// \returns false if update is failed
  52   MODEL_EXPORT virtual bool update();
  53
  54   /// Returns a textual string of the selection
  55   /// \param theDefaultValue a name, which is returned if the naming name can not be obtained
  56   MODEL_EXPORT virtual std::string namingName(const std::string& theDefaultValue = "");
  57
  58   /// Returns an Id of the selection
  59   /// NOTE: This method has been added for temporary export of groups towards old GEOM
  60   /// It should then be removed when a direct use of objects from SHAPER
  61   /// will be possible from SMESH module of SALOME.
  62   MODEL_EXPORT virtual int Id();
  63
  64   /// Defines the sub-shape by Id
  65   /// NOTE: This method is opposite to Id() method.
  66   MODEL_EXPORT virtual void setId(int theID);
  67
  68   /// Selects (i.e. creates Naming data structure) of sub-shape specifed by textual name
  69   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
  70                                            const std::string& theSubShapeName);
  71
  72   /// Returns true if attribute was  initialized by some value
  73   MODEL_EXPORT virtual bool isInitialized();
  74
  75   /// Returns true if recomute of selection become impossible
  76   MODEL_EXPORT virtual bool isInvalid();
  77
  78   /// Updates the arguments of selection if something was affected by creation
  79   /// or reorder of features upper in the history line (issue #1757)
  80   MODEL_EXPORT virtual void updateInHistory();
  81
  82 protected:
  83   /// Objects are created for features automatically
  84   MODEL_EXPORT Model_AttributeSelection(TDF_Label& theLabel);
  85
  86   /// Performs the selection for the body result (TNaming Selection)
  87
  88   /// Performs the selection for the body result (TNaming selection)
  89   virtual void selectBody(
  90     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
  91
  92   /// Performs the selection for the construction result (selection by index)
  93   virtual void selectConstruction(
  94     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
  95
  96   /// Performs the selection for the part result (selection by name of body result inside of part)
  97   /// \param theContext the result - owner of the selection
  98   /// \param theSubShape selected shape
  99   /// \param theUpdate flag that shows that it must be just update, theShape is null
 100   /// \returns true if eveything is selected correctly
 101   virtual bool selectPart(
 102     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
 103     const bool theUpdate = false);
 104
 105   /// Returns the label where TNaming_Selection results are stored
 106   /// Note: there must be no attributes stored at the same label because Selector clears this lab
 107   TDF_Label selectionLabel();
 108
 109   /// Returns the prepared map of valid labels for naming selection solving (creates if not exists)
 110   TDF_LabelMap& scope();
 111
 112   /// Sets the ID of the attribute in Data (called from Data): here it is used for myRef ID setting
 113   MODEL_EXPORT virtual void setID(const std::string theID);
 114
 115   /// Returns the name by context. Adds the part name if the context is located in other document
 116   std::string contextName(const ResultPtr& theContext) const;
 117
 118   friend class Model_Data;
 119   friend class Model_AttributeSelectionList;
 120 };
 121
 122 #endif