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="TopoShapePy"
5
        Name="TopoShapeFacePy"
6
        Twin="TopoShape"
7
        TwinPointer="TopoShape"
8
        Include="Mod/Part/App/TopoShape.h"
9
        Namespace="Part"
10
        FatherInclude="Mod/Part/App/TopoShapePy.h"
11
        FatherNamespace="Part"
12
        Constructor="true">
13
        <Documentation>
14
            <Author Licence="LGPL" Name="Juergen Riegel" EMail="Juergen.Riegel@web.de" />
15
            <UserDocu>TopoShapeFace is the OpenCasCade topological face wrapper</UserDocu>
16
        </Documentation>
17
        <Methode Name="addWire">
18
            <Documentation>
19
                <UserDocu>Adds a wire to the face.
20
addWire(wire)
21
                </UserDocu>
22
            </Documentation>
23
        </Methode>
24
        <Methode Name="makeOffset" Const="true">
25
            <Documentation>
26
                <UserDocu>Offset the face by a given amount.
27
makeOffset(dist) -> Face
28
--
29
Returns Compound of Wires. Deprecated - use makeOffset2D instead.
30
                </UserDocu>
31
            </Documentation>
32
        </Methode>
33
        <Methode Name="makeEvolved" Const="true" Keyword="true">
34
            <Documentation>
35
                <UserDocu>Profile along the spine</UserDocu>
36
            </Documentation>
37
        </Methode>
38
        <Methode Name="getUVNodes" Const="true">
39
            <Documentation>
40
                <UserDocu>Get the list of (u,v) nodes of the tessellation
41
getUVNodes() -> list
42
--
43
An exception is raised if the face is not triangulated.
44
</UserDocu>
45
            </Documentation>
46
        </Methode>
47
        <Methode Name="tangentAt" Const="true">
48
            <Documentation>
49
                <UserDocu>Get the tangent in u and v isoparametric at the given point if defined
50
tangentAt(u,v) -> Vector
51
                </UserDocu>
52
            </Documentation>
53
        </Methode>
54
        <Methode Name="valueAt" Const="true">
55
            <Documentation>
56
                <UserDocu>Get the point at the given parameter [0|Length] if defined
57
valueAt(u,v) -> Vector
58
                </UserDocu>
59
            </Documentation>
60
        </Methode>
61
        <Methode Name="normalAt" Const="true">
62
            <Documentation>
63
                <UserDocu>Get the normal vector at the given parameter [0|Length] if defined
64
normalAt(pos) -> Vector
65
                </UserDocu>
66
            </Documentation>
67
        </Methode>
68
        <Methode Name="derivative1At" Const="true">
69
            <Documentation>
70
                <UserDocu>Get the first derivative at the given parameter [0|Length] if defined
71
derivative1At(u,v) -> (vectorU,vectorV)
72
                </UserDocu>
73
            </Documentation>
74
        </Methode>
75
        <Methode Name="derivative2At" Const="true">
76
            <Documentation>
77
                <UserDocu>Vector = d2At(pos) - Get the second derivative at the given parameter [0|Length] if defined
78
derivative2At(u,v) -> (vectorU,vectorV)
79
                </UserDocu>
80
            </Documentation>
81
        </Methode>
82
        <Methode Name="curvatureAt" Const="true">
83
            <Documentation>
84
                <UserDocu>Get the curvature at the given parameter [0|Length] if defined
85
curvatureAt(u,v) -> Float
86
                </UserDocu>
87
            </Documentation>
88
        </Methode>
89
        <Methode Name="isPartOfDomain" Const="true">
90
            <Documentation>
91
                <UserDocu>Check if a given (u,v) pair is inside the domain of a face
92
isPartOfDomain(u,v) -> bool
93
                </UserDocu>
94
            </Documentation>
95
        </Methode>
96
        <Methode Name="makeHalfSpace" Const="true">
97
            <Documentation>
98
                <UserDocu>Make a half-space solid by this face and a reference point.
99
makeHalfSpace(pos) -> Shape
100
                </UserDocu>
101
            </Documentation>
102
        </Methode>
103
        <Methode Name="validate">
104
            <Documentation>
105
                <UserDocu>Validate the face.
106
validate()
107
                </UserDocu>
108
            </Documentation>
109
        </Methode>
110
        <Methode Name="countNodes" Const="true">
111
        <Documentation>
112
          <UserDocu>Returns the number of nodes of the triangulation.</UserDocu>
113
        </Documentation>
114
        </Methode>
115
        <Methode Name="countTriangles" Const="true">
116
        <Documentation>
117
          <UserDocu>Returns the number of triangles of the triangulation.</UserDocu>
118
        </Documentation>
119
        </Methode>
120
        <Methode Name="curveOnSurface" Const="true">
121
            <Documentation>
122
                <UserDocu>Returns the curve associated to the edge in the parametric space of the face.
123
curveOnSurface(Edge) -> (curve, min, max) or None
124
--
125
If this curve exists then a tuple of curve and parameter range is returned.
126
Returns None if this curve  does not exist.
127
                </UserDocu>
128
            </Documentation>
129
        </Methode>
130
        <Methode Name="cutHoles">
131
            <Documentation>
132
                <UserDocu>Cut holes in the face.
133
cutHoles(list_of_wires)
134
                </UserDocu>
135
            </Documentation>
136
        </Methode>
137
        <Attribute Name="Tolerance">
138
            <Documentation>
139
                <UserDocu>Set or get the tolerance of the vertex</UserDocu>
140
            </Documentation>
141
            <Parameter Name="Tolerance" Type="Float"/>
142
        </Attribute>
143
        <Attribute Name="ParameterRange" ReadOnly="true">
144
            <Documentation>
145
                <UserDocu>Returns a 4 tuple with the parameter range</UserDocu>
146
            </Documentation>
147
            <Parameter Name="ParameterRange" Type="Tuple"/>
148
        </Attribute>
149
        <Attribute Name="Surface" ReadOnly="true">
150
            <Documentation>
151
                <UserDocu>Returns the geometric surface of the face</UserDocu>
152
            </Documentation>
153
            <Parameter Name="Surface" Type="Object"/>
154
        </Attribute>
155
        <Attribute Name="Wire" ReadOnly="true">
156
            <Documentation>
157
                <UserDocu>The outer wire of this face
158
deprecated -- please use OuterWire</UserDocu>
159
            </Documentation>
160
            <Parameter Name="Wire" Type="Object"/>
161
        </Attribute>
162
        <Attribute Name="OuterWire" ReadOnly="true">
163
            <Documentation>
164
                <UserDocu>The outer wire of this face</UserDocu>
165
            </Documentation>
166
            <Parameter Name="OuterWire" Type="Object"/>
167
        </Attribute>
168
    <Attribute Name="Mass" ReadOnly="true">
169
      <Documentation>
170
        <UserDocu>Returns the mass of the current system.</UserDocu>
171
      </Documentation>
172
      <Parameter Name="Mass" Type="Object"/>
173
    </Attribute>
174
    <Attribute Name="CenterOfMass" ReadOnly="true">
175
      <Documentation>
176
        <UserDocu>Returns the center of mass of the current system.
177
If the gravitational field is uniform, it is the center of gravity.
178
The coordinates returned for the center of mass are expressed in the
179
absolute Cartesian coordinate system.</UserDocu>
180
      </Documentation>
181
      <Parameter Name="CenterOfMass" Type="Object"/>
182
    </Attribute>
183
    <Attribute Name="MatrixOfInertia" ReadOnly="true">
184
      <Documentation>
185
        <UserDocu>Returns the matrix of inertia. It is a symmetrical matrix.
186
The coefficients of the matrix are the quadratic moments of
187
inertia.
188

189
 | Ixx Ixy Ixz 0 |
190
 | Ixy Iyy Iyz 0 |
191
 | Ixz Iyz Izz 0 |
192
 | 0   0   0   1 |
193

194
The moments of inertia are denoted by Ixx, Iyy, Izz.
195
The products of inertia are denoted by Ixy, Ixz, Iyz.
196
The matrix of inertia is returned in the central coordinate
197
system (G, Gx, Gy, Gz) where G is the centre of mass of the
198
system and Gx, Gy, Gz the directions parallel to the X(1,0,0)
199
Y(0,1,0) Z(0,0,1) directions of the absolute cartesian
200
coordinate system.</UserDocu>
201
      </Documentation>
202
      <Parameter Name="MatrixOfInertia" Type="Object"/>
203
    </Attribute>
204
    <Attribute Name="StaticMoments" ReadOnly="true">
205
      <Documentation>
206
        <UserDocu>Returns Ix, Iy, Iz, the static moments of inertia of the
207
 current system; i.e. the moments of inertia about the
208
 three axes of the Cartesian coordinate system.</UserDocu>
209
      </Documentation>
210
      <Parameter Name="StaticMoments" Type="Object"/>
211
    </Attribute>
212
    <Attribute Name="PrincipalProperties" ReadOnly="true">
213
      <Documentation>
214
        <UserDocu>Computes the principal properties of inertia of the current system.
215
 There is always a set of axes for which the products
216
 of inertia of a geometric system are equal to 0; i.e. the
217
 matrix of inertia of the system is diagonal. These axes
218
 are the principal axes of inertia. Their origin is
219
 coincident with the center of mass of the system. The
220
 associated moments are called the principal moments of inertia.
221
 This function computes the eigen values and the
222
 eigen vectors of the matrix of inertia of the system.</UserDocu>
223
      </Documentation>
224
      <Parameter Name="PrincipalProperties" Type="Dict"/>
225
    </Attribute>
226
    </PythonExport>
227
</GenerateModel>
228