X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPartSetPlugin%2FPartSetPlugin_Part.h;h=8a79e0d887b144e4c4b59704a4c414180c358e82;hb=08c56d0b00a8167f6183ec528db6d2e4d36348db;hp=25af3bea7bb586245b7c1def4c684911e9630114;hpb=6654a921211670c15a79a997ca666a174fe8a6f6;p=modules%2Fshaper.git diff --git a/src/PartSetPlugin/PartSetPlugin_Part.h b/src/PartSetPlugin/PartSetPlugin_Part.h index 25af3bea7..8a79e0d88 100644 --- a/src/PartSetPlugin/PartSetPlugin_Part.h +++ b/src/PartSetPlugin/PartSetPlugin_Part.h @@ -1,30 +1,56 @@ -// File: PartSetPlugin_Part.h -// Created: 27 Mar 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 PartSetPlugin_Part_HeaderFile -#define PartSetPlugin_Part_HeaderFile +#ifndef PartSetPlugin_Part_H_ +#define PartSetPlugin_Part_H_ #include "PartSetPlugin.h" -#include - -/// part reference attribute -const std::string PART_ATTR_DOC_REF = "PartDocument"; +#include /**\class PartSetPlugin_Part - * \ingroup DataModel + * \ingroup Plugins * \brief Feature for creation of the new part in PartSet. + * All sub-features are sub-elements of composite feature. */ -class PartSetPlugin_Part: public ModelAPI_Feature +class PartSetPlugin_Part : public ModelAPI_CompositeFeature { -public: + public: + /// Part kind + inline static const std::string& ID() + { + static const std::string MY_PART_KIND("Part"); + return MY_PART_KIND; + } /// Returns the kind of a feature - PARTSETPLUGIN_EXPORT virtual const std::string& getKind() - {static std::string MY_KIND = "Part"; return MY_KIND;} + PARTSETPLUGIN_EXPORT virtual const std::string& getKind() + { + static std::string MY_KIND = PartSetPlugin_Part::ID(); + return MY_KIND; + } /// Returns to which group in the document must be added feature - PARTSETPLUGIN_EXPORT virtual const std::string& getGroup() - {static std::string MY_GROUP = "Parts"; return MY_GROUP;} + PARTSETPLUGIN_EXPORT virtual const std::string& getGroup() + { + static std::string MY_GROUP = "Parts"; + return MY_GROUP; + } /// Creates a new part document if needed PARTSETPLUGIN_EXPORT virtual void execute(); @@ -32,10 +58,35 @@ public: /// Request for initialization of data model of the feature: adding all attributes PARTSETPLUGIN_EXPORT virtual void initAttributes(); - PARTSETPLUGIN_EXPORT virtual boost::shared_ptr documentToAdd(); + /// Part must be added only to PartSet + PARTSETPLUGIN_EXPORT virtual const std::string& documentToAdd(); + + // composite feature methods + + /// Adds feature to its document + virtual std::shared_ptr addFeature(std::string theID); + + /// Returns the number of sub-features of the document + virtual int numberOfSubs(bool forTree = false) const; + + /// Returns the sub-feature by zero-base index + virtual std::shared_ptr subFeature(const int theIndex, bool forTree = false); + + /// Returns the sub-feature unique identifier in this composite feature by zero-base index + virtual int subFeatureId(const int theIndex) const; + + /// Returns true if feature or reuslt belong to this composite feature as subs + virtual bool isSub(ObjectPtr theObject) const; + + /// This method to inform that sub-feature is removed and must be removed from the internal data + /// structures of the owner (the remove from the document will be done outside just after) + virtual void removeFeature(std::shared_ptr theFeature); /// Use plugin manager for features creation PartSetPlugin_Part(); + + /// Just removes all features of the part without touching the document data (to be able undo) + PARTSETPLUGIN_EXPORT virtual void erase(); }; #endif