X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeSelection.h;h=9829bde7981cc73f8efa15b205a43dd53197a3e3;hb=e6f3a506d92e58e3af31e2555bf141f20199c9f7;hp=71c850e59830047483ded064f64885f76fd9bcd9;hpb=5352bbb1915f98d1f02b1cb953a2de19b286a28c;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeSelection.h b/src/ModelAPI/ModelAPI_AttributeSelection.h index 71c850e59..9829bde79 100644 --- a/src/ModelAPI/ModelAPI_AttributeSelection.h +++ b/src/ModelAPI/ModelAPI_AttributeSelection.h @@ -1,8 +1,22 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: ModelAPI_AttributeSelection.h -// Created: 2 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_AttributeSelection_H_ #define ModelAPI_AttributeSelection_H_ @@ -10,6 +24,9 @@ #include "ModelAPI_Attribute.h" #include +class GeomAPI_Edge; +class GeomAPI_Pnt; + /**\class ModelAPI_AttributeSelection * \ingroup DataModel * \brief Attribute that contains reference to the sub-shape of some result, the selected shape. @@ -18,9 +35,37 @@ class ModelAPI_AttributeSelection : public ModelAPI_Attribute { public: + /// Type of the center of the circular of elliptical edge + enum CenterType { + NOT_CENTER, ///< this is not a center + CIRCLE_CENTER, ///< center of the circle + ELLIPSE_FIRST_FOCUS, ///< first focus point of the ellipse + ELLIPSE_SECOND_FOCUS, ///< second focus point of the ellipse + }; + /// Defines the result and its selected sub-shape - virtual void setValue( - const ResultPtr& theContext, const std::shared_ptr& theSubShape) = 0; + /// \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) + /// \returns true if attribute was updated + virtual bool setValue( + const ObjectPtr& theContext, const std::shared_ptr& theSubShape, + const bool theTemporarily = false) = 0; + + /// Same as SetValue, but it takes an edge (on circular or elliptical curve) + /// and stores the vertex of the central point (for ellipse the first or the second focus point) + virtual void setValueCenter( + const ObjectPtr& theContext, const std::shared_ptr& theEdge, + const CenterType theCenterType, + const bool theTemporarily = false) = 0; + + /// Makes this selection attribute selects the same as in theSource selection + virtual void selectValue( + const std::shared_ptr& theSource) = 0; + + /// Reset temporary stored values + virtual void removeTemporaryValues() = 0; /// Returns the selected subshape virtual std::shared_ptr value() = 0; @@ -28,6 +73,11 @@ class ModelAPI_AttributeSelection : public ModelAPI_Attribute /// Returns the context of the selection (the whole shape owner) virtual ResultPtr context() = 0; + /// Returns the context of the selection if the whole feature was selected + virtual std::shared_ptr contextFeature() = 0; + /// Returns the context of the selection : result or feature + virtual std::shared_ptr contextObject() = 0; + /// Updates the underlied selection due to the changes in the referenced objects /// \returns false if update is failed virtual bool update() = 0; @@ -44,14 +94,23 @@ class ModelAPI_AttributeSelection : public ModelAPI_Attribute /// Returns a textual string of the selection /// \param theDefaultValue a value, which is used if the naming name can not be obtained virtual std::string namingName(const std::string& theDefaultValue = "") = 0; - + /// Returns an id of the selection virtual int Id() = 0; + /// Defines an id of the selection + virtual void setId(int theID) = 0; /// Selects sub-shape by the textual Name virtual void selectSubShape(const std::string& theType, const std::string& theSubShapeName) = 0; + /// Selects sub-shape by its inner point + virtual void selectSubShape(const std::string& theType, + const std::shared_ptr& thePoint) = 0; + + /// Returns true if recompute of selection become impossible + virtual bool isInvalid() = 0; + /// To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelection();