src/Model/Model_AttributeSelection.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Model_AttributeSelection_H_
  22 #define Model_AttributeSelection_H_
  23
  24 #include "Model.h"
  25 #include "Model_AttributeReference.h"
  26 #include <ModelAPI_AttributeSelection.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 {
  40   Model_AttributeReference myRef;  ///< The reference functionality reusage
  41   TDF_LabelMap myScope; ///< the map of valid labels for naming selection solving
  42   /// temporarily storages to avoid keeping in the data structure if not needed
  43   ResultPtr 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 partent attribute, if any (to split selection compounds in issue 1799)
  49   Model_AttributeSelectionList* myParent;
  50 public:
  51   /// Defines the result and its selected sub-shape
  52   /// \param theContext object where the sub-shape was selected
  53   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  54   /// \param theTemporarily if it is true, do not store and name the added in the data framework
  55   ///           (used to remove immideately, without the following updates)
  56   /// \returns true if attribute was updated
  57   MODEL_EXPORT virtual bool setValue(
  58     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  59     const bool theTemporarily = false);
  60
  61   /// Same as SetValue, but it takes an edge (on circular or elliptical curve)
  62   /// and stores the vertex of the central point (for ellipse the first or the second focus point)
  63   MODEL_EXPORT virtual void setValueCenter(
  64     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Edge>& theEdge,
  65     const CenterType theCenterType,
  66     const bool theTemporarily = false);
  67
  68   /// Makes this selection attribute selects the same as in theSource selection
  69   MODEL_EXPORT virtual void selectValue(
  70     const std::shared_ptr<ModelAPI_AttributeSelection>& theSource);
  71
  72   /// Reset temporary stored values
  73   virtual void removeTemporaryValues();
  74
  75   /// Returns the selected subshape
  76   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> value();
  77
  78   /// Returns the context of the selection (the whole shape owner)
  79   MODEL_EXPORT virtual ResultPtr context();
  80
  81   /// Returns the context of the selection if the whole feature was selected
  82   MODEL_EXPORT virtual FeaturePtr contextFeature();
  83   /// Returns the context of the selection : result or feature
  84   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> contextObject();
  85
  86   /// Sets the feature object
  87   MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
  88
  89   /// Updates the underlied selection due to the changes in the referenced objects
  90   /// \returns false if update is failed
  91   MODEL_EXPORT virtual bool update();
  92
  93   /// Returns a textual string of the selection
  94   /// \param theDefaultValue a name, which is returned if the naming name can not be obtained
  95   MODEL_EXPORT virtual std::string namingName(const std::string& theDefaultValue = "");
  96
  97   /// Returns an Id of the selection
  98   /// NOTE: This method has been added for temporary export of groups towards old GEOM
  99   /// It should then be removed when a direct use of objects from SHAPER
 100   /// will be possible from SMESH module of SALOME.
 101   MODEL_EXPORT virtual int Id();
 102
 103   /// Defines the sub-shape by Id
 104   /// NOTE: This method is opposite to Id() method.
 105   MODEL_EXPORT virtual void setId(int theID);
 106
 107   /// Selects (i.e. creates Naming data structure) of sub-shape specifed by textual name
 108   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
 109                                            const std::string& theSubShapeName);
 110
 111   /// Returns true if attribute was  initialized by some value
 112   MODEL_EXPORT virtual bool isInitialized();
 113
 114   /// Returns true if recomute of selection become impossible
 115   MODEL_EXPORT virtual bool isInvalid();
 116
 117   /// Updates the arguments of selection if something was affected by creation
 118   /// or reorder of features upper in the history line (issue #1757)
 119   MODEL_EXPORT virtual void updateInHistory();
 120
 121 protected:
 122   /// Objects are created for features automatically
 123   MODEL_EXPORT Model_AttributeSelection(TDF_Label& theLabel);
 124
 125   /// Returns the selected subshape, internal method that works without knowledge
 126   /// about special selection of circle and ellipse focuses (for that the public value
 127   /// method calls this and makes additional processing).
 128   /// Returns theType type of the center, or NOT_CENTER if it is not.
 129   std::shared_ptr<GeomAPI_Shape> internalValue(CenterType& theType);
 130
 131
 132   /// Performs the selection for the body result (TNaming Selection)
 133
 134   /// Performs the selection for the body result (TNaming selection)
 135   virtual void selectBody(
 136     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
 137
 138   /// Performs the selection for the part result (selection by name of body result inside of part)
 139   /// \param theContext the result - owner of the selection
 140   /// \param theSubShape selected shape
 141   /// \param theUpdate flag that shows that it must be just update, theShape is null
 142   /// \returns true if eveything is selected correctly
 143   virtual bool selectPart(
 144     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
 145     const bool theUpdate = false);
 146
 147   /// Returns the label where TNaming_Selection results are stored
 148   /// Note: there must be no attributes stored at the same label because Selector clears this lab
 149   TDF_Label selectionLabel();
 150
 151   /// Returns the prepared map of valid labels for naming selection solving (creates if not exists)
 152   TDF_LabelMap& scope();
 153
 154   /// Sets the ID of the attribute in Data (called from Data): here it is used for myRef ID setting
 155   MODEL_EXPORT virtual void setID(const std::string theID);
 156
 157   /// Returns the name by context. Adds the part name if the context is located in other document
 158   std::string contextName(const ResultPtr& theContext) const;
 159
 160   /// Sets the parent attribute
 161   void setParent(Model_AttributeSelectionList* theParent);
 162
 163   /// Splits theNewShape into sub-shapes of theType type (for the list parent of this attribute)
 164   void split(ResultPtr theContext, TopoDS_Shape theNewShape, TopAbs_ShapeEnum theType);
 165
 166   /// When group position is updated, searches the new context and new values
 167   bool searchNewContext(std::shared_ptr<Model_Document> theDoc, const TopoDS_Shape theContShape,
 168                         ResultPtr theContext, TopoDS_Shape theValShape, TDF_Label theAccessLabel,
 169                         std::list<ResultPtr>& theResults, TopTools_ListOfShape& theValShapes);
 170
 171   /// computes theShapes list - shapes that were generated/modified/deleted the theValShape
 172   /// during creation from new to old context
 173   void computeValues(ResultPtr theOldContext, ResultPtr theNewContext, TopoDS_Shape theValShape,
 174     TopTools_ListOfShape& theShapes);
 175
 176   friend class Model_Data;
 177   friend class Model_AttributeSelectionList;
 178 };
 179
 180 #endif