diff --git a/src/Mod/Part/App/BRepFeat/MakePrismPy.xml b/src/Mod/Part/App/BRepFeat/MakePrismPy.xml
index 54a6e59fe1..817285ba83 100644
--- a/src/Mod/Part/App/BRepFeat/MakePrismPy.xml
+++ b/src/Mod/Part/App/BRepFeat/MakePrismPy.xml
@@ -45,10 +45,10 @@ basis shape, or the edge to the prismed shape.
- Assigns one of the following semantics.
- 1. to a height Length
- 2. to a face Until
- 3. from a face From to a height Until. Reconstructs the feature topologically according to the semantic option chosen.
+Assigns one of the following semantics.
+1. to a height Length
+2. to a face Until
+3. from a face From to a height Until. Reconstructs the feature topologically according to the semantic option chosen.
diff --git a/src/Mod/Part/App/Geom2d/ArcOfConic2dPy.xml b/src/Mod/Part/App/Geom2d/ArcOfConic2dPy.xml
index aeceac6e0a..6d3fe7b65d 100644
--- a/src/Mod/Part/App/Geom2d/ArcOfConic2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/ArcOfConic2dPy.xml
@@ -24,11 +24,11 @@
- returns the eccentricity value of the conic e.
- e = 0 for a circle
- 0 < e < 1 for an ellipse (e = 0 if MajorRadius = MinorRadius)
- e > 1 for a hyperbola
- e = 1 for a parabola
+returns the eccentricity value of the conic e.
+e = 0 for a circle
+0 < e < 1 for an ellipse (e = 0 if MajorRadius = MinorRadius)
+e > 1 for a hyperbola
+e = 1 for a parabola
diff --git a/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml b/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml
index 9901aacdbd..a567c133e4 100644
--- a/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml
@@ -77,8 +77,7 @@
Returns true if this B-Spline curve is rational.
- A B-Spline curve is rational if, at the time of construction,
- the weight table has been initialized.
+A B-Spline curve is rational if, at the time of construction, the weight table has been initialized.
@@ -89,86 +88,87 @@
Returns true if the distance between the start point and end point of
- this B-Spline curve is less than or equal to gp::Resolution().
+this B-Spline curve is less than or equal to gp::Resolution().
- increase(Int=Degree)
- Increases the degree of this B-Spline curve to Degree.
- As a result, the poles, weights and multiplicities tables
- are modified; the knots table is not changed. Nothing is
- done if Degree is less than or equal to the current degree.
+ increaseDegree(Int=Degree)
+
+Increases the degree of this B-Spline curve to Degree.
+As a result, the poles, weights and multiplicities tables
+are modified; the knots table is not changed. Nothing is
+done if Degree is less than or equal to the current degree.
increaseMultiplicity(int index, int mult)
- increaseMultiplicity(int start, int end, int mult)
- Increases multiplicity of knots up to mult.
+increaseMultiplicity(int start, int end, int mult)
+Increases multiplicity of knots up to mult.
- index: the index of a knot to modify (1-based)
- start, end: index range of knots to modify.
- If mult is lower or equal to the current multiplicity nothing is done.
- If mult is higher than the degree the degree is used.
+index: the index of a knot to modify (1-based)
+start, end: index range of knots to modify.
+If mult is lower or equal to the current multiplicity nothing is done.
+If mult is higher than the degree the degree is used.
incrementMultiplicity(int start, int end, int mult)
- Raises multiplicity of knots by mult.
+Raises multiplicity of knots by mult.
- start, end: index range of knots to modify.
+start, end: index range of knots to modify.
insertKnot(u, mult = 1, tol = 0.0)
- Inserts a knot value in the sequence of knots. If u is an existing knot the
- multiplicity is increased by mult.
+
+Inserts a knot value in the sequence of knots. If u is an existing knot the multiplicity is increased by mult.
insertKnots(list_of_floats, list_of_ints, tol = 0.0, bool_add = True)
- Inserts a set of knots values in the sequence of knots.
+Inserts a set of knots values in the sequence of knots.
- For each u = list_of_floats[i], mult = list_of_ints[i]
+For each u = list_of_floats[i], mult = list_of_ints[i]
- If u is an existing knot the multiplicity is increased by mult if bool_add is
- True, otherwise increased to mult.
+If u is an existing knot the multiplicity is increased by mult if bool_add is
+True, otherwise increased to mult.
- If u is not on the parameter range nothing is done.
+If u is not on the parameter range nothing is done.
- If the multiplicity is negative or null nothing is done. The new multiplicity
- is limited to the degree.
+If the multiplicity is negative or null nothing is done. The new multiplicity
+is limited to the degree.
- The tolerance criterion for knots equality is the max of Epsilon(U) and ParametricTolerance.
+The tolerance criterion for knots equality is the max of Epsilon(U) and ParametricTolerance.
removeKnot(Index, M, tol)
- Reduces the multiplicity of the knot of index Index to M.
- If M is equal to 0, the knot is removed.
- With a modification of this type, the array of poles is also modified.
- Two different algorithms are systematically used to compute the new
- poles of the curve. If, for each pole, the distance between the pole
- calculated using the first algorithm and the same pole calculated using
- the second algorithm, is less than Tolerance, this ensures that the curve
- is not modified by more than Tolerance. Under these conditions, true is
- returned; otherwise, false is returned.
+Reduces the multiplicity of the knot of index Index to M.
+If M is equal to 0, the knot is removed.
+With a modification of this type, the array of poles is also modified.
+Two different algorithms are systematically used to compute the new
+poles of the curve. If, for each pole, the distance between the pole
+calculated using the first algorithm and the same pole calculated using
+the second algorithm, is less than Tolerance, this ensures that the curve
+is not modified by more than Tolerance. Under these conditions, true is
+returned; otherwise, false is returned.
- A low tolerance is used to prevent modification of the curve.
- A high tolerance is used to 'smooth' the curve.
+A low tolerance is used to prevent modification of the curve.
+A high tolerance is used to 'smooth' the curve.
segment(u1,u2)
- Modifies this B-Spline curve by segmenting it.
+Modifies this B-Spline curve by segmenting it.
@@ -193,8 +193,7 @@
- Modifies this B-Spline curve by assigning P
- to the pole of index Index in the poles table.
+ Modifies this B-Spline curve by assigning P to the pole of index Index in the poles table.
@@ -230,27 +229,27 @@
Computes for this B-Spline curve the parametric tolerance (UTolerance)
- for a given 3D tolerance (Tolerance3D).
- If f(t) is the equation of this B-Spline curve, the parametric tolerance
- ensures that:
- |t1-t0| < UTolerance =""==> |f(t1)-f(t0)| < Tolerance3D
+for a given 3D tolerance (Tolerance3D).
+If f(t) is the equation of this B-Spline curve, the parametric tolerance ensures that:
+|t1-t0| < UTolerance =""==> |f(t1)-f(t0)| < Tolerance3D
movePoint(U, P, Index1, Index2)
- Moves the point of parameter U of this B-Spline curve to P.
- Index1 and Index2 are the indexes in the table of poles of this B-Spline curve
- of the first and last poles designated to be moved.
- Returns: (FirstModifiedPole, LastModifiedPole). They are the indexes of the
- first and last poles which are effectively modified.
+Moves the point of parameter U of this B-Spline curve to P.
+Index1 and Index2 are the indexes in the table of poles of this B-Spline curve
+of the first and last poles designated to be moved.
+
+Returns: (FirstModifiedPole, LastModifiedPole). They are the indexes of the
+first and last poles which are effectively modified.
Changes this B-Spline curve into a non-periodic curve.
- If this curve is already non-periodic, it is not modified.
+If this curve is already non-periodic, it is not modified.
@@ -260,15 +259,13 @@
- Assigns the knot of index Index in the knots table
- as the origin of this periodic B-Spline curve. As a consequence,
- the knots and poles tables are modified.
+ Assigns the knot of index Index in the knots table as the origin of this periodic B-Spline curve.
+As a consequence, the knots and poles tables are modified.
- Returns the multiplicity of the knot of index
- from the knots table of this B-Spline curve.
+ Returns the multiplicity of the knot of index from the knots table of this B-Spline curve.
@@ -279,33 +276,33 @@
Replaces this B-Spline curve by approximating a set of points.
- The function accepts keywords as arguments.
+The function accepts keywords as arguments.
- approximate2(Points = list_of_points)
+approximate2(Points = list_of_points)
- Optional arguments :
+Optional arguments :
- DegMin = integer (3) : Minimum degree of the curve.
- DegMax = integer (8) : Maximum degree of the curve.
- Tolerance = float (1e-3) : approximating tolerance.
- Continuity = string ('C2') : Desired continuity of the curve.
- Possible values : 'C0','G1','C1','G2','C2','C3','CN'
+DegMin = integer (3) : Minimum degree of the curve.
+DegMax = integer (8) : Maximum degree of the curve.
+Tolerance = float (1e-3) : approximating tolerance.
+Continuity = string ('C2') : Desired continuity of the curve.
+Possible values : 'C0','G1','C1','G2','C2','C3','CN'
- LengthWeight = float, CurvatureWeight = float, TorsionWeight = float
- If one of these arguments is not null, the functions approximates the
- points using variational smoothing algorithm, which tries to minimize
- additional criterium:
- LengthWeight*CurveLength + CurvatureWeight*Curvature + TorsionWeight*Torsion
- Continuity must be C0, C1 or C2, else defaults to C2.
+LengthWeight = float, CurvatureWeight = float, TorsionWeight = float
+If one of these arguments is not null, the functions approximates the
+points using variational smoothing algorithm, which tries to minimize
+additional criterium:
+LengthWeight*CurveLength + CurvatureWeight*Curvature + TorsionWeight*Torsion
+Continuity must be C0, C1 or C2, else defaults to C2.
- Parameters = list of floats : knot sequence of the approximated points.
- This argument is only used if the weights above are all null.
+Parameters = list of floats : knot sequence of the approximated points.
+This argument is only used if the weights above are all null.
- ParamType = string ('Uniform','Centripetal' or 'ChordLength')
- Parameterization type. Only used if weights and Parameters above aren't specified.
+ParamType = string ('Uniform','Centripetal' or 'ChordLength')
+Parameterization type. Only used if weights and Parameters above aren't specified.
- Note : Continuity of the spline defaults to C2. However, it may not be applied if
- it conflicts with other parameters ( especially DegMax ).
+Note : Continuity of the spline defaults to C2. However, it may not be applied if
+it conflicts with other parameters ( especially DegMax ).
@@ -316,35 +313,35 @@
Replaces this B-Spline curve by interpolating a set of points.
- The function accepts keywords as arguments.
+The function accepts keywords as arguments.
- interpolate(Points = list_of_points)
+interpolate(Points = list_of_points)
- Optional arguments :
+Optional arguments :
- PeriodicFlag = bool (False) : Sets the curve closed or opened.
- Tolerance = float (1e-6) : interpolating tolerance
+PeriodicFlag = bool (False) : Sets the curve closed or opened.
+Tolerance = float (1e-6) : interpolating tolerance
- Parameters : knot sequence of the interpolated points.
- If not supplied, the function defaults to chord-length parameterization.
- If PeriodicFlag == True, one extra parameter must be appended.
+Parameters : knot sequence of the interpolated points.
+If not supplied, the function defaults to chord-length parameterization.
+If PeriodicFlag == True, one extra parameter must be appended.
- EndPoint Tangent constraints :
+EndPoint Tangent constraints :
- InitialTangent = vector, FinalTangent = vector
- specify tangent vectors for starting and ending points
- of the BSpline. Either none, or both must be specified.
+InitialTangent = vector, FinalTangent = vector
+specify tangent vectors for starting and ending points
+of the BSpline. Either none, or both must be specified.
- Full Tangent constraints :
+Full Tangent constraints :
- Tangents = list_of_vectors, TangentFlags = list_of_bools
- Both lists must have the same length as Points list.
- Tangents specifies the tangent vector of each point in Points list.
- TangentFlags (bool) activates or deactivates the corresponding tangent.
- These arguments will be ignored if EndPoint Tangents (above) are also defined.
+Tangents = list_of_vectors, TangentFlags = list_of_bools
+Both lists must have the same length as Points list.
+Tangents specifies the tangent vector of each point in Points list.
+TangentFlags (bool) activates or deactivates the corresponding tangent.
+These arguments will be ignored if EndPoint Tangents (above) are also defined.
- Note : Continuity of the spline defaults to C2. However, if periodic, or tangents
- are supplied, the continuity will drop to C1.
+Note : Continuity of the spline defaults to C2. However, if periodic, or tangents
+are supplied, the continuity will drop to C1.
@@ -355,29 +352,29 @@
Builds a B-Spline by a lists of Poles, Mults, Knots.
- arguments: poles (sequence of Base.Vector),
- [mults , knots, periodic, degree, weights (sequence of float), CheckRational]
+arguments: poles (sequence of Base.Vector),
+[mults , knots, periodic, degree, weights (sequence of float), CheckRational]
- Examples:
- from FreeCAD import Base
- import Part
- V=Base.Vector
- poles=[V(-10,-10),V(10,-10),V(10,10),V(-10,10)]
+Examples:
+from FreeCAD import Base
+import Part
+V=Base.Vector
+poles=[V(-10,-10),V(10,-10),V(10,10),V(-10,10)]
- # non-periodic spline
- n=Part.BSplineCurve()
- n.buildFromPolesMultsKnots(poles,(3,1,3),(0,0.5,1),False,2)
- Part.show(n.toShape())
+# non-periodic spline
+n=Part.BSplineCurve()
+n.buildFromPolesMultsKnots(poles,(3,1,3),(0,0.5,1),False,2)
+Part.show(n.toShape())
- # periodic spline
- p=Part.BSplineCurve()
- p.buildFromPolesMultsKnots(poles,(1,1,1,1,1),(0,0.25,0.5,0.75,1),True,2)
- Part.show(p.toShape())
+# periodic spline
+p=Part.BSplineCurve()
+p.buildFromPolesMultsKnots(poles,(1,1,1,1,1),(0,0.25,0.5,0.75,1),True,2)
+Part.show(p.toShape())
- # periodic and rational spline
- r=Part.BSplineCurve()
- r.buildFromPolesMultsKnots(poles,(1,1,1,1,1),(0,0.25,0.5,0.75,1),True,2,(1,0.8,0.7,0.2))
- Part.show(r.toShape())
+# periodic and rational spline
+r=Part.BSplineCurve()
+r.buildFromPolesMultsKnots(poles,(1,1,1,1,1),(0,0.25,0.5,0.75,1),True,2,(1,0.8,0.7,0.2))
+Part.show(r.toShape())
@@ -387,8 +384,9 @@
- Build a list of arcs and lines to approximate the B-spline.
- toBiArcs(tolerance) -> list.
+ toBiArcs(tolerance) -> list.
+Build a list of arcs and lines to approximate the B-spline.
+
@@ -399,12 +397,13 @@
makeC1Continuous(tol = 1e-6, ang_tol = 1e-7)
- Reduces as far as possible the multiplicities of the knots of this BSpline
- (keeping the geometry). It returns a new BSpline, which could still be C0.
- tol is a geometrical tolerance.
- The tol_ang is angular tolerance, in radians. It sets tolerable angle mismatch
- of the tangents on the left and on the right to decide if the curve is G1 or
- not at a given point.
+
+Reduces as far as possible the multiplicities of the knots of this BSpline
+(keeping the geometry). It returns a new BSpline, which could still be C0.
+tol is a geometrical tolerance.
+The tol_ang is angular tolerance, in radians. It sets tolerable angle mismatch
+of the tangents on the left and on the right to decide if the curve is G1 or
+not at a given point.
diff --git a/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml b/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml
index 55869d5553..13af7f008a 100644
--- a/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml
@@ -14,20 +14,18 @@
Describes a rational or non-rational Bezier curve in 2d space:
- -- a non-rational Bezier curve is defined by a table of poles (also called control points)
- -- a rational Bezier curve is defined by a table of poles with varying weights
+ -- a non-rational Bezier curve is defined by a table of poles (also called control points)
+ -- a rational Bezier curve is defined by a table of poles with varying weights
- Returns the polynomial degree of this Bezier curve,
- which is equal to the number of poles minus 1.
+ Returns the polynomial degree of this Bezier curve, which is equal to the number of poles minus 1.
- Returns the value of the maximum polynomial degree of any
- Bezier curve curve. This value is 25.
+ Returns the value of the maximum polynomial degree of any Bezier curve curve. This value is 25.
@@ -61,15 +59,15 @@
- Returns true if the distance between the start point and end point of
- this Bezier curve is less than or equal to gp::Resolution().
+ Returns true if the distance between the start point and end point of this Bezier curve
+is less than or equal to gp::Resolution().
increase(Int=Degree)
- Increases the degree of this Bezier curve to Degree.
- As a result, the poles and weights tables are modified.
+Increases the degree of this Bezier curve to Degree.
+As a result, the poles and weights tables are modified.
@@ -85,7 +83,7 @@
Removes the pole of index Index from the table of poles of this Bezier curve.
- If this Bezier curve is rational, it can become non-rational.
+If this Bezier curve is rational, it can become non-rational.
@@ -131,10 +129,10 @@
Computes for this Bezier curve the parametric tolerance (UTolerance)
- for a given 3D tolerance (Tolerance3D).
- If f(t) is the equation of this Bezier curve,
- the parametric tolerance ensures that:
- |t1-t0| < UTolerance =""==> |f(t1)-f(t0)| < Tolerance3D
+for a given 3D tolerance (Tolerance3D).
+If f(t) is the equation of this Bezier curve,
+the parametric tolerance ensures that:
+|t1-t0| < UTolerance =""==> |f(t1)-f(t0)| < Tolerance3D
diff --git a/src/Mod/Part/App/Geom2d/Conic2dPy.xml b/src/Mod/Part/App/Geom2d/Conic2dPy.xml
index f86e5f12ea..8c08cecdf5 100644
--- a/src/Mod/Part/App/Geom2d/Conic2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Conic2dPy.xml
@@ -24,11 +24,11 @@
- returns the eccentricity value of the conic e.
- e = 0 for a circle
- 0 < e < 1 for an ellipse (e = 0 if MajorRadius = MinorRadius)
- e > 1 for a hyperbola
- e = 1 for a parabola
+returns the eccentricity value of the conic e.
+ e = 0 for a circle
+ 0 < e < 1 for an ellipse (e = 0 if MajorRadius = MinorRadius)
+ e > 1 for a hyperbola
+ e = 1 for a parabola
diff --git a/src/Mod/Part/App/Geom2d/Curve2dPy.xml b/src/Mod/Part/App/Geom2d/Curve2dPy.xml
index 33f5050ec1..7e2989e411 100644
--- a/src/Mod/Part/App/Geom2d/Curve2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Curve2dPy.xml
@@ -65,17 +65,17 @@ Part.show(s)
- Computes the length of a curve
- length([uMin,uMax,Tol]) -> Float
+Computes the length of a curve
+length([uMin,uMax,Tol]) -> Float
- Returns the parameter on the curve of a point at
- the given distance from a starting parameter.
- parameterAtDistance([abscissa, startingParameter]) -> Float
+Returns the parameter on the curve of a point at
+the given distance from a starting parameter.
+parameterAtDistance([abscissa, startingParameter]) -> Float
@@ -92,52 +92,52 @@ Part.show(s)
- Returns the parameter on the curve of the
- nearest orthogonal projection of the point.
+Returns the parameter on the curve of the
+nearest orthogonal projection of the point.
- Vector = normal(pos) - Get the normal vector at the given parameter [First|Last] if defined.
+Vector = normal(pos) - Get the normal vector at the given parameter [First|Last] if defined.
- Float = curvature(pos) - Get the curvature at the given parameter [First|Last] if defined.
+Float = curvature(pos) - Get the curvature at the given parameter [First|Last] if defined.
- Vector = centerOfCurvature(float pos) - Get the center of curvature at the given parameter [First|Last] if defined.
+Vector = centerOfCurvature(float pos) - Get the center of curvature at the given parameter [First|Last] if defined.
- Returns all intersection points between this curve and the given curve.
+Returns all intersection points between this curve and the given curve.
- Converts a curve of any type (only part from First to Last)
- toBSpline([Float=First, Float=Last]) -> B-Spline curve
+Converts a curve of any type (only part from First to Last)
+toBSpline([Float=First, Float=Last]) -> B-Spline curve
- Approximates a curve of any type to a B-Spline curve
- approximateBSpline(Tolerance, MaxSegments, MaxDegree, [Order='C2']) -> B-Spline curve
+Approximates a curve of any type to a B-Spline curve
+approximateBSpline(Tolerance, MaxSegments, MaxDegree, [Order='C2']) -> B-Spline curve
diff --git a/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml b/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml
index 2412cdd68b..fa177ab03b 100644
--- a/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml
@@ -14,24 +14,24 @@
- Describes an ellipse in 2D space
- To create an ellipse there are several ways:
- Part.Geom2d.Ellipse2d()
- Creates an ellipse with major radius 2 and minor radius 1 with the
- center in (0,0)
+Describes an ellipse in 2D space
+To create an ellipse there are several ways:
+Part.Geom2d.Ellipse2d()
+ Creates an ellipse with major radius 2 and minor radius 1 with the
+ center in (0,0)
- Part.Geom2d.Ellipse2d(Ellipse)
- Create a copy of the given ellipse
+Part.Geom2d.Ellipse2d(Ellipse)
+ Create a copy of the given ellipse
- Part.Geom2d.Ellipse2d(S1,S2,Center)
- Creates an ellipse centered on the point Center,
- its major axis is defined by Center and S1,
- its major radius is the distance between Center and S1, and
- its minor radius is the distance between S2 and the major axis.
+Part.Geom2d.Ellipse2d(S1,S2,Center)
+ Creates an ellipse centered on the point Center,
+ its major axis is defined by Center and S1,
+ its major radius is the distance between Center and S1, and
+ its minor radius is the distance between S2 and the major axis.
- Part.Geom2d.Ellipse2d(Center,MajorRadius,MinorRadius)
- Creates an ellipse with major and minor radii MajorRadius and
- MinorRadius
+Part.Geom2d.Ellipse2d(Center,MajorRadius,MinorRadius)
+ Creates an ellipse with major and minor radii MajorRadius and
+ MinorRadius
diff --git a/src/Mod/Part/App/Geom2d/Geometry2dPy.xml b/src/Mod/Part/App/Geom2d/Geometry2dPy.xml
index 743b2f3c80..543efdc6a4 100644
--- a/src/Mod/Part/App/Geom2d/Geometry2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Geometry2dPy.xml
@@ -15,9 +15,9 @@
The abstract class Geometry for 2D space is the root class of all geometric objects.
- It describes the common behavior of these objects when:
- - applying geometric transformations to objects, and
- - constructing objects by geometric transformation (including copying).
+It describes the common behavior of these objects when:
+- applying geometric transformations to objects, and
+- constructing objects by geometric transformation (including copying).
diff --git a/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml b/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml
index 24c8bfcf1e..545828fc3b 100644
--- a/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml
@@ -14,23 +14,23 @@
Describes a hyperbola in 2D space
- To create a hyperbola there are several ways:
- Part.Geom2d.Hyperbola2d()
- Creates a hyperbola with major radius 2 and minor radius 1 with the
- center in (0,0)
+To create a hyperbola there are several ways:
+Part.Geom2d.Hyperbola2d()
+ Creates a hyperbola with major radius 2 and minor radius 1 with the
+ center in (0,0)
- Part.Geom2d.Hyperbola2d(Hyperbola)
- Create a copy of the given hyperbola
+Part.Geom2d.Hyperbola2d(Hyperbola)
+ Create a copy of the given hyperbola
- Part.Geom2d.Hyperbola2d(S1,S2,Center)
- Creates a hyperbola centered on the point Center, S1 and S2,
- its major axis is defined by Center and S1,
- its major radius is the distance between Center and S1, and
- its minor radius is the distance between S2 and the major axis.
+Part.Geom2d.Hyperbola2d(S1,S2,Center)
+ Creates a hyperbola centered on the point Center, S1 and S2,
+ its major axis is defined by Center and S1,
+ its major radius is the distance between Center and S1, and
+ its minor radius is the distance between S2 and the major axis.
- Part.Geom2d.Hyperbola2d(Center,MajorRadius,MinorRadius)
- Creates a hyperbola with major and minor radii MajorRadius and
- MinorRadius and located at Center
+Part.Geom2d.Hyperbola2d(Center,MajorRadius,MinorRadius)
+ Creates a hyperbola with major and minor radii MajorRadius and
+ MinorRadius and located at Center
@@ -53,16 +53,14 @@
The first focus is on the positive side of the major axis of the hyperbola;
- the second focus is on the negative side.
+the second focus is on the negative side.
-
- The first focus is on the positive side of the major axis of the hyperbola;
- the second focus is on the negative side.
-
+ The first focus is on the positive side of the major axis of the hyperbola;
+the second focus is on the negative side.
diff --git a/src/Mod/Part/App/Geom2d/Line2dPy.xml b/src/Mod/Part/App/Geom2d/Line2dPy.xml
index 90b5ac87f5..ce2f91e955 100644
--- a/src/Mod/Part/App/Geom2d/Line2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Line2dPy.xml
@@ -14,15 +14,15 @@
Describes an infinite line in 2D space
- To create a line there are several ways:
- Part.Geom2d.Line2d()
- Creates a default line.
+To create a line there are several ways:
+Part.Geom2d.Line2d()
+ Creates a default line.
- Part.Geom2d.Line2d(Line)
- Creates a copy of the given line.
+Part.Geom2d.Line2d(Line)
+ Creates a copy of the given line.
- Part.Geom2d.Line2d(Point,Dir)
- Creates a line that goes through two given points.
+Part.Geom2d.Line2d(Point,Dir)
+ Creates a line that goes through two given points.
diff --git a/src/Mod/Part/App/Geom2d/Line2dSegmentPy.xml b/src/Mod/Part/App/Geom2d/Line2dSegmentPy.xml
index b915ca80fc..13738d3750 100644
--- a/src/Mod/Part/App/Geom2d/Line2dSegmentPy.xml
+++ b/src/Mod/Part/App/Geom2d/Line2dSegmentPy.xml
@@ -15,15 +15,15 @@
Describes a line segment in 2D space.
- To create a line there are several ways:
- Part.Geom2d.Line2dSegment()
- Creates a default line
+To create a line there are several ways:
+Part.Geom2d.Line2dSegment()
+ Creates a default line
- Part.Geom2d.Line2dSegment(Line)
- Creates a copy of the given line
+Part.Geom2d.Line2dSegment(Line)
+ Creates a copy of the given line
- Part.Geom2d.Line2dSegment(Point1,Point2)
- Creates a line that goes through two given points.
+Part.Geom2d.Line2dSegment(Point1,Point2)
+ Creates a line that goes through two given points.
diff --git a/src/Mod/Part/App/Geom2d/Parabola2dPy.xml b/src/Mod/Part/App/Geom2d/Parabola2dPy.xml
index 32cb935c06..416b75332b 100644
--- a/src/Mod/Part/App/Geom2d/Parabola2dPy.xml
+++ b/src/Mod/Part/App/Geom2d/Parabola2dPy.xml
@@ -17,23 +17,21 @@
- The focal distance is the distance between
- the apex and the focus of the parabola.
+ The focal distance is the distance between the apex and the focus of the parabola.
The focus is on the positive side of the
- 'X Axis' of the local coordinate system of the parabola.
+'X Axis' of the local coordinate system of the parabola.
- Compute the parameter of this parabola
- which is the distance between its focus
- and its directrix. This distance is twice the focal length.
+ Compute the parameter of this parabola which is the distance between its focus
+and its directrix. This distance is twice the focal length.
diff --git a/src/Mod/Part/App/GeomPlate/BuildPlateSurfacePy.xml b/src/Mod/Part/App/GeomPlate/BuildPlateSurfacePy.xml
index 4575e85cd2..61d650532b 100644
--- a/src/Mod/Part/App/GeomPlate/BuildPlateSurfacePy.xml
+++ b/src/Mod/Part/App/GeomPlate/BuildPlateSurfacePy.xml
@@ -28,12 +28,12 @@
- Loads the initial surface
+ Loads the initial surface
- Returns the initial surface
+ Returns the initial surface
@@ -69,7 +69,7 @@
Extracts the array of curves on the plate surface which
- correspond to the curve constraints set in add()
+correspond to the curve constraints set in add()
diff --git a/src/Mod/Part/App/GeomPlate/CurveConstraintPy.xml b/src/Mod/Part/App/GeomPlate/CurveConstraintPy.xml
index 941d20c07a..19826a86da 100644
--- a/src/Mod/Part/App/GeomPlate/CurveConstraintPy.xml
+++ b/src/Mod/Part/App/GeomPlate/CurveConstraintPy.xml
@@ -18,8 +18,7 @@
- Allows you to set the order of continuity required for
-the constraints: G0, G1, and G2, controlled
+ Allows you to set the order of continuity required for the constraints: G0, G1, and G2, controlled
respectively by G0Criterion G1Criterion and G2Criterion.
@@ -31,27 +30,24 @@ respectively by G0Criterion G1Criterion and G2Criterion.
- 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.
+ 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.
- 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.
+ 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.
- 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.
+ 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.
@@ -71,47 +67,47 @@ distance tolerance from the constructor, is used.
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
+Raises an exception if the curve is not on a surface.
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
+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.
- Returns a 3d curve associated the surface resulting of the constraints
+ Returns a 3d curve associated the surface resulting of the constraints
- loads a 2d curve associated the surface resulting of the constraints
+ Loads a 2d curve associated the surface resulting of the constraints
- Returns a 2d curve associated the surface resulting of the constraints
+ Returns a 2d curve associated the surface resulting of the constraints
- loads a 2d curve resulting from the normal projection of
- the curve on the initial surface
+ Loads a 2d curve resulting from the normal projection of
+the curve on the initial surface
Returns the projected curve resulting from the normal projection of the
- curve on the initial surface
+curve on the initial surface
@@ -125,21 +121,21 @@ the number of points.
- This function returns the first parameter of the curve.
+ 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.
- This function returns the last parameter of the curve.
+ 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.
- This function returns the length of the curve.
+ 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.
diff --git a/src/Mod/Part/App/GeomPlate/PointConstraintPy.xml b/src/Mod/Part/App/GeomPlate/PointConstraintPy.xml
index 60c9699e3f..fba487c4aa 100644
--- a/src/Mod/Part/App/GeomPlate/PointConstraintPy.xml
+++ b/src/Mod/Part/App/GeomPlate/PointConstraintPy.xml
@@ -78,10 +78,10 @@ Raises an exception if the curve is not on a surface
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 curve is not on a surface
+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 curve is not on a surface
diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
index 22f810bfa4..6dea227744 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_AlgoPy.xml
@@ -160,7 +160,7 @@ Select only the edges of the shape of index i.
selectFace(i)
-
+
Select only the faces of the shape of index i.
@@ -177,7 +177,7 @@ shell.
update()
-
+
Update the DataStructure.
@@ -190,6 +190,6 @@ public:
Handle(HLRBRep_Algo) handle() {
return hAlgo;
}
-
+
diff --git a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
index 253c2ffe25..0b56efc494 100644
--- a/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
+++ b/src/Mod/Part/App/HLRBRep/HLRBRep_PolyAlgoPy.xml
@@ -178,6 +178,6 @@ public:
Handle(HLRBRep_PolyAlgo) handle() {
return hAlgo;
}
-
+
diff --git a/src/Mod/Part/App/ShapeFix/ShapeFix_EdgePy.xml b/src/Mod/Part/App/ShapeFix/ShapeFix_EdgePy.xml
index 602230b643..aa50f22307 100644
--- a/src/Mod/Part/App/ShapeFix/ShapeFix_EdgePy.xml
+++ b/src/Mod/Part/App/ShapeFix/ShapeFix_EdgePy.xml
@@ -19,117 +19,117 @@
Removes the pcurve(s) of the edge if it does not match the
- vertices
- Check is done
- Use : It is to be called when pcurve of an edge can be wrong
- (e.g., after import from IGES)
- Returns: True, if does not match, removed (status DONE)
- False, (status OK) if matches or (status FAIL) if no pcurve,
- nothing done.
+vertices
+Check is done
+Use : It is to be called when pcurve of an edge can be wrong
+(e.g., after import from IGES)
+Returns: True, if does not match, removed (status DONE)
+False, (status OK) if matches or (status FAIL) if no pcurve,
+nothing done.
Removes 3d curve of the edge if it does not match the vertices
- Returns: True, if does not match, removed (status DONE)
- False, (status OK) if matches or (status FAIL) if no 3d curve,
- nothing done.
+Returns: True, if does not match, removed (status DONE)
+False, (status OK) if matches or (status FAIL) if no 3d curve,
+nothing done.
Adds pcurve(s) of the edge if missing (by projecting 3d curve)
- Parameter isSeam indicates if the edge is a seam.
- The parameter 'prec' defines the precision for calculations.
- If it is 0 (default), the tolerance of the edge is taken.
- Remark : This method is rather for internal use since it accepts parameter
- 'surfana' for optimization of computations
- Use : It is to be called after FixRemovePCurve (if removed) or in any
- case when edge can have no pcurve
- Returns: True if pcurve was added, else False
- Status :
- OK : Pcurve exists
- FAIL1: No 3d curve
- FAIL2: fail during projecting
- DONE1: Pcurve was added
- DONE2: specific case of pcurve going through degenerated point on
- sphere encountered during projection (see class
- ShapeConstruct_ProjectCurveOnSurface for more info).
+Parameter isSeam indicates if the edge is a seam.
+The parameter 'prec' defines the precision for calculations.
+If it is 0 (default), the tolerance of the edge is taken.
+Remark : This method is rather for internal use since it accepts parameter
+'surfana' for optimization of computations
+Use : It is to be called after FixRemovePCurve (if removed) or in any
+case when edge can have no pcurve
+Returns: True if pcurve was added, else False
+Status :
+OK : Pcurve exists
+FAIL1: No 3d curve
+FAIL2: fail during projecting
+DONE1: Pcurve was added
+DONE2: specific case of pcurve going through degenerated point on
+sphere encountered during projection (see class
+ShapeConstruct_ProjectCurveOnSurface for more info).
- Tries to build 3d curve of the edge if missing
- Use : It is to be called after FixRemoveCurve3d (if removed) or in any
- case when edge can have no 3d curve
- Returns: True if 3d curve was added, else False
- Status :
- OK : 3d curve exists
- FAIL1: BRepLib::BuildCurve3d() has failed
- DONE1: 3d curve was added.
+ Tries to build 3d curve of the edge if missing
+Use : It is to be called after FixRemoveCurve3d (if removed) or in any
+case when edge can have no 3d curve
+Returns: True if 3d curve was added, else False
+Status :
+OK : 3d curve exists
+FAIL1: BRepLib::BuildCurve3d() has failed
+DONE1: 3d curve was added.
- Increases the tolerances of the edge vertices to comprise
- the ends of 3d curve and pcurve on the given face
- (first method) or all pcurves stored in an edge (second one)
- Returns: True, if tolerances have been increased, otherwise False
- Status:
- OK : the original tolerances have not been changed
- DONE1: the tolerance of first vertex has been increased
- DONE2: the tolerance of last vertex has been increased.
+ Increases the tolerances of the edge vertices to comprise
+the ends of 3d curve and pcurve on the given face
+(first method) or all pcurves stored in an edge (second one)
+Returns: True, if tolerances have been increased, otherwise False
+Status:
+OK : the original tolerances have not been changed
+DONE1: the tolerance of first vertex has been increased
+DONE2: the tolerance of last vertex has been increased.
- Fixes edge if pcurve is directed opposite to 3d curve
- Check is done by call to the function
- ShapeAnalysis_Edge::CheckCurve3dWithPCurve()
- Warning: For seam edge this method will check and fix the pcurve in only
- one direction. Hence, it should be called twice for seam edge:
- once with edge orientation FORWARD and once with REVERSED.
- Returns: False if nothing done, True if reversed (status DONE)
- Status: OK - pcurve OK, nothing done
- FAIL1 - no pcurve
- FAIL2 - no 3d curve
- DONE1 - pcurve was reversed.
+ Fixes edge if pcurve is directed opposite to 3d curve
+Check is done by call to the function
+ShapeAnalysis_Edge::CheckCurve3dWithPCurve()
+Warning: For seam edge this method will check and fix the pcurve in only
+one direction. Hence, it should be called twice for seam edge:
+once with edge orientation FORWARD and once with REVERSED.
+Returns: False if nothing done, True if reversed (status DONE)
+Status: OK - pcurve OK, nothing done
+FAIL1 - no pcurve
+FAIL2 - no 3d curve
+DONE1 - pcurve was reversed.
Tries to make edge SameParameter and sets corresponding
- tolerance and SameParameter flag.
- First, it makes edge same range if SameRange flag is not set.
- If flag SameParameter is set, this method calls the
- function ShapeAnalysis_Edge::CheckSameParameter() that
- calculates the maximal deviation of pcurves of the edge from
- its 3d curve. If deviation > tolerance, the tolerance of edge
- is increased to a value of deviation. If deviation < tolerance
- nothing happens.
+tolerance and SameParameter flag.
+First, it makes edge same range if SameRange flag is not set.
+If flag SameParameter is set, this method calls the
+function ShapeAnalysis_Edge::CheckSameParameter() that
+calculates the maximal deviation of pcurves of the edge from
+its 3d curve. If deviation > tolerance, the tolerance of edge
+is increased to a value of deviation. If deviation < tolerance
+nothing happens.
- If flag SameParameter is not set, this method chooses the best
- variant (one that has minimal tolerance), either
- a. only after computing deviation (as above) or
- b. after calling standard procedure BRepLib::SameParameter
- and computing deviation (as above). If 'tolerance' > 0, it is
- used as parameter for BRepLib::SameParameter, otherwise,
- tolerance of the edge is used.
+If flag SameParameter is not set, this method chooses the best
+variant (one that has minimal tolerance), either
+a. only after computing deviation (as above) or
+b. after calling standard procedure BRepLib::SameParameter
+and computing deviation (as above). If 'tolerance' > 0, it is
+used as parameter for BRepLib::SameParameter, otherwise,
+tolerance of the edge is used.
- Use : Is to be called after all pcurves and 3d curve of the edge are
- correctly computed
- Remark : SameParameter flag is always set to True after this method
- Returns: True, if something done, else False
- Status : OK - edge was initially SameParameter, nothing is done
- FAIL1 - computation of deviation of pcurves from 3d curve has failed
- FAIL2 - BRepLib::SameParameter() has failed
- DONE1 - tolerance of the edge was increased
- DONE2 - flag SameParameter was set to True (only if
- BRepLib::SameParameter() did not set it)
- DONE3 - edge was modified by BRepLib::SameParameter() to SameParameter
- DONE4 - not used anymore
- DONE5 - if the edge resulting from BRepLib has been chosen, i.e. variant b. above
- (only for edges with not set SameParameter).
+Use : Is to be called after all pcurves and 3d curve of the edge are
+correctly computed
+Remark : SameParameter flag is always set to True after this method
+Returns: True, if something done, else False
+Status : OK - edge was initially SameParameter, nothing is done
+FAIL1 - computation of deviation of pcurves from 3d curve has failed
+FAIL2 - BRepLib::SameParameter() has failed
+DONE1 - tolerance of the edge was increased
+DONE2 - flag SameParameter was set to True (only if
+BRepLib::SameParameter() did not set it)
+DONE3 - edge was modified by BRepLib::SameParameter() to SameParameter
+DONE4 - not used anymore
+DONE5 - if the edge resulting from BRepLib has been chosen, i.e. variant b. above
+(only for edges with not set SameParameter).
@@ -141,6 +141,6 @@ public:
setTwinPointer(handle.get());
hEdge = handle;
}
-
+
diff --git a/src/Mod/Part/App/ShapeFix/ShapeFix_FixSmallFacePy.xml b/src/Mod/Part/App/ShapeFix/ShapeFix_FixSmallFacePy.xml
index c13a42057d..f0053e4ce6 100644
--- a/src/Mod/Part/App/ShapeFix/ShapeFix_FixSmallFacePy.xml
+++ b/src/Mod/Part/App/ShapeFix/ShapeFix_FixSmallFacePy.xml
@@ -63,7 +63,7 @@
Fixes cases related to split faces within the given shape.
- It may return a modified shape after fixing the issues.
+It may return a modified shape after fixing the issues.