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
      Father="PyObjectBase"
5
      Name="CurveConstraintPy"
6
      PythonName="Part.GeomPlate.CurveConstraintPy"
7
      Twin="GeomPlate_CurveConstraint"
8
      TwinPointer="GeomPlate_CurveConstraint"
9
      Include="GeomPlate_CurveConstraint.hxx"
10
      Namespace="Part"
11
      FatherInclude="Base/PyObjectBase.h"
12
      FatherNamespace="Base"
13
      Constructor="true"
14
      Delete="true">
15
    <Documentation>
16
      <Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
17
      <UserDocu>Defines curves as constraints to be used to deform a surface</UserDocu>
18
    </Documentation>
19
    <Methode Name="setOrder">
20
      <Documentation>
21
        <UserDocu>Allows you to set the order of continuity required for
22
the constraints: G0, G1, and G2, controlled
23
respectively by G0Criterion G1Criterion and G2Criterion.
24
        </UserDocu>
25
      </Documentation>
26
    </Methode>
27
    <Methode Name="order">
28
      <Documentation>
29
        <UserDocu>Returns the order of constraint, one of G0, G1 or G2</UserDocu>
30
      </Documentation>
31
    </Methode>
32
    <Methode Name="G0Criterion">
33
      <Documentation>
34
        <UserDocu>Returns the G0 criterion at the parametric point U on
35
the curve. This is the greatest distance allowed between
36
the constraint and the target surface at U.
37
        </UserDocu>
38
      </Documentation>
39
    </Methode>
40
    <Methode Name="G1Criterion">
41
      <Documentation>
42
        <UserDocu>Returns the G1 criterion at the parametric point U on
43
the curve. This is the greatest angle allowed between
44
the constraint and the target surface at U.
45
Raises an exception if  the  curve  is  not  on  a  surface.
46
        </UserDocu>
47
      </Documentation>
48
    </Methode>
49
    <Methode Name="G2Criterion">
50
      <Documentation>
51
        <UserDocu>Returns the G2 criterion at the parametric point U on
52
the curve. This is the greatest difference in curvature
53
allowed between the constraint and the target surface at U.
54
Raises an exception if  the  curve  is  not  on  a  surface.
55
        </UserDocu>
56
      </Documentation>
57
    </Methode>
58
    <Methode Name="setG0Criterion">
59
      <Documentation>
60
        <UserDocu>Allows you to set the G0 criterion. This is the law
61
defining the greatest distance allowed between the
62
constraint and the target surface for each point of the
63
constraint. If this criterion is not set, TolDist, the
64
distance tolerance from the constructor, is used.
65
        </UserDocu>
66
      </Documentation>
67
    </Methode>
68
    <Methode Name="setG1Criterion">
69
      <Documentation>
70
        <UserDocu>Allows you to set the G1 criterion. This is the law
71
defining the greatest angle allowed between the
72
constraint and the target surface. If this criterion is not
73
set, TolAng, the angular tolerance from the constructor, is used.
74
Raises an exception if  the  curve  is  not  on  a  surface
75
        </UserDocu>
76
      </Documentation>
77
    </Methode>
78
    <Methode Name="setG2Criterion">
79
      <Documentation>
80
        <UserDocu> Allows you to set the G2 criterion. This is the law
81
 defining the greatest difference in curvature allowed
82
 between the constraint and the target surface. If this
83
 criterion is not set, TolCurv, the curvature tolerance from
84
 the constructor, is used.
85
 Raises   ConstructionError if  the  point  is  not  on  the  surface
86
        </UserDocu>
87
      </Documentation>
88
    </Methode>
89
    <Methode Name="curve3d">
90
      <Documentation>
91
        <UserDocu> Returns a 3d curve associated the surface resulting of the constraints</UserDocu>
92
      </Documentation>
93
    </Methode>
94
    <Methode Name="setCurve2dOnSurf">
95
      <Documentation>
96
        <UserDocu> loads a 2d curve associated the surface resulting of the constraints
97
</UserDocu>
98
      </Documentation>
99
    </Methode>
100
    <Methode Name="curve2dOnSurf">
101
      <Documentation>
102
        <UserDocu> Returns a 2d curve associated the surface resulting of the constraints</UserDocu>
103
      </Documentation>
104
    </Methode>
105
    <Methode Name="setProjectedCurve">
106
      <Documentation>
107
        <UserDocu> loads a 2d curve  resulting from the normal projection of
108
 the curve on the initial surface</UserDocu>
109
      </Documentation>
110
    </Methode>
111
    <Methode Name="projectedCurve">
112
      <Documentation>
113
        <UserDocu> Returns the projected curve resulting from the normal projection of the
114
 curve on the initial surface</UserDocu>
115
      </Documentation>
116
    </Methode>
117
    <Attribute Name="NbPoints">
118
        <Documentation>
119
            <UserDocu>The number of points on the curve used as a
120
constraint. The default setting is 10. This parameter
121
affects computation time, which increases by the cube of
122
the number of points.</UserDocu>
123
        </Documentation>
124
        <Parameter Name="NbPoints" Type="Long"/>
125
    </Attribute>
126
    <Attribute Name="FirstParameter" ReadOnly="true">
127
        <Documentation>
128
            <UserDocu> This function returns the first parameter of the curve.
129
The first parameter is the lowest parametric value for the curve, which defines the starting point of the curve.</UserDocu>
130
        </Documentation>
131
        <Parameter Name="FirstParameter" Type="Float"/>
132
    </Attribute>
133
    <Attribute Name="LastParameter" ReadOnly="true">
134
        <Documentation>
135
            <UserDocu> This function returns the last parameter of the curve.
136
The last parameter is the highest parametric value for the curve, which defines the ending point of the curve.</UserDocu>
137
        </Documentation>
138
        <Parameter Name="LastParameter" Type="Float"/>
139
    </Attribute>
140
    <Attribute Name="Length" ReadOnly="true">
141
        <Documentation>
142
            <UserDocu> This function returns the length of the curve.
143
The length of the curve is a geometric property that indicates how long the curve is in the space.</UserDocu>
144
        </Documentation>
145
        <Parameter Name="Length" Type="Float"/>
146
    </Attribute>
147
  </PythonExport>
148
</GenerateModel>
149