1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef ModelAPI_AttributeSelectionList_H_
22 #define ModelAPI_AttributeSelectionList_H_
24 #include "ModelAPI_AttributeSelection.h"
25 #include <ModelAPI_Result.h>
30 /**\class ModelAPI_AttributeSelectionList
32 * \brief Attribute that contains list of references to the sub-shapes with
33 * possibility to manage them.
36 class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute
39 /// Adds the new reference to the end of the list
40 /// \param theContext object where the sub-shape was selected
41 /// \param theSubShape selected sub-shape (if null, the whole context is selected)
42 /// \param theTemporarily if it is true, do not store and name the added in the data framework
43 /// (used to remove immediately, without the following updates)
44 virtual void append(const ObjectPtr& theContext,
45 const std::shared_ptr<GeomAPI_Shape>& theSubShape,
46 const bool theTemporarily = false) = 0;
48 /// Adds the new reference to the end of the list by the naming name of the selected shape
49 /// The type of shape is taken from the current selection type if the given is empty
50 virtual void append(const std::string& theNamingName, const std::string& theType = "") = 0;
52 /// Adds the new reference to the end of the list by inner point on the selected shape
53 virtual void append(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
54 const std::string& theType) = 0;
56 /// Adds the new reference to the end of the list by weak naming index
57 virtual void append(const std::string& theType, const std::string& theContextName,
58 const int theIndex) = 0;
60 /// Reset temporary stored values
61 virtual void removeTemporaryValues() = 0;
63 /// Removes the last element in the list
64 virtual void removeLast() = 0;
66 /// Removes the elements from the list.
67 /// \param theIndices a list of indices of elements to be removed
68 virtual void remove(const std::set<int>& theIndices) = 0;
70 /// Returns the number of selection attributes in the list
71 virtual int size() = 0;
73 /// Returns true if the object with the shape are in list
74 /// \param theContext object where the sub-shape was selected
75 /// \param theSubShape selected sub-shape (if null, the whole context is selected)
76 /// \param theTemporarily if it is true, it checks also the temporary added item
77 /// \returns true if the pair is found in the attribute
78 virtual bool isInList(
79 const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
80 const bool theTemporarily = false) = 0;
82 /// The type of all elements selection
83 /// \returns the index of the enumeration of the type of shape
84 virtual const std::string selectionType() const = 0;
86 /// Sets the type of all elements selection
87 /// \param theType the index of the enumeration of the type of shape
88 virtual void setSelectionType(const std::string& theType) = 0;
90 /// Returns the attribute selection by the index (zero based)
91 virtual std::shared_ptr<ModelAPI_AttributeSelection> value(const int theIndex) = 0;
93 /// Removes all attributes of the list.
94 virtual void clear() = 0;
96 /// Starts or stops cashing of the values in the attribute (the cash may become invalid
97 /// on modification of the attribute or sub-elements, so the cash must be enabled only
98 /// during non-modification operations with this attribute)
99 virtual void cashValues(const bool theEnabled) = 0;
101 virtual void setGeometricalSelection(const bool theIsGeometricalSelection) = 0;
103 /// Returns true if is geometrical selection.
104 virtual bool isGeometricalSelection() const = 0;
106 /// Returns the type of this class of attributes
107 static std::string typeId()
109 return "SelectionList";
112 /// Returns the type of this class of attributes, not static method
113 MODELAPI_EXPORT virtual std::string attributeType();
115 /// To virtually destroy the fields of successors
116 MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelectionList();
119 /// Objects are created for features automatically
120 MODELAPI_EXPORT ModelAPI_AttributeSelectionList();
123 //! Pointer on double attribute
124 typedef std::shared_ptr<ModelAPI_AttributeSelectionList> AttributeSelectionListPtr;