Files
create/src/Mod/Part/App/GeomPlate/CurveConstraintPy.xml
Joao Matos e825ebe99d Part: Clean up XML bindings (Part 2)
This cleans up the XML bindings for Part in preparation for an upcoming
migration to Python bindings model.
2025-03-25 17:51:32 +01:00

145 lines
5.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="PyObjectBase"
Name="CurveConstraintPy"
PythonName="Part.GeomPlate.CurveConstraintPy"
Twin="GeomPlate_CurveConstraint"
TwinPointer="GeomPlate_CurveConstraint"
Include="GeomPlate_CurveConstraint.hxx"
Namespace="Part"
FatherInclude="Base/PyObjectBase.h"
FatherNamespace="Base"
Constructor="true"
Delete="true">
<Documentation>
<Author Licence="LGPL" Name="Werner Mayer" EMail="wmayer@users.sourceforge.net" />
<UserDocu>Defines curves as constraints to be used to deform a surface</UserDocu>
</Documentation>
<Methode Name="setOrder">
<Documentation>
<UserDocu>Allows you to set the order of continuity required for the constraints: G0, G1, and G2, controlled
respectively by G0Criterion G1Criterion and G2Criterion.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="order">
<Documentation>
<UserDocu>Returns the order of constraint, one of G0, G1 or G2</UserDocu>
</Documentation>
</Methode>
<Methode Name="G0Criterion">
<Documentation>
<UserDocu>Returns the G0 criterion at the parametric point U on the curve.
This is the greatest distance allowed between the constraint and the target surface at U.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="G1Criterion">
<Documentation>
<UserDocu>Returns the G1 criterion at the parametric point U on the curve.
This is the greatest angle allowed between the constraint and the target surface at U.
Raises an exception if the curve is not on a surface.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="G2Criterion">
<Documentation>
<UserDocu>Returns the G2 criterion at the parametric point U on the curve.
This is the greatest difference in curvature allowed between the constraint and the target surface at U.
Raises an exception if the curve is not on a surface.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setG0Criterion">
<Documentation>
<UserDocu>Allows you to set the G0 criterion. This is the law
defining the greatest distance allowed between the
constraint and the target surface for each point of the
constraint. If this criterion is not set, TolDist, the
distance tolerance from the constructor, is used.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setG1Criterion">
<Documentation>
<UserDocu>Allows you to set the G1 criterion. This is the law
defining the greatest angle allowed between the
constraint and the target surface. If this criterion is not
set, TolAng, the angular tolerance from the constructor, is used.
Raises an exception if the curve is not on a surface.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="setG2Criterion">
<Documentation>
<UserDocu> Allows you to set the G2 criterion. This is the law
defining the greatest difference in curvature allowed
between the constraint and the target surface. If this
criterion is not set, TolCurv, the curvature tolerance from
the constructor, is used.
Raises ConstructionError if the point is not on the surface.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="curve3d">
<Documentation>
<UserDocu>Returns a 3d curve associated the surface resulting of the constraints</UserDocu>
</Documentation>
</Methode>
<Methode Name="setCurve2dOnSurf">
<Documentation>
<UserDocu>Loads a 2d curve associated the surface resulting of the constraints
</UserDocu>
</Documentation>
</Methode>
<Methode Name="curve2dOnSurf">
<Documentation>
<UserDocu>Returns a 2d curve associated the surface resulting of the constraints</UserDocu>
</Documentation>
</Methode>
<Methode Name="setProjectedCurve">
<Documentation>
<UserDocu>Loads a 2d curve resulting from the normal projection of
the curve on the initial surface</UserDocu>
</Documentation>
</Methode>
<Methode Name="projectedCurve">
<Documentation>
<UserDocu> Returns the projected curve resulting from the normal projection of the
curve on the initial surface</UserDocu>
</Documentation>
</Methode>
<Attribute Name="NbPoints">
<Documentation>
<UserDocu>The number of points on the curve used as a
constraint. The default setting is 10. This parameter
affects computation time, which increases by the cube of
the number of points.</UserDocu>
</Documentation>
<Parameter Name="NbPoints" Type="Long"/>
</Attribute>
<Attribute Name="FirstParameter" ReadOnly="true">
<Documentation>
<UserDocu>This function returns the first parameter of the curve.
The first parameter is the lowest parametric value for the curve, which defines the starting point of the curve.</UserDocu>
</Documentation>
<Parameter Name="FirstParameter" Type="Float"/>
</Attribute>
<Attribute Name="LastParameter" ReadOnly="true">
<Documentation>
<UserDocu>This function returns the last parameter of the curve.
The last parameter is the highest parametric value for the curve, which defines the ending point of the curve.</UserDocu>
</Documentation>
<Parameter Name="LastParameter" Type="Float"/>
</Attribute>
<Attribute Name="Length" ReadOnly="true">
<Documentation>
<UserDocu>This function returns the length of the curve.
The length of the curve is a geometric property that indicates how long the curve is in the space.</UserDocu>
</Documentation>
<Parameter Name="Length" Type="Float"/>
</Attribute>
</PythonExport>
</GenerateModel>