X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeSelectionList.h;h=fe432944a2f7efe47803c52b3320300c797e8077;hb=a55586483e5dccc5466d6ec241e2147e210d839f;hp=e2cad1e1f7404176c8209cf3ecc6b91f0aaa1740;hpb=868158fe6d39b25e60ac528295b1c908821e4af5;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeSelectionList.h b/src/ModelAPI/ModelAPI_AttributeSelectionList.h index e2cad1e1f..fe432944a 100644 --- a/src/ModelAPI/ModelAPI_AttributeSelectionList.h +++ b/src/ModelAPI/ModelAPI_AttributeSelectionList.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_AttributeSelectionList.h -// Created: 22 Oct 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com +// #ifndef ModelAPI_AttributeSelectionList_H_ #define ModelAPI_AttributeSelectionList_H_ @@ -10,6 +24,9 @@ #include "ModelAPI_AttributeSelection.h" #include +class GeomAPI_Pnt; +class GeomAPI_Shape; + /**\class ModelAPI_AttributeSelectionList * \ingroup DataModel * \brief Attribute that contains list of references to the sub-shapes with @@ -23,21 +40,45 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute /// \param theContext object where the sub-shape was selected /// \param theSubShape selected sub-shape (if null, the whole context is selected) /// \param theTemporarily if it is true, do not store and name the added in the data framework - /// (used to remove immideately, without the following updates) - virtual void append(const ResultPtr& theContext, - const GeomShapePtr& theSubShape, + /// (used to remove immediately, without the following updates) + virtual void append(const ObjectPtr& theContext, + const std::shared_ptr& theSubShape, const bool theTemporarily = false) = 0; /// Adds the new reference to the end of the list by the naming name of the selected shape /// The type of shape is taken from the current selection type if the given is empty - virtual void append(const std::string theNamingName, const std::string& theType = "") = 0; + virtual void append(const std::string& theNamingName, const std::string& theType = "") = 0; + + /// Adds the new reference to the end of the list by inner point on the selected shape + virtual void append(const std::shared_ptr& thePoint, + const std::string& theType) = 0; + + /// Adds the new reference to the end of the list by weak naming index + virtual void append(const std::string& theType, const std::string& theContextName, + const int theIndex) = 0; + + /// Reset temporary stored values + virtual void removeTemporaryValues() = 0; /// Removes the last element in the list virtual void removeLast() = 0; + /// Removes the elements from the list. + /// \param theIndices a list of indices of elements to be removed + virtual void remove(const std::set& theIndices) = 0; + /// Returns the number of selection attributes in the list virtual int size() = 0; + /// Returns true if the object with the shape are in list + /// \param theContext object where the sub-shape was selected + /// \param theSubShape selected sub-shape (if null, the whole context is selected) + /// \param theTemporarily if it is true, it checks also the temporary added item + /// \returns true if the pair is found in the attirbute + virtual bool isInList( + const ObjectPtr& theContext, const std::shared_ptr& theSubShape, + const bool theTemporarily = false) = 0; + /// The type of all elements selection /// \returns the index of the enumeration of the type of shape virtual const std::string selectionType() const = 0; @@ -49,9 +90,14 @@ class ModelAPI_AttributeSelectionList : public ModelAPI_Attribute /// Returns the attribute selection by the index (zero based) virtual std::shared_ptr value(const int theIndex) = 0; - /// Returns all attributes + /// Removes all attributes of the list. virtual void clear() = 0; + /// Starts or stops cashing of the values in the attribute (the cash may become invalid + /// on modification of the attribute or sub-elements, so the cash must be enabled only + /// during non-modification operations with this attribute) + virtual void cashValues(const bool theEnabled) = 0; + /// Returns the type of this class of attributes static std::string typeId() {