SHAPER 9.16.0
SketchPlugin_Ellipse.h
1// Copyright (C) 2017-2026 CEA, EDF
2//
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.
7//
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.
12//
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
16//
17// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18//
19
20#ifndef SketchPlugin_Ellipse_H_
21#define SketchPlugin_Ellipse_H_
22
23#include <SketchPlugin.h>
24#include <SketchPlugin_SketchEntity.h>
25
31{
32 public:
34 inline static const std::string& ID()
35 {
36 static const std::string ID("SketchEllipse");
37 return ID;
38 }
39
41 inline static const std::string& CENTER_ID()
42 {
43 static const std::string ID("ellipse_center");
44 return ID;
45 }
46
48 inline static const std::string& FIRST_FOCUS_ID()
49 {
50 static const std::string ID("ellipse_first_focus");
51 return ID;
52 }
54 inline static const std::string& SECOND_FOCUS_ID()
55 {
56 static const std::string ID("ellipse_second_focus");
57 return ID;
58 }
59
61 inline static const std::string& MAJOR_AXIS_START_ID()
62 {
63 static const std::string ID("ellipse_major_axis_start_point");
64 return ID;
65 }
67 inline static const std::string& MAJOR_AXIS_END_ID()
68 {
69 static const std::string ID("ellipse_major_axis_end_point");
70 return ID;
71 }
72
74 inline static const std::string& MINOR_AXIS_START_ID()
75 {
76 static const std::string ID("ellipse_minor_axis_start_point");
77 return ID;
78 }
80 inline static const std::string& MINOR_AXIS_END_ID()
81 {
82 static const std::string ID("ellipse_minor_axis_end_point");
83 return ID;
84 }
85
87 inline static const std::string& MAJOR_RADIUS_ID()
88 {
89 static const std::string ID("ellipse_major_radius");
90 return ID;
91 }
92
94 inline static const std::string& MINOR_RADIUS_ID()
95 {
96 static const std::string ID("ellipse_minor_radius");
97 return ID;
98 }
99
101 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
102 {
103 static std::string MY_KIND = SketchPlugin_Ellipse::ID();
104 return MY_KIND;
105 }
106
108 SKETCHPLUGIN_EXPORT virtual bool isFixed();
109
111 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
112
114 SKETCHPLUGIN_EXPORT virtual void execute();
115
118
119protected:
121 virtual void initDerivedClassAttributes();
122
123private:
124 bool fillCharacteristicPoints();
125
126 void createEllipse(SketchPlugin_Sketch* theSketch, const int theResultIndex);
127};
128
129#endif
Feature for creation of the new ellipse in Sketch.
Definition: SketchPlugin_Ellipse.h:31
static const std::string & MAJOR_RADIUS_ID()
Major radius of the ellipse.
Definition: SketchPlugin_Ellipse.h:87
static const std::string & MINOR_RADIUS_ID()
Minor radius of the ellipse.
Definition: SketchPlugin_Ellipse.h:94
static const std::string & MAJOR_AXIS_END_ID()
2D point - end point of major axis
Definition: SketchPlugin_Ellipse.h:67
static const std::string & MINOR_AXIS_END_ID()
2D point - end point of minor axis
Definition: SketchPlugin_Ellipse.h:80
static const std::string & MAJOR_AXIS_START_ID()
2D point - start point of major axis
Definition: SketchPlugin_Ellipse.h:61
static const std::string & FIRST_FOCUS_ID()
2D point - focus of the ellipse
Definition: SketchPlugin_Ellipse.h:48
virtual SKETCHPLUGIN_EXPORT bool isFixed()
Returns true is sketch element is under the rigid constraint.
Definition: SketchPlugin_Ellipse.cpp:84
virtual SKETCHPLUGIN_EXPORT const std::string & getKind()
Returns the kind of a feature.
Definition: SketchPlugin_Ellipse.h:101
SketchPlugin_Ellipse()
Use plugin manager for features creation.
Definition: SketchPlugin_Ellipse.cpp:42
virtual void initDerivedClassAttributes()
Initializes attributes of derived class.
Definition: SketchPlugin_Ellipse.cpp:47
virtual SKETCHPLUGIN_EXPORT void execute()
Creates a new part document if needed.
Definition: SketchPlugin_Ellipse.cpp:70
virtual SKETCHPLUGIN_EXPORT void attributeChanged(const std::string &theID)
Called on change of any argument-attribute of this object.
Definition: SketchPlugin_Ellipse.cpp:88
static const std::string & CENTER_ID()
2D point - center of the ellipse
Definition: SketchPlugin_Ellipse.h:41
static const std::string & MINOR_AXIS_START_ID()
2D point - start point of minor axis
Definition: SketchPlugin_Ellipse.h:74
static const std::string & ID()
Ellipse feature kind.
Definition: SketchPlugin_Ellipse.h:34
static const std::string & SECOND_FOCUS_ID()
2D point - second focus of the ellipse
Definition: SketchPlugin_Ellipse.h:54
Sketch Entity for creation of the new feature in PartSet.
Definition: SketchPlugin_SketchEntity.h:45
Feature for creation of the new part in PartSet.
Definition: SketchPlugin_Sketch.h:47