FreeCAD

1
<?xml version="1.0" encoding="UTF-8"?>
2
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
3
    <PythonExport
4
        Name="EllipsePy"
5
        Namespace="Part"
6
        Twin="GeomEllipse"
7
        TwinPointer="GeomEllipse"
8
        PythonName="Part.Ellipse"
9
        FatherInclude="Mod/Part/App/ConicPy.h"
10
        Include="Mod/Part/App/Geometry.h"
11
        Father="ConicPy"
12
        FatherNamespace="Part"
13
        Constructor="true">
14
        <Documentation>
15
            <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net"/>
16
            <UserDocu>Describes an ellipse in 3D space
17
                To create an ellipse there are several ways:
18
                Part.Ellipse()
19
                    Creates an ellipse with major radius 2 and minor radius 1 with the
20
                    center in (0,0,0)
21

22
                Part.Ellipse(Ellipse)
23
                    Create a copy of the given ellipse
24

25
                Part.Ellipse(S1,S2,Center)
26
                    Creates an ellipse centered on the point Center, where
27
                    the plane of the ellipse is defined by Center, S1 and S2,
28
                    its major axis is defined by Center and S1,
29
                    its major radius is the distance between Center and S1, and
30
                    its minor radius is the distance between S2 and the major axis.
31

32
                Part.Ellipse(Center,MajorRadius,MinorRadius)
33
                    Creates an ellipse with major and minor radii MajorRadius and
34
                    MinorRadius, and located in the plane defined by Center and
35
                    the normal (0,0,1)</UserDocu>
36
        </Documentation>
37
        <Attribute Name="MajorRadius" ReadOnly="false">
38
            <Documentation>
39
                <UserDocu>The major radius of the ellipse.</UserDocu>
40
            </Documentation>
41
            <Parameter Name="MajorRadius" Type="Float"/>
42
        </Attribute>
43
        <Attribute Name="MinorRadius" ReadOnly="false">
44
            <Documentation>
45
                <UserDocu>The minor radius of the ellipse.</UserDocu>
46
            </Documentation>
47
            <Parameter Name="MinorRadius" Type="Float"/>
48
        </Attribute>
49
        <Attribute Name="Focal" ReadOnly="true">
50
            <Documentation>
51
                <UserDocu>The focal distance of the ellipse.</UserDocu>
52
            </Documentation>
53
            <Parameter Name="Focal" Type="Float"/>
54
        </Attribute>
55
        <Attribute Name="Focus1" ReadOnly="true">
56
            <Documentation>
57
                <UserDocu>The first focus is on the positive side of the major axis of the ellipse;
58
the second focus is on the negative side.</UserDocu>
59
            </Documentation>
60
            <Parameter Name="Focus1" Type="Object"/>
61
        </Attribute>
62
        <Attribute Name="Focus2" ReadOnly="true">
63
            <Documentation>
64
                <Documentation>
65
                    <UserDocu>The first focus is on the positive side of the major axis of the ellipse;
66
the second focus is on the negative side.</UserDocu>
67
                </Documentation>
68
            </Documentation>
69
            <Parameter Name="Focus2" Type="Object"/>
70
        </Attribute>
71
    </PythonExport>
72
</GenerateModel>
73