1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
20 #ifndef BuildPlugin_Wire_H_
21 #define BuildPlugin_Wire_H_
23 #include "BuildPlugin.h"
25 #include <ModelAPI_Feature.h>
27 /// \class BuildPlugin_Wire
29 /// \brief Feature for creation of wire from sketch edges or existing wires.
30 class BuildPlugin_Wire: public ModelAPI_Feature
33 /// Use plugin manager for features creation
37 inline static const std::string& ID()
39 static const std::string MY_ID("Wire");
43 /// Attribute name of base objects.
44 inline static const std::string& BASE_OBJECTS_ID()
46 static const std::string MY_BASE_OBJECTS_ID("base_objects");
47 return MY_BASE_OBJECTS_ID;
50 /// Attribute name of base objects.
51 inline static const std::string& ADD_CONTOUR_ACTION_ID()
53 static const std::string MY_ADD_CONTOUR_ACTION_ID("add_contour");
54 return MY_ADD_CONTOUR_ACTION_ID;
57 /// \return the kind of a feature.
58 BUILDPLUGIN_EXPORT virtual const std::string& getKind()
60 static std::string MY_KIND = BuildPlugin_Wire::ID();
64 /// Request for initialization of data model of the feature: adding all attributes.
65 BUILDPLUGIN_EXPORT virtual void initAttributes();
67 /// Creates a new part document if needed.
68 BUILDPLUGIN_EXPORT virtual void execute();
70 /// Performs some functionality by action id.
71 /// \param[in] theAttributeId action key id.
72 /// \return false in case if action not perfomed.
73 BUILDPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
76 /// Action: Adds to the list of segments other segments of the sketcher connected to
77 /// the already selected ones to create a closed contour.
78 /// \return false in case if no countours have been added.