1 // Copyright (C) 2017-2020 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 // File: PrimitivesPlugin_Sphere.h
21 // Created: 15 Mar 2017
22 // Author: Clarisse Genrault (CEA)
24 #ifndef PRIMITIVESPLUGIN_SPHERE_H_
25 #define PRIMITIVESPLUGIN_SPHERE_H_
27 #include <PrimitivesPlugin.h>
28 #include <ModelAPI_Feature.h>
29 #include <GeomAlgoAPI_Sphere.h>
31 /**\class PrimitivesPlugin_Sphere
33 * \brief Feature for creation of a sphere.
35 * Creates a sphere from a radius and a center point defaulting to the origin
37 class PrimitivesPlugin_Sphere : public ModelAPI_Feature
41 inline static const std::string& ID()
43 static const std::string MY_SPHERE_ID("Sphere");
47 /// Attribute name of the base point
48 inline static const std::string& CENTER_POINT_ID()
50 static const std::string MY_CENTER_POINT_ID("center_point");
51 return MY_CENTER_POINT_ID;
54 /// Attribute name of the radius
55 inline static const std::string& RADIUS_ID()
57 static const std::string MY_RADIUS_ID("radius");
61 /// Returns the kind of a feature
62 PRIMITIVESPLUGIN_EXPORT virtual const std::string& getKind()
64 static std::string MY_KIND = PrimitivesPlugin_Sphere::ID();
68 /// Creates a new part document if needed
69 PRIMITIVESPLUGIN_EXPORT virtual void execute();
71 /// Request for initialization of data model of the feature: adding all attributes
72 PRIMITIVESPLUGIN_EXPORT virtual void initAttributes();
74 /// Use plugin manager for features creation
75 PrimitivesPlugin_Sphere();
78 /// Load Naming data structure of the feature to the document
79 void loadNamingDS(std::shared_ptr<GeomAlgoAPI_Sphere> theSphereAlgo,
80 std::shared_ptr<ModelAPI_ResultBody> theResultSphere);
84 #endif // PRIMITIVESPLUGIN_SPHERE_H_