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="BezierCurve2dPy"
5
        Namespace="Part"
6
        Twin="Geom2dBezierCurve"
7
        TwinPointer="Geom2dBezierCurve"
8
        PythonName="Part.Geom2d.BezierCurve2d"
9
        FatherInclude="Mod/Part/App/Geom2d/Curve2dPy.h"
10
        Include="Mod/Part/App/Geometry2d.h"
11
        Father="Curve2dPy"
12
        FatherNamespace="Part"
13
        Constructor="true">
14
        <Documentation>
15
            <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net"/>
16
            <UserDocu>Describes a rational or non-rational Bezier curve in 2d space:
17
                -- a non-rational Bezier curve is defined by a table of poles (also called control points)
18
                -- a rational Bezier curve is defined by a table of poles with varying weights</UserDocu>
19
        </Documentation>
20
        <Attribute Name="Degree" ReadOnly="true">
21
            <Documentation>
22
                <UserDocu>Returns the polynomial degree of this Bezier curve,
23
which is equal to the number of poles minus 1.</UserDocu>
24
            </Documentation>
25
            <Parameter Name="Degree" Type="Long"/>
26
        </Attribute>
27
        <Attribute Name="MaxDegree" ReadOnly="true">
28
            <Documentation>
29
                <UserDocu>Returns the value of the maximum polynomial degree of any
30
Bezier curve curve. This value is 25.</UserDocu>
31
            </Documentation>
32
            <Parameter Name="MaxDegree" Type="Long"/>
33
        </Attribute>
34
        <Attribute Name="NbPoles" ReadOnly="true">
35
            <Documentation>
36
                <UserDocu>Returns the number of poles of this Bezier curve.</UserDocu>
37
            </Documentation>
38
            <Parameter Name="NbPoles" Type="Long"/>
39
        </Attribute>
40
        <Attribute Name="StartPoint" ReadOnly="true">
41
            <Documentation>
42
                <UserDocu>Returns the start point of this Bezier curve.</UserDocu>
43
            </Documentation>
44
            <Parameter Name="StartPoint" Type="Object"/>
45
        </Attribute>
46
        <Attribute Name="EndPoint" ReadOnly="true">
47
            <Documentation>
48
                <UserDocu>Returns the end point of this Bezier curve.</UserDocu>
49
            </Documentation>
50
            <Parameter Name="EndPoint" Type="Object"/>
51
        </Attribute>
52
        <Methode Name="isRational">
53
            <Documentation>
54
                <UserDocu>Returns false if the weights of all the poles of this Bezier curve are equal.</UserDocu>
55
            </Documentation>
56
        </Methode>
57
        <Methode Name="isPeriodic">
58
            <Documentation>
59
                <UserDocu>Returns false.</UserDocu>
60
            </Documentation>
61
        </Methode>
62
        <Methode Name="isClosed">
63
            <Documentation>
64
                <UserDocu>Returns true if the distance between the start point and end point of
65
                    this Bezier curve is less than or equal to gp::Resolution().</UserDocu>
66
            </Documentation>
67
        </Methode>
68
        <Methode Name="increase">
69
            <Documentation>
70
                <UserDocu>increase(Int=Degree)
71
Increases the degree of this Bezier curve to Degree.
72
As a result, the poles and weights tables are modified.</UserDocu>
73
            </Documentation>
74
        </Methode>
75
        <Methode Name="insertPoleAfter">
76
            <Documentation>
77
                <UserDocu>Inserts after the pole of index.</UserDocu>
78
            </Documentation>
79
        </Methode>
80
        <Methode Name="insertPoleBefore">
81
            <Documentation>
82
                <UserDocu>Inserts before the pole of index.</UserDocu>
83
            </Documentation>
84
        </Methode>
85
        <Methode Name="removePole">
86
            <Documentation>
87
                <UserDocu>Removes the pole of index Index from the table of poles of this Bezier curve.
88
If this Bezier curve is rational, it can become non-rational.</UserDocu>
89
            </Documentation>
90
        </Methode>
91
        <Methode Name="segment">
92
            <Documentation>
93
                <UserDocu>Modifies this Bezier curve by segmenting it.</UserDocu>
94
            </Documentation>
95
        </Methode>
96
        <Methode Name="setPole">
97
            <Documentation>
98
                <UserDocu>Set a pole of the Bezier curve.</UserDocu>
99
            </Documentation>
100
        </Methode>
101
        <Methode Name="getPole">
102
            <Documentation>
103
                <UserDocu>Get a pole of the Bezier curve.</UserDocu>
104
            </Documentation>
105
        </Methode>
106
        <Methode Name="getPoles">
107
            <Documentation>
108
                <UserDocu>Get all poles of the Bezier curve.</UserDocu>
109
            </Documentation>
110
        </Methode>
111
        <Methode Name="setPoles">
112
            <Documentation>
113
                <UserDocu>Set the poles of the Bezier curve.</UserDocu>
114
            </Documentation>
115
        </Methode>
116
        <Methode Name="setWeight">
117
            <Documentation>
118
                <UserDocu>Set a weight of the Bezier curve.</UserDocu>
119
            </Documentation>
120
        </Methode>
121
        <Methode Name="getWeight">
122
            <Documentation>
123
                <UserDocu>Get a weight of the Bezier curve.</UserDocu>
124
            </Documentation>
125
        </Methode>
126
        <Methode Name="getWeights">
127
            <Documentation>
128
                <UserDocu>Get all weights of the Bezier curve.</UserDocu>
129
            </Documentation>
130
        </Methode>
131
        <Methode Name="getResolution" Const="true">
132
            <Documentation>
133
                <UserDocu>Computes for this Bezier curve the parametric tolerance (UTolerance)
134
for a given 3D tolerance (Tolerance3D).
135
If f(t) is the equation of this Bezier curve, the parametric tolerance
136
ensures that:
137
|t1-t0| &lt; UTolerance =&quot;&quot;==&gt; |f(t1)-f(t0)| &lt; Tolerance3D</UserDocu>
138
            </Documentation>
139
        </Methode>
140
    </PythonExport>
141
</GenerateModel>
142