src/ModelAPI/ModelAPI_AttributeSelectionList.h

   1 // Copyright (C) 2014-2019  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef ModelAPI_AttributeSelectionList_H_
  21 #define ModelAPI_AttributeSelectionList_H_
  22
  23 #include "ModelAPI_AttributeSelection.h"
  24 #include <ModelAPI_Result.h>
  25 #include <ModelAPI_Filter.h>
  26
  27 class GeomAPI_Pnt;
  28 class GeomAPI_Shape;
  29
  30 /**\class ModelAPI_AttributeSelectionList
  31  * \ingroup DataModel
  32  * \brief Attribute that contains list of references to the sub-shapes with
  33  * possibility to manage them.
  34  */
  35
  36 class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
  37 {
  38   /// Flag that indicates that the whole result selection is allowed while the selection type
  39   /// may be sub-objects, so, it is the same as all sub-shapes are selected (#3005). It is "false"
  40   /// by default.
  41   bool myIsWholeResultAllowed;
  42  public:
  43   /// Adds the new reference to the end of the list
  44   /// \param theContext object where the sub-shape was selected
  45   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  46   /// \param theTemporarily if it is true, do not store and name the added in the data framework
  47   ///           (used to remove immediately, without the following updates)
  48   virtual void append(const ObjectPtr& theContext,
  49                       const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  50                       const bool theTemporarily = false) = 0;
  51
  52   /// Adds the new reference to the end of the list by the naming name of the selected shape
  53   /// The type of shape is taken from the current selection type if the given is empty
  54   virtual void append(const std::string& theNamingName, const std::string& theType = "") = 0;
  55
  56   /// Adds the new reference to the end of the list by inner point on the selected shape
  57   virtual void append(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
  58                       const std::string& theType) = 0;
  59
  60   /// Adds the new reference to the end of the list by weak naming index
  61   virtual void append(const std::string& theType, const std::string& theContextName,
  62                       const int theIndex) = 0;
  63
  64   /// Reset temporary stored values
  65   virtual void removeTemporaryValues() = 0;
  66
  67   /// Removes the last element in the list
  68   virtual void removeLast() = 0;
  69
  70   /// Removes the elements from the list.
  71   /// \param theIndices a list of indices of elements to be removed
  72   virtual void remove(const std::set<int>& theIndices) = 0;
  73
  74   /// Returns the number of selection attributes in the list
  75   virtual int size() = 0;
  76
  77   /// Returns true if the object with the shape are in list
  78   /// \param theContext object where the sub-shape was selected
  79   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
  80   /// \param theTemporarily if it is true, it checks also the temporary added item
  81   /// \returns true if the pair is found in the attribute
  82   virtual bool isInList(
  83     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
  84     const bool theTemporarily = false) = 0;
  85
  86   /// The type of all elements selection
  87   /// \returns the index of the enumeration of the type of shape
  88   virtual const std::string selectionType() const = 0;
  89
  90   /// Sets the type of all elements selection
  91   /// \param theType the index of the enumeration of the type of shape
  92   virtual void setSelectionType(const std::string& theType) = 0;
  93
  94   /// Returns the attribute selection by the index (zero based)
  95   virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
  96
  97   /// Removes all attributes of the list.
  98   virtual void clear() = 0;
  99
 100   /// Starts or stops cashing of the values in the attribute (the cash may become invalid
 101   /// on modification of the attribute or sub-elements, so the cash must be enabled only
 102   /// during non-modification operations with this attribute)
 103   virtual void cashValues(const bool theEnabled) = 0;
 104
 105   virtual void setGeometricalSelection(const bool theIsGeometricalSelection) = 0;
 106
 107   /// Returns true if is geometrical selection.
 108   virtual bool isGeometricalSelection() const = 0;
 109
 110   /// Returns the type of this class of attributes
 111   static std::string typeId()
 112   {
 113     return "SelectionList";
 114   }
 115
 116   /// Returns the type of this class of attributes, not static method
 117   MODELAPI_EXPORT virtual std::string attributeType();
 118
 119   /// To virtually destroy the fields of successors
 120   MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
 121
 122   /// Returns a selection filters feature if it is defined for this selection list
 123   MODELAPI_EXPORT virtual FiltersFeaturePtr filters() const = 0;
 124
 125   /// Sets a selection filters feature if it is defined for this selection list
 126   MODELAPI_EXPORT virtual void setFilters(FiltersFeaturePtr theFeature) = 0;
 127
 128   /// Returns true if the whole result selection corresponds to selection of all sub-shapes.
 129   MODELAPI_EXPORT virtual const bool isWholeResultAllowed() const {
 130     return myIsWholeResultAllowed;
 131   }
 132
 133   /// Sets whether the whole result selection corresponds to selection of all sub-shapes.
 134   MODELAPI_EXPORT virtual void setWholeResultAllowed(const bool theFlag)  {
 135     myIsWholeResultAllowed = theFlag;
 136   }
 137
 138 protected:
 139   /// Default constructor
 140   MODELAPI_EXPORT ModelAPI_AttributeSelectionList() : ModelAPI_Attribute()
 141   {myIsWholeResultAllowed = false;}
 142
 143 };
 144
 145 //! Pointer on double attribute
 146 typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;
 147
 148 #endif