diff --git a/src/Mod/Part/App/BRepOffsetAPI_MakePipeShellPy.xml b/src/Mod/Part/App/BRepOffsetAPI_MakePipeShellPy.xml index 046cbc7bc2..12b4675667 100644 --- a/src/Mod/Part/App/BRepOffsetAPI_MakePipeShellPy.xml +++ b/src/Mod/Part/App/BRepOffsetAPI_MakePipeShellPy.xml @@ -1,210 +1,168 @@ - + - - - - Describes a portion of a circle - - - - - setFrenetMode(True|False) - Sets a Frenet or a CorrectedFrenet trihedron to perform the sweeping. - True = Frenet - False = CorrectedFrenet - - - - - - - setTrihedronMode(point,direction) - Sets a fixed trihedron to perform the sweeping. - All sections will be parallel. - - - - - - - setBiNormalMode(direction) - Sets a fixed BiNormal direction to perform the sweeping. - Angular relations between the section(s) and the BiNormal direction will be constant. - - - - - - - setSpineSupport(shape) - Sets support to the spine to define the BiNormal of the trihedron, like the normal to the surfaces. - Warning: To be effective, Each edge of the spine must have an representation on one face of SpineSupport. - - - - - - - setAuxiliarySpine(wire, CurvilinearEquivalence, TypeOfContact) - Sets an auxiliary spine to define the Normal. + + + + Describes a portion of a circle + + + + setFrenetMode(True|False) + Sets a Frenet or a CorrectedFrenet trihedron to perform the sweeping. + True = Frenet + False = CorrectedFrenet + + + + + setTrihedronMode(point,direction) + Sets a fixed trihedron to perform the sweeping. + All sections will be parallel. + + + + + setBiNormalMode(direction) + Sets a fixed BiNormal direction to perform the sweeping. + Angular relations between the section(s) and the BiNormal direction will be constant. + + + + + setSpineSupport(shape) + Sets support to the spine to define the BiNormal of the trihedron, like the normal to the surfaces. + Warning: To be effective, Each edge of the spine must have an representation on one face of SpineSupport. + + + + + setAuxiliarySpine(wire, CurvilinearEquivalence, TypeOfContact) + Sets an auxiliary spine to define the Normal. - CurvilinearEquivalence = bool - For each Point of the Spine P, an Point Q is evalued on AuxiliarySpine. - If CurvilinearEquivalence=True Q split AuxiliarySpine with the same length ratio than P split Spine. + CurvilinearEquivalence = bool + For each Point of the Spine P, an Point Q is evalued on AuxiliarySpine. + If CurvilinearEquivalence=True Q split AuxiliarySpine with the same length ratio than P split Spine. - * OCC >= 6.7 - TypeOfContact = long - 0: No contact - 1: Contact - 2: Contact On Border (The auxiliary spine becomes a boundary of the swept surface) - - - - - - - add(shape Profile, bool WithContact=False, bool WithCorrection=False) - add(shape Profile, vertex Location, bool WithContact=False, bool WithCorrection=False) - Adds the section Profile to this framework. - First and last sections may be punctual, so the shape Profile may be both wire and vertex. - If WithContact is true, the section is translated to be in contact with the spine. - If WithCorrection is true, the section is rotated to be orthogonal to the spine tangent in the correspondent point. - - - - - - - remove(shape Profile) - Removes the section Profile from this framework. - - - - - - - isReady() - Returns true if this tool object is ready to build the shape. - - - - - - - getStatus() - Get a status, when Simulate or Build failed. - - - - - - - makeSolid() - Transforms the sweeping Shell in Solid. If a propfile is not closed returns False. - - - - - - - setTolerance( tol3d, boundTol, tolAngular) - Tol3d = 3D tolerance - BoundTol = boundary tolerance - TolAngular = angular tolerance - - - - - - - 0: BRepBuilderAPI_Transformed - 1: BRepBuilderAPI_RightCorner - 2: BRepBuilderAPI_RoundCorner - - - - - - - firstShape() - Returns the Shape of the bottom of the sweep. - - - - - - - lastShape() - Returns the Shape of the top of the sweep. - - - - - - - build() - Builds the resulting shape. - - - - - - - shape() - Returns the resulting shape. - - - - - - - generated(shape S) - Returns a list of new shapes generated from the shape S by the shell-generating algorithm. - - - - - - - setMaxDegree(int degree) - Define the maximum V degree of resulting surface. - - - - - - - setMaxSegments(int num) - Define the maximum number of spans in V-direction on resulting surface. - - - - - - - setForceApproxC1(bool) - Set the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0. - - - - - - - simulate(int nbsec) - Simulates the resulting shape by calculating the given number of cross-sections. - - - - + * OCC >= 6.7 + TypeOfContact = long + 0: No contact + 1: Contact + 2: Contact On Border (The auxiliary spine becomes a boundary of the swept surface) + + + + + add(shape Profile, bool WithContact=False, bool WithCorrection=False) + add(shape Profile, vertex Location, bool WithContact=False, bool WithCorrection=False) + Adds the section Profile to this framework. + First and last sections may be punctual, so the shape Profile may be both wire and vertex. + If WithContact is true, the section is translated to be in contact with the spine. + If WithCorrection is true, the section is rotated to be orthogonal to the spine tangent in the correspondent point. + + + + + remove(shape Profile) + Removes the section Profile from this framework. + + + + + isReady() + Returns true if this tool object is ready to build the shape. + + + + + getStatus() + Get a status, when Simulate or Build failed. + + + + + makeSolid() + Transforms the sweeping Shell in Solid. If a propfile is not closed returns False. + + + + + setTolerance( tol3d, boundTol, tolAngular) + Tol3d = 3D tolerance + BoundTol = boundary tolerance + TolAngular = angular tolerance + + + + + 0: BRepBuilderAPI_Transformed + 1: BRepBuilderAPI_RightCorner + 2: BRepBuilderAPI_RoundCorner + + + + + firstShape() + Returns the Shape of the bottom of the sweep. + + + + + lastShape() + Returns the Shape of the top of the sweep. + + + + + build() + Builds the resulting shape. + + + + + shape() + Returns the resulting shape. + + + + + generated(shape S) + Returns a list of new shapes generated from the shape S by the shell-generating algorithm. + + + + + setMaxDegree(int degree) + Define the maximum V degree of resulting surface. + + + + + setMaxSegments(int num) + Define the maximum number of spans in V-direction on resulting surface. + + + + + setForceApproxC1(bool) + Set the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0. + + + + + simulate(int nbsec) + Simulates the resulting shape by calculating the given number of cross-sections. + + + diff --git a/src/Mod/Part/App/BezierCurvePy.xml b/src/Mod/Part/App/BezierCurvePy.xml index 214bc69b20..19fcb86a43 100644 --- a/src/Mod/Part/App/BezierCurvePy.xml +++ b/src/Mod/Part/App/BezierCurvePy.xml @@ -1,170 +1,165 @@ - - - - - - - Describes a rational or non-rational Bezier curve: - -- 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 - - Constructor takes no arguments. - - Example usage: - p1 = Base.Vector(-1, 0, 0) - p2 = Base.Vector(0, 1, 0.2) - p3 = Base.Vector(1, 0, 0.4) - p4 = Base.Vector(0, -1, 1) - - bc = BezierCurve() - bc.setPoles([p1, p2, p3, p4]) - curveShape = bc.toShape() - - - - - 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 number of poles of this Bezier curve. - - - - - - - Returns the start point of this Bezier curve. - - - - - - Returns the end point of this Bezier curve. - - - - - - Returns false if the weights of all the poles of this Bezier curve are equal. - - - - - Returns false. - - - - - 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. - - - - - Inserts after the pole of index. - - - - - Inserts before the pole of index. - - - - - 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. - - - - - Modifies this Bezier curve by segmenting it. - - - - - Set a pole of the Bezier curve. - - - - - Get a pole of the Bezier curve. - - - - - Get all poles of the Bezier curve. - - - - - Set the poles of the Bezier curve. - - Takes a list of 3D Base.Vector objects. - - - - - (id, weight) Set a weight of the Bezier curve. - - - - - - Get a weight of the Bezier curve. - - - - - Get all weights of the Bezier curve. - - - - - 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 - - - - - Interpolates a list of constraints. - Each constraint is a list of a point and some optional derivatives - An optional list of parameters can be passed. It must be of same size as constraint list. - Otherwise, a simple uniform parametrization is used. - Example : - bezier.interpolate([[pt1, deriv11, deriv12], [pt2,], [pt3, deriv31]], [0, 0.4, 1.0]) - - - - + + + + + + Describes a rational or non-rational Bezier curve: + -- 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 + + Constructor takes no arguments. + + Example usage: + p1 = Base.Vector(-1, 0, 0) + p2 = Base.Vector(0, 1, 0.2) + p3 = Base.Vector(1, 0, 0.4) + p4 = Base.Vector(0, -1, 1) + + bc = BezierCurve() + bc.setPoles([p1, p2, p3, p4]) + curveShape = bc.toShape() + + + + 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 number of poles of this Bezier curve. + + + + + + Returns the start point of this Bezier curve. + + + + + + Returns the end point of this Bezier curve. + + + + + + Returns false if the weights of all the poles of this Bezier curve are equal. + + + + + Returns false. + + + + + 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. + + + + + Inserts after the pole of index. + + + + + Inserts before the pole of index. + + + + + 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. + + + + + Modifies this Bezier curve by segmenting it. + + + + + Set a pole of the Bezier curve. + + + + + Get a pole of the Bezier curve. + + + + + Get all poles of the Bezier curve. + + + + + Set the poles of the Bezier curve. + + Takes a list of 3D Base.Vector objects. + + + + + (id, weight) Set a weight of the Bezier curve. + + + + + Get a weight of the Bezier curve. + + + + + Get all weights of the Bezier curve. + + + + + 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 + + + + + Interpolates a list of constraints. + Each constraint is a list of a point and some optional derivatives + An optional list of parameters can be passed. It must be of same size as constraint list. + Otherwise, a simple uniform parametrization is used. + Example : + bezier.interpolate([[pt1, deriv11, deriv12], [pt2,], [pt3, deriv31]], [0, 0.4, 1.0]) + + + + diff --git a/src/Mod/Part/App/BezierSurfacePy.xml b/src/Mod/Part/App/BezierSurfacePy.xml index 8658710289..96a88d9d2d 100644 --- a/src/Mod/Part/App/BezierSurfacePy.xml +++ b/src/Mod/Part/App/BezierSurfacePy.xml @@ -1,312 +1,263 @@ - - - - - - Describes a rational or non-rational Bezier surface - -- A non-rational Bezier surface is defined by a table of poles (also known as control points). - -- A rational Bezier surface is defined by a table of poles with varying associated weights. - - - - - - Returns the polynomial degree in u direction of this Bezier surface, - which is equal to the number of poles minus 1. - - - - - - - - Returns the polynomial degree in v direction of this Bezier surface, - which is equal to the number of poles minus 1. - - - - - - - - Returns the value of the maximum polynomial degree of any - Bezier surface. This value is 25. - - - - - - - - Returns the number of poles in u direction of this Bezier surface. - - - - - - - - Returns the number of poles in v direction of this Bezier surface. - - - - - - - - Returns the parametric bounds (U1, U2, V1, V2) of this Bezier surface. - - - - - - - Returns false if the equation of this Bezier surface is polynomial - (e.g. non-rational) in the u or v parametric direction. - In other words, returns false if for each row of poles, the associated - weights are identical - - - - - - - Returns false if the equation of this Bezier surface is polynomial - (e.g. non-rational) in the u or v parametric direction. - In other words, returns false if for each column of poles, the associated - weights are identical - - - - - - Returns false. - - - - - Returns false. - - - - - - Checks if this surface is closed in the u parametric direction. - Returns true if, in the table of poles the first row and the last - row are identical. - - - - - - - Checks if this surface is closed in the v parametric direction. - Returns true if, in the table of poles the first column and the - last column are identical. - - - - - - - increase(Int=DegreeU,Int=DegreeV) - Increases the degree of this Bezier surface in the two - parametric directions. - - - - - - - Inserts into the table of poles of this surface, after the column - of poles of index. - If this Bezier surface is non-rational, it can become rational if - the weights associated with the new poles are different from each - other, or collectively different from the existing weights in the - table. - - - - - - - Inserts into the table of poles of this surface, after the row - of poles of index. - If this Bezier surface is non-rational, it can become rational if - the weights associated with the new poles are different from each - other, or collectively different from the existing weights in the - table. - - - - - - - Inserts into the table of poles of this surface, before the column - of poles of index. - If this Bezier surface is non-rational, it can become rational if - the weights associated with the new poles are different from each - other, or collectively different from the existing weights in the - table. - - - - - - - Inserts into the table of poles of this surface, before the row - of poles of index. - If this Bezier surface is non-rational, it can become rational if - the weights associated with the new poles are different from each - other, or collectively different from the existing weights in the - table. - - - - - - - removePoleRow(int=VIndex) - Removes the column of poles of index VIndex from the table of - poles of this Bezier surface. - If this Bezier curve is rational, it can become non-rational. - - - - - - - removePoleRow(int=UIndex) - Removes the row of poles of index UIndex from the table of - poles of this Bezier surface. - If this Bezier curve is rational, it can become non-rational. - - - - - - - segment(double=U1,double=U2,double=V1,double=V2) - Modifies this Bezier surface by segmenting it between U1 and U2 - in the u parametric direction, and between V1 and V2 in the v - parametric direction. - U1, U2, V1, and V2 can be outside the bounds of this surface. - - -- U1 and U2 isoparametric Bezier curves, segmented between - V1 and V2, become the two bounds of the surface in the v - parametric direction (0. and 1. u isoparametric curves). - -- V1 and V2 isoparametric Bezier curves, segmented between - U1 and U2, become the two bounds of the surface in the u - parametric direction (0. and 1. v isoparametric curves). - - The poles and weights tables are modified, but the degree of - this surface in the u and v parametric directions does not - change.U1 can be greater than U2, and V1 can be greater than V2. - In these cases, the corresponding parametric direction is inverted. - The orientation of the surface is inverted if one (and only one) - parametric direction is inverted. - - - - - - Set a pole of the Bezier surface. - - - - - Set the column of poles of the Bezier surface. - - - - - Set the row of poles of the Bezier surface. - - - - - Get a pole of index (UIndex,VIndex) of the Bezier surface. - - - - - Get all poles of the Bezier surface. - - - - - - Set the weight of pole of the index (UIndex, VIndex) - for the Bezier surface. - - - - - - - Set the weights of the poles in the column of poles - of index VIndex of the Bezier surface. - - - - - - - Set the weights of the poles in the row of poles - of index UIndex of the Bezier surface. - - - - - - - Get a weight of the pole of index (UIndex,VIndex) - of the Bezier surface. - - - - - - Get all weights of the Bezier surface. - - - - - - Computes two tolerance values for this Bezier surface, based on the - given tolerance in 3D space Tolerance3D. The tolerances computed are: - -- UTolerance in the u parametric direction and - -- VTolerance in the v parametric direction. - - If f(u,v) is the equation of this Bezier surface, UTolerance and VTolerance - guarantee that: - |u1 - u0| < UTolerance - |v1 - v0| < VTolerance - ====> ||f(u1, v1) - f(u2, v2)|| < Tolerance3D - - - - - - - Exchanges the u and v parametric directions on this Bezier surface. - As a consequence: - -- the poles and weights tables are transposed, - -- degrees, rational characteristics and so on are exchanged between - the two parametric directions, and - -- the orientation of the surface is reversed. - - - - - + + + + + + Describes a rational or non-rational Bezier surface + -- A non-rational Bezier surface is defined by a table of poles (also known as control points). + -- A rational Bezier surface is defined by a table of poles with varying associated weights. + + + + Returns the polynomial degree in u direction of this Bezier surface, + which is equal to the number of poles minus 1. + + + + + + Returns the polynomial degree in v direction of this Bezier surface, + which is equal to the number of poles minus 1. + + + + + + Returns the value of the maximum polynomial degree of any + Bezier surface. This value is 25. + + + + + + Returns the number of poles in u direction of this Bezier surface. + + + + + + Returns the number of poles in v direction of this Bezier surface. + + + + + + Returns the parametric bounds (U1, U2, V1, V2) of this Bezier surface. + + + + + Returns false if the equation of this Bezier surface is polynomial + (e.g. non-rational) in the u or v parametric direction. + In other words, returns false if for each row of poles, the associated + weights are identical + + + + + Returns false if the equation of this Bezier surface is polynomial + (e.g. non-rational) in the u or v parametric direction. + In other words, returns false if for each column of poles, the associated + weights are identical + + + + + Returns false. + + + + + Returns false. + + + + + Checks if this surface is closed in the u parametric direction. + Returns true if, in the table of poles the first row and the last + row are identical. + + + + + Checks if this surface is closed in the v parametric direction. + Returns true if, in the table of poles the first column and the + last column are identical. + + + + + increase(Int=DegreeU,Int=DegreeV) + Increases the degree of this Bezier surface in the two + parametric directions. + + + + + Inserts into the table of poles of this surface, after the column + of poles of index. + If this Bezier surface is non-rational, it can become rational if + the weights associated with the new poles are different from each + other, or collectively different from the existing weights in the + table. + + + + + Inserts into the table of poles of this surface, after the row + of poles of index. + If this Bezier surface is non-rational, it can become rational if + the weights associated with the new poles are different from each + other, or collectively different from the existing weights in the + table. + + + + + Inserts into the table of poles of this surface, before the column + of poles of index. + If this Bezier surface is non-rational, it can become rational if + the weights associated with the new poles are different from each + other, or collectively different from the existing weights in the + table. + + + + + Inserts into the table of poles of this surface, before the row + of poles of index. + If this Bezier surface is non-rational, it can become rational if + the weights associated with the new poles are different from each + other, or collectively different from the existing weights in the + table. + + + + + removePoleRow(int=VIndex) + Removes the column of poles of index VIndex from the table of + poles of this Bezier surface. + If this Bezier curve is rational, it can become non-rational. + + + + + removePoleRow(int=UIndex) + Removes the row of poles of index UIndex from the table of + poles of this Bezier surface. + If this Bezier curve is rational, it can become non-rational. + + + + + segment(double=U1,double=U2,double=V1,double=V2) + Modifies this Bezier surface by segmenting it between U1 and U2 + in the u parametric direction, and between V1 and V2 in the v + parametric direction. + U1, U2, V1, and V2 can be outside the bounds of this surface. + + -- U1 and U2 isoparametric Bezier curves, segmented between + V1 and V2, become the two bounds of the surface in the v + parametric direction (0. and 1. u isoparametric curves). + -- V1 and V2 isoparametric Bezier curves, segmented between + U1 and U2, become the two bounds of the surface in the u + parametric direction (0. and 1. v isoparametric curves). + + The poles and weights tables are modified, but the degree of + this surface in the u and v parametric directions does not + change.U1 can be greater than U2, and V1 can be greater than V2. + In these cases, the corresponding parametric direction is inverted. + The orientation of the surface is inverted if one (and only one) + parametric direction is inverted. + + + + + Set a pole of the Bezier surface. + + + + + Set the column of poles of the Bezier surface. + + + + + Set the row of poles of the Bezier surface. + + + + + Get a pole of index (UIndex,VIndex) of the Bezier surface. + + + + + Get all poles of the Bezier surface. + + + + + Set the weight of pole of the index (UIndex, VIndex) + for the Bezier surface. + + + + + Set the weights of the poles in the column of poles + of index VIndex of the Bezier surface. + + + + + Set the weights of the poles in the row of poles + of index UIndex of the Bezier surface. + + + + + Get a weight of the pole of index (UIndex,VIndex) + of the Bezier surface. + + + + + Get all weights of the Bezier surface. + + + + + Computes two tolerance values for this Bezier surface, based on the + given tolerance in 3D space Tolerance3D. The tolerances computed are: + -- UTolerance in the u parametric direction and + -- VTolerance in the v parametric direction. + + If f(u,v) is the equation of this Bezier surface, UTolerance and VTolerance + guarantee that: + |u1 - u0| < UTolerance + |v1 - v0| < VTolerance + ====> ||f(u1, v1) - f(u2, v2)|| < Tolerance3D + + + + + Exchanges the u and v parametric directions on this Bezier surface. + As a consequence: + -- the poles and weights tables are transposed, + -- degrees, rational characteristics and so on are exchanged between + the two parametric directions, and + -- the orientation of the surface is reversed. + + + + diff --git a/src/Mod/Part/App/BoundedCurvePy.xml b/src/Mod/Part/App/BoundedCurvePy.xml index 143625e064..3cf02df0fb 100644 --- a/src/Mod/Part/App/BoundedCurvePy.xml +++ b/src/Mod/Part/App/BoundedCurvePy.xml @@ -1,37 +1,31 @@ - - - - - - - The abstract class BoundedCurve is the root class of all bounded curve objects. - - - - - - Returns the starting point of the bounded curve. - - - - - - - - Returns the end point of the bounded curve. - - - - - - + + + + + + The abstract class BoundedCurve is the root class of all bounded curve objects. + + + + Returns the starting point of the bounded curve. + + + + + + Returns the end point of the bounded curve. + + + + + diff --git a/src/Mod/Part/App/ConePy.xml b/src/Mod/Part/App/ConePy.xml index 8b8c364a4a..b5858ce5da 100644 --- a/src/Mod/Part/App/ConePy.xml +++ b/src/Mod/Part/App/ConePy.xml @@ -1,75 +1,74 @@ - - - - - - Describes a cone in 3D space - To create a cone there are several ways: - Part.Cone() - Creates a default cone with radius 1 - - Part.Cone(Cone) - Creates a copy of the given cone - - Part.Cone(Cone, Distance) - Creates a cone parallel to given cone at a certain distance - - Part.Cone(Point1,Point2,Radius1,Radius2) - Creates a cone defined by two points and two radii - The axis of the cone is the line passing through - Point1 and Poin2. - Radius1 is the radius of the section passing through - Point1 and Radius2 the radius of the section passing - through Point2. - - Part.Cone(Point1,Point2,Point3,Point4) - Creates a cone passing through three points Point1, - Point2 and Point3. - Its axis is defined by Point1 and Point2 and the radius of - its base is the distance between Point3 and its axis. - The distance between Point and the axis is the radius of - the section passing through Point4. - - - - - Compute the apex of the cone. - - - - - - The radius of the cone. - - - - - - The semi-angle of the cone. - - - - - - Center of the cone. - - - - - - The axis direction of the cone - - - - - + + + + + + Describes a cone in 3D space + To create a cone there are several ways: + Part.Cone() + Creates a default cone with radius 1 + + Part.Cone(Cone) + Creates a copy of the given cone + + Part.Cone(Cone, Distance) + Creates a cone parallel to given cone at a certain distance + + Part.Cone(Point1,Point2,Radius1,Radius2) + Creates a cone defined by two points and two radii + The axis of the cone is the line passing through + Point1 and Poin2. + Radius1 is the radius of the section passing through + Point1 and Radius2 the radius of the section passing + through Point2. + + Part.Cone(Point1,Point2,Point3,Point4) + Creates a cone passing through three points Point1, + Point2 and Point3. + Its axis is defined by Point1 and Point2 and the radius of + its base is the distance between Point3 and its axis. + The distance between Point and the axis is the radius of + the section passing through Point4. + + + + Compute the apex of the cone. + + + + + + The radius of the cone. + + + + + + The semi-angle of the cone. + + + + + + Center of the cone. + + + + + + The axis direction of the cone + + + + + diff --git a/src/Mod/Part/App/CylinderPy.xml b/src/Mod/Part/App/CylinderPy.xml index 7b44e08b0a..e7e64d31a3 100644 --- a/src/Mod/Part/App/CylinderPy.xml +++ b/src/Mod/Part/App/CylinderPy.xml @@ -1,53 +1,52 @@ - - - - - - Describes a cylinder in 3D space - To create a cylinder there are several ways: - Part.Cylinder() - Creates a default cylinder with center (0,0,0) and radius 1 - - Part.Cylinder(Cylinder) - Creates a copy of the given cylinder - - Part.Cylinder(Cylinder, Distance) - Creates a cylinder parallel to given cylinder at a certain distance - - Part.Cylinder(Point1,Point2,Point2) - Creates a cylinder defined by three non-linear points - - Part.Cylinder(Circle) - Creates a cylinder by a circular base - - - - - The radius of the cylinder. - - - - - - Center of the cylinder. - - - - - - The axis direction of the cylinder - - - - - + + + + + + Describes a cylinder in 3D space + To create a cylinder there are several ways: + Part.Cylinder() + Creates a default cylinder with center (0,0,0) and radius 1 + + Part.Cylinder(Cylinder) + Creates a copy of the given cylinder + + Part.Cylinder(Cylinder, Distance) + Creates a cylinder parallel to given cylinder at a certain distance + + Part.Cylinder(Point1,Point2,Point2) + Creates a cylinder defined by three non-linear points + + Part.Cylinder(Circle) + Creates a cylinder by a circular base + + + + The radius of the cylinder. + + + + + + Center of the cylinder. + + + + + + The axis direction of the cylinder + + + + + diff --git a/src/Mod/Part/App/EllipsePy.xml b/src/Mod/Part/App/EllipsePy.xml index 392b500548..91da1ca4b2 100644 --- a/src/Mod/Part/App/EllipsePy.xml +++ b/src/Mod/Part/App/EllipsePy.xml @@ -1,74 +1,72 @@ - - - - - - Describes an ellipse in 3D space - To create an ellipse there are several ways: - Part.Ellipse() - Creates an ellipse with major radius 2 and minor radius 1 with the - center in (0,0,0) - - Part.Ellipse(Ellipse) - Create a copy of the given ellipse - - Part.Ellipse(S1,S2,Center) - Creates an ellipse centered on the point Center, where - the plane of the ellipse is defined by 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.Ellipse(Center,MajorRadius,MinorRadius) - Creates an ellipse with major and minor radii MajorRadius and - MinorRadius, and located in the plane defined by Center and - the normal (0,0,1) - - - - - The major radius of the ellipse. - - - - - - The minor radius of the ellipse. - - - - - - The focal distance of the ellipse. - - - - - - The first focus is on the positive side of the major axis of the ellipse; -the second focus is on the negative side. - - - - - - - The first focus is on the positive side of the major axis of the ellipse; -the second focus is on the negative side. - - - - - - - + + + + + + Describes an ellipse in 3D space + To create an ellipse there are several ways: + Part.Ellipse() + Creates an ellipse with major radius 2 and minor radius 1 with the + center in (0,0,0) + + Part.Ellipse(Ellipse) + Create a copy of the given ellipse + + Part.Ellipse(S1,S2,Center) + Creates an ellipse centered on the point Center, where + the plane of the ellipse is defined by 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.Ellipse(Center,MajorRadius,MinorRadius) + Creates an ellipse with major and minor radii MajorRadius and + MinorRadius, and located in the plane defined by Center and + the normal (0,0,1) + + + + The major radius of the ellipse. + + + + + + The minor radius of the ellipse. + + + + + + The focal distance of the ellipse. + + + + + + The first focus is on the positive side of the major axis of the ellipse; +the second focus is on the negative side. + + + + + + + The first focus is on the positive side of the major axis of the ellipse; +the second focus is on the negative side. + + + + + + diff --git a/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml b/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml index edae6ff12a..2a6a3e48f1 100644 --- a/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml +++ b/src/Mod/Part/App/Geom2d/BSplineCurve2dPy.xml @@ -1,444 +1,408 @@ - - - - Describes a B-Spline curve in 3D space - - - - Returns the polynomial degree of this B-Spline curve. - - - - - - Returns the value of the maximum polynomial degree of any + Include="Mod/Part/App/Geometry2d.h" + Father="Curve2dPy" + FatherNamespace="Part" + Constructor="true"> + + + Describes a B-Spline curve in 3D space + + + + Returns the polynomial degree of this B-Spline curve. + + + + + + Returns the value of the maximum polynomial degree of any B-Spline curve curve. This value is 25. - - - - - - Returns the number of poles of this B-Spline curve. - - - - - - - - Returns the number of knots of this B-Spline curve. - - - - - - - Returns the start point of this B-Spline curve. - - - - - - Returns the end point of this B-Spline curve. - - - - - - Returns the index in the knot array of the knot + + + + + + Returns the number of poles of this B-Spline curve. + + + + + + Returns the number of knots of this B-Spline curve. + + + + + + Returns the start point of this B-Spline curve. + + + + + + Returns the end point of this B-Spline curve. + + + + + + Returns the index in the knot array of the knot corresponding to the first or last parameter of this B-Spline curve. - - - - - - Returns the index in the knot array of the knot + + + + + + Returns the index in the knot array of the knot corresponding to the first or last parameter of this B-Spline curve. - - - - - - Returns the knots sequence of this B-Spline curve. - - - - - - - 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. - - - - - - Returns true if this BSpline curve is periodic. - - - - - - 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(). - - - - - - increase(Int=Degree) + + + + + + Returns the knots sequence of this B-Spline curve. + + + + + + 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. + + + + + Returns true if this BSpline curve is periodic. + + + + + 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(). + + + + + 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. - - - - - - increaseMultiplicity(int index, int mult) - increaseMultiplicity(int start, int end, int mult) - Increases multiplicity of knots up to mult. + + + + + increaseMultiplicity(int index, int 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. - - - - - - - incrementMultiplicity(int start, int end, int mult) - Raises multiplicity of knots by 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. + + + + + incrementMultiplicity(int start, int end, int mult) + Raises multiplicity of knots by mult. - 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. - - - - - - insertKnots(list_of_floats, list_of_ints, tol = 0.0, bool_add = True) - Inserts a set of knots values in the sequence of knots. + 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. + + + + + insertKnots(list_of_floats, list_of_ints, tol = 0.0, bool_add = True) + 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. - - - - - - - removeKnot(Index, M, tol) + 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. - - - - - - - segment(u1,u2) - Modifies this B-Spline curve by segmenting it. - - - - - Set a knot of the B-Spline curve. - - - - - Get a knot of the B-Spline curve. - - - - - Set knots of the B-Spline curve. - - - - - Get all knots of the B-Spline curve. - - - - - Modifies this B-Spline curve by assigning P + 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. + + + + + Set a knot of the B-Spline curve. + + + + + Get a knot of the B-Spline curve. + + + + + Set knots of the B-Spline curve. + + + + + Get all knots of the B-Spline curve. + + + + + Modifies this B-Spline curve by assigning P to the pole of index Index in the poles table. - - - - - Get a pole of the B-Spline curve. - - - - - Get all poles of the B-Spline curve. - - - - - Set a weight of the B-Spline curve. - - - - - Get a weight of the B-Spline curve. - - - - - Get all weights of the B-Spline curve. - - - - - Returns the table of poles and weights in homogeneous coordinates. - - - - - Computes for this B-Spline curve the parametric tolerance (UTolerance) + + + + + Get a pole of the B-Spline curve. + + + + + Get all poles of the B-Spline curve. + + + + + Set a weight of the B-Spline curve. + + + + + Get a weight of the B-Spline curve. + + + + + Get all weights of the B-Spline curve. + + + + + Returns the table of poles and weights in homogeneous coordinates. + + + + + 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 - - - - - - movePoint(U, P, Index1, Index2) - Moves the point of parameter U of this B-Spline curve to P. +|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. - - - - - Changes this B-Spline curve into a non-periodic curve. + + + + + Changes this B-Spline curve into a non-periodic curve. If this curve is already non-periodic, it is not modified. - - - - - Changes this B-Spline curve into a periodic curve. - - - - - Assigns the knot of index Index in the knots table + + + + + Changes this B-Spline curve into a periodic curve. + + + + + 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 + + + + + Returns the multiplicity of the knot of index from the knots table of this B-Spline curve. - - - - - - Returns the multiplicities table M of the knots of this B-Spline curve. - - - - - - - Replaces this B-Spline curve by approximating a set of points. - The function accepts keywords as arguments. + + + + + Returns the multiplicities table M of the knots of this B-Spline curve. + + + + + Replaces this B-Spline curve by approximating a set of points. + 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 ). + + Compute the tangents for a Cardinal spline - - - Replaces this B-Spline curve by interpolating a set of points. - The function accepts keywords as arguments. + + Replaces this B-Spline curve by interpolating a set of points. + 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. - - - - - - - Builds a B-Spline by a list of poles. - - - - - - - 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] + Note : Continuity of the spline defaults to C2. However, if periodic, or tangents + are supplied, the continuity will drop to C1. + + + + + Builds a B-Spline by a list of poles. + + + + + 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] - 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()) - - - - - - - Build a list of Bezier splines. - - - - - - - Build a list of arcs and lines to approximate the B-spline. - toBiArcs(tolerance) -> list. - - - - - - - Build a new spline by joining this and a second spline. - - - - - - - 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. - - - - + # 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()) + + + + + Build a list of Bezier splines. + + + + + Build a list of arcs and lines to approximate the B-spline. + toBiArcs(tolerance) -> list. + + + + + Build a new spline by joining this and a second spline. + + + + + 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. + + + diff --git a/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml b/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml index 519153680c..d18bb4f841 100644 --- a/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml +++ b/src/Mod/Part/App/Geom2d/BezierCurve2dPy.xml @@ -1,145 +1,141 @@ - - - - - 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 - - - - - Returns the polynomial degree of this Bezier curve, + Include="Mod/Part/App/Geometry2d.h" + Father="Curve2dPy" + FatherNamespace="Part" + Constructor="true"> + + + 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 + + + + 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 + + Returns the value of the maximum polynomial degree of any Bezier curve curve. This value is 25. - - - - - - Returns the number of poles of this Bezier curve. - - - - + + + + + + Returns the number of poles of this Bezier curve. + + + - - Returns the start point of this Bezier curve. - - - - - - Returns the end point of this Bezier curve. - - - + + Returns the start point of this Bezier curve. + + + + + + Returns the end point of this Bezier curve. + + + - - Returns false if the weights of all the poles of this Bezier curve are equal. - - - - - Returns false. - - - - - 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) + + Returns false if the weights of all the poles of this Bezier curve are equal. + + + + + Returns false. + + + + + 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. - - + + - - Inserts after the pole of index. - - - - - Inserts before the pole of index. - - - - - Removes the pole of index Index from the table of poles of this Bezier curve. + + Inserts after the pole of index. + + + + + Inserts before the pole of index. + + + + + 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. - - - - - Modifies this Bezier curve by segmenting it. - - + + + + + Modifies this Bezier curve by segmenting it. + + - - Set a pole of the Bezier curve. - - - - - Get a pole of the Bezier curve. - - - - - Get all poles of the Bezier curve. - - - - - Set the poles of the Bezier curve. - - - - - Set a weight of the Bezier curve. - - - - - Get a weight of the Bezier curve. - - - - - Get all weights of the Bezier curve. - - - - - Computes for this Bezier curve the parametric tolerance (UTolerance) + + Set a pole of the Bezier curve. + + + + + Get a pole of the Bezier curve. + + + + + Get all poles of the Bezier curve. + + + + + Set the poles of the Bezier curve. + + + + + Set a weight of the Bezier curve. + + + + + Get a weight of the Bezier curve. + + + + + Get all weights of the Bezier curve. + + + + + 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 - - - +|t1-t0| < UTolerance =""==> |f(t1)-f(t0)| < Tolerance3D + + + diff --git a/src/Mod/Part/App/Geom2d/Curve2dPy.xml b/src/Mod/Part/App/Geom2d/Curve2dPy.xml index 68c33fff81..2594d2264f 100644 --- a/src/Mod/Part/App/Geom2d/Curve2dPy.xml +++ b/src/Mod/Part/App/Geom2d/Curve2dPy.xml @@ -1,42 +1,40 @@ - - - - - The abstract class Geom2dCurve is the root class of all curve objects. - - + Include="Mod/Part/App/Geometry2d.h" + Father="Geometry2dPy" + FatherNamespace="Part" + Constructor="true"> + + + The abstract class Geom2dCurve is the root class of all curve objects. + Changes the direction of parametrization of the curve. - - - Return the shape for the geometry. - - + + + Return the shape for the geometry. + + - - Discretizes the curve and returns a list of points. + + Discretizes the curve and returns a list of points. The function accepts keywords as argument: -discretize(Number=n) => gives a list of 'n' equidistant points -discretize(QuasiNumber=n) => gives a list of 'n' quasi equidistant points (is faster than the method above) -discretize(Distance=d) => gives a list of equidistant points with distance 'd' -discretize(Deflection=d) => gives a list of points with a maximum deflection 'd' to the curve -discretize(QuasiDeflection=d) => gives a list of points with a maximum deflection 'd' to the curve (faster) -discretize(Angular=a,Curvature=c,[Minimum=m]) => gives a list of points with an angular deflection of 'a' +discretize(Number=n) => gives a list of 'n' equidistant points +discretize(QuasiNumber=n) => gives a list of 'n' quasi equidistant points (is faster than the method above) +discretize(Distance=d) => gives a list of equidistant points with distance 'd' +discretize(Deflection=d) => gives a list of points with a maximum deflection 'd' to the curve +discretize(QuasiDeflection=d) => gives a list of points with a maximum deflection 'd' to the curve (faster) +discretize(Angular=a,Curvature=c,[Minimum=m]) => gives a list of points with an angular deflection of 'a' and a curvature deflection of 'c'. Optionally a minimum number of points can be set which by default is set to 2. @@ -59,115 +57,98 @@ Part.show(s) p=c.discretize(Angular=0.09,Curvature=0.01,Last=3.14,Minimum=100) s=Part.Compound([Part.Vertex(i) for i in p]) -Part.show(s) - - - - - - 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 the - - - - - Computes the point of parameter u on this curve - - - - - Computes the tangent of parameter u on this curve - - +Part.show(s) + + + + + 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 the + + + + + Computes the point of parameter u on this curve + + + + + Computes the tangent of parameter u on this curve + + - - Returns the parameter on the curve + + 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 - - - - - 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 = 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 + + + + + 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 + + - - - Returns the global continuity of the curve. - - - - + + Returns the global continuity of the curve. + + + - - Returns true if the curve is closed. - + Returns true if the curve is closed. - - Returns true if the curve is periodic. - + Returns true if the curve is periodic. - - - Returns the value of the first parameter. - - - - - - - - Returns the value of the last parameter. - - - - - + + Returns the value of the first parameter. + + + + + + Returns the value of the last parameter. + + + + diff --git a/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml b/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml index 56525a5de8..ee60019a0e 100644 --- a/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml +++ b/src/Mod/Part/App/Geom2d/Ellipse2dPy.xml @@ -1,72 +1,70 @@ - + - - - + Include="Mod/Part/App/Geometry2d.h" + Father="Conic2dPy" + FatherNamespace="Part" + Constructor="true"> + + Describes an ellipse in 2D space - To create an ellipse there are several ways: + To create an ellipse there are several ways: Part.Geom2d.Ellipse2d() - Creates an ellipse with major radius 2 and minor radius 1 with the + 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 + 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. + 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 - - - - - The major radius of the ellipse. - - - - - - The minor radius of the ellipse. - - - - - - The focal distance of the ellipse. - - - - - - The first focus is on the positive side of the major axis of the ellipse; + Creates an ellipse with major and minor radii MajorRadius and + MinorRadius + + + + The major radius of the ellipse. + + + + + + The minor radius of the ellipse. + + + + + + The focal distance of the ellipse. + + + + + + The first focus is on the positive side of the major axis of the ellipse; the second focus is on the negative side. - - - - - - - The first focus is on the positive side of the major axis of the ellipse; -the second focus is on the negative side. - - - - - - + + + + + + + The first focus is on the positive side of the major axis of the ellipse; +the second focus is on the negative side. + + + + + diff --git a/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml b/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml index f268c0af98..a8c60e0b63 100644 --- a/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml +++ b/src/Mod/Part/App/Geom2d/Hyperbola2dPy.xml @@ -1,18 +1,18 @@ - + - - - + Include="Mod/Part/App/Geometry2d.h" + Father="Conic2dPy" + FatherNamespace="Part" + Constructor="true"> + + Describes a hyperbola in 2D space To create a hyperbola there are several ways: Part.Geom2d.Hyperbola2d() @@ -20,53 +20,51 @@ center in (0,0) Part.Geom2d.Hyperbola2d(Hyperbola) - Create a copy of the given 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. + 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 - - - - - The major radius of the hyperbola. - - - - - - The minor radius of the hyperbola. - - - - - - The focal distance of the hyperbola. - - - - - - The first focus is on the positive side of the major axis of the hyperbola; + MinorRadius and located at Center + + + + The major radius of the hyperbola. + + + + + + The minor radius of the hyperbola. + + + + + + The focal distance of the hyperbola. + + + + + + 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. - - - - - - + + + + + + + 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/OffsetCurve2dPy.xml b/src/Mod/Part/App/Geom2d/OffsetCurve2dPy.xml index a1f5bca2cf..6b33e20d76 100644 --- a/src/Mod/Part/App/Geom2d/OffsetCurve2dPy.xml +++ b/src/Mod/Part/App/Geom2d/OffsetCurve2dPy.xml @@ -1,35 +1,31 @@ - - - - - - - - - Sets or gets the offset value to offset the underlying curve. - - - - - - - - Sets or gets the basic curve. - - - - - + Include="Mod/Part/App/Geometry2d.h" + Father="Curve2dPy" + FatherNamespace="Part" + Constructor="true"> + + + + + + + Sets or gets the offset value to offset the underlying curve. + + + + + + Sets or gets the basic curve. + + + + diff --git a/src/Mod/Part/App/Geom2d/Parabola2dPy.xml b/src/Mod/Part/App/Geom2d/Parabola2dPy.xml index 8a6aa7f3c7..fe98c758fe 100644 --- a/src/Mod/Part/App/Geom2d/Parabola2dPy.xml +++ b/src/Mod/Part/App/Geom2d/Parabola2dPy.xml @@ -1,42 +1,41 @@ - - - + Include="Mod/Part/App/Geometry2d.h" + Father="Conic2dPy" + FatherNamespace="Part" + Constructor="true"> + + Describes a parabola in 2D space - + - - The focal distance is the distance between + + The focal distance is the distance between the apex and the focus of the parabola. - - - + + + - - The focus is on the positive side of the + + The focus is on the positive side of the 'X Axis' of the local coordinate system of the parabola. - - - - - - Compute the parameter of this parabola + + + + + + Compute the parameter of this parabola which is the distance between its focus -and its directrix. This distance is twice the focal length. - - - - - +and its directrix. This distance is twice the focal length. + + + + diff --git a/src/Mod/Part/App/GeometryCurvePy.xml b/src/Mod/Part/App/GeometryCurvePy.xml index 326b9b2913..f0f80580f9 100644 --- a/src/Mod/Part/App/GeometryCurvePy.xml +++ b/src/Mod/Part/App/GeometryCurvePy.xml @@ -1,274 +1,247 @@ - - - - - - - The abstract class GeometryCurve is the root class of all curve objects. - - - - - Return the shape for the geometry. - - - - - Discretizes the curve and returns a list of points. -The function accepts keywords as argument: -discretize(Number=n) => gives a list of 'n' equidistant points -discretize(QuasiNumber=n) => gives a list of 'n' quasi equidistant points (is faster than the method above) -discretize(Distance=d) => gives a list of equidistant points with distance 'd' -discretize(Deflection=d) => gives a list of points with a maximum deflection 'd' to the curve -discretize(QuasiDeflection=d) => gives a list of points with a maximum deflection 'd' to the curve (faster) -discretize(Angular=a,Curvature=c,[Minimum=m]) => gives a list of points with an angular deflection of 'a' - and a curvature deflection of 'c'. Optionally a minimum number of points - can be set which by default is set to 2. - -Optionally you can set the keywords 'First' and 'Last' to define a sub-range of the parameter range -of the curve. - -If no keyword is given then it depends on whether the argument is an int or float. -If it's an int then the behaviour is as if using the keyword 'Number', if it's float -then the behaviour is as if using the keyword 'Distance'. - -Example: - -import Part -c=Part.Circle() -c.Radius=5 -p=c.discretize(Number=50,First=3.14) -s=Part.Compound([Part.Vertex(i) for i in p]) -Part.show(s) - - -p=c.discretize(Angular=0.09,Curvature=0.01,Last=3.14,Minimum=100) -s=Part.Compound([Part.Vertex(i) for i in p]) -Part.show(s) - - - - - - Returns the point of given parameter - - - - - Returns the point and first derivative of given parameter - - - - - Returns the point, first and second derivatives - - - - - Returns the point, first, second and third derivatives - - - - - Returns the n-th derivative - - - - - 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 the - - - - - Computes the point of parameter u on this curve - - - - - Computes the tangent of parameter u on this curve - - - - - Make a ruled surface of this and the given curves - - - - - Get intersection points with another curve lying on a plane. - - - - - Computes the continuity of two curves - - - - - 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 - - - - - -Computes the projection of a point on the curve - -projectPoint(Point=Vector,[Method="NearestPoint"]) -projectPoint(Vector,"NearestPoint") -> Vector -projectPoint(Vector,"LowerDistance") -> float -projectPoint(Vector,"LowerDistanceParameter") -> float -projectPoint(Vector,"Distance") -> list of floats -projectPoint(Vector,"Parameter") -> list of floats -projectPoint(Vector,"Point") -> list of points - - - - - - 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 - - - - - - Returns all intersection points and curve segments between the curve and the curve/surface. - - arguments: curve/surface (for the intersection), precision (float) - - - - - - - Returns all intersection points and curve segments between the curve and the surface. - - - - - - - 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) - toNurbs([Float=First, Float=Last]) -> NURBS curve - - - - - - - Returns a trimmed curve defined in the given parameter range - trim([Float=First, Float=Last]) -> trimmed curve - - - - - - - Approximates a curve of any type to a B-Spline curve - approximateBSpline(Tolerance, MaxSegments, MaxDegree, [Order='C2']) -> B-Spline curve - - - - - - Changes the direction of parametrization of the curve. - - - - - Returns the parameter on the reversed curve for -the point of parameter U on this curve. - - - - - Returns true if this curve is periodic. - - - - - Returns the period of this curve -or raises an exception if it is not periodic. - - - - - - Returns true if the curve is closed. - - - - - - - Returns the global continuity of the curve. - - - - - - - - Returns the value of the first parameter. - - - - - - - - Returns the value of the last parameter. - - - - - - - Returns a rotation object to describe the orientation for curve that supports it - - - - - + + + + + + The abstract class GeometryCurve is the root class of all curve objects. + + + + Return the shape for the geometry. + + + + + Discretizes the curve and returns a list of points. +The function accepts keywords as argument: +discretize(Number=n) => gives a list of 'n' equidistant points +discretize(QuasiNumber=n) => gives a list of 'n' quasi equidistant points (is faster than the method above) +discretize(Distance=d) => gives a list of equidistant points with distance 'd' +discretize(Deflection=d) => gives a list of points with a maximum deflection 'd' to the curve +discretize(QuasiDeflection=d) => gives a list of points with a maximum deflection 'd' to the curve (faster) +discretize(Angular=a,Curvature=c,[Minimum=m]) => gives a list of points with an angular deflection of 'a' + and a curvature deflection of 'c'. Optionally a minimum number of points + can be set which by default is set to 2. + +Optionally you can set the keywords 'First' and 'Last' to define a sub-range of the parameter range +of the curve. + +If no keyword is given then it depends on whether the argument is an int or float. +If it's an int then the behaviour is as if using the keyword 'Number', if it's float +then the behaviour is as if using the keyword 'Distance'. + +Example: + +import Part +c=Part.Circle() +c.Radius=5 +p=c.discretize(Number=50,First=3.14) +s=Part.Compound([Part.Vertex(i) for i in p]) +Part.show(s) + + +p=c.discretize(Angular=0.09,Curvature=0.01,Last=3.14,Minimum=100) +s=Part.Compound([Part.Vertex(i) for i in p]) +Part.show(s) + + + + + Returns the point of given parameter + + + + + Returns the point and first derivative of given parameter + + + + + Returns the point, first and second derivatives + + + + + Returns the point, first, second and third derivatives + + + + + Returns the n-th derivative + + + + + 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 the + + + + + Computes the point of parameter u on this curve + + + + + Computes the tangent of parameter u on this curve + + + + + Make a ruled surface of this and the given curves + + + + + Get intersection points with another curve lying on a plane. + + + + + Computes the continuity of two curves + + + + + 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 + + + + + Computes the projection of a point on the curve + +projectPoint(Point=Vector,[Method="NearestPoint"]) +projectPoint(Vector,"NearestPoint") -> Vector +projectPoint(Vector,"LowerDistance") -> float +projectPoint(Vector,"LowerDistanceParameter") -> float +projectPoint(Vector,"Distance") -> list of floats +projectPoint(Vector,"Parameter") -> list of floats +projectPoint(Vector,"Point") -> list of points + + + + + 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 + + + + + Returns all intersection points and curve segments between the curve and the curve/surface. + + arguments: curve/surface (for the intersection), precision (float) + + + + + Returns all intersection points and curve segments between the curve and the surface. + + + + + 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) + toNurbs([Float=First, Float=Last]) -> NURBS curve + + + + + Returns a trimmed curve defined in the given parameter range + trim([Float=First, Float=Last]) -> trimmed curve + + + + + Approximates a curve of any type to a B-Spline curve + approximateBSpline(Tolerance, MaxSegments, MaxDegree, [Order='C2']) -> B-Spline curve + + + + + Changes the direction of parametrization of the curve. + + + + + Returns the parameter on the reversed curve for +the point of parameter U on this curve. + + + + + Returns true if this curve is periodic. + + + + + Returns the period of this curve +or raises an exception if it is not periodic. + + + + + Returns true if the curve is closed. + + + + + Returns the global continuity of the curve. + + + + + + Returns the value of the first parameter. + + + + + + Returns the value of the last parameter. + + + + + + Returns a rotation object to describe the orientation for curve that supports it + + + + + diff --git a/src/Mod/Part/App/GeometrySurfacePy.xml b/src/Mod/Part/App/GeometrySurfacePy.xml index dc24e7646b..30030220f8 100644 --- a/src/Mod/Part/App/GeometrySurfacePy.xml +++ b/src/Mod/Part/App/GeometrySurfacePy.xml @@ -1,214 +1,189 @@ - - - - - - - The abstract class GeometrySurface is the root class of all surface objects. - - - - - Return the shape for the geometry. - - - - - Make a shell of the surface. - - - - - Returns the point of given parameter - - - - - Returns the n-th derivative - - - - - value(u,v) -> Point -Computes the point of parameter (u,v) on this surface - - - - - tangent(u,v) -> (Vector,Vector) -Computes the tangent of parameter (u,v) on this geometry - - - - - normal(u,v) -> Vector -Computes the normal of parameter (u,v) on this geometry - - - - - -Computes the projection of a point on the surface - -projectPoint(Point=Vector,[Method="NearestPoint"]) -projectPoint(Vector,"NearestPoint") -> Vector -projectPoint(Vector,"LowerDistance") -> float -projectPoint(Vector,"LowerDistanceParameters") -> tuple of floats (u,v) -projectPoint(Vector,"Distance") -> list of floats -projectPoint(Vector,"Parameters") -> list of tuples of floats -projectPoint(Vector,"Point") -> list of points - - - - - - isUmbillic(u,v) -> bool -Check if the geometry on parameter is an umbillic point, -i.e. maximum and minimum curvature are equal. - - - - - curvature(u,v,type) -> float -The value of type must be one of this: Max, Min, Mean or Gauss -Computes the curvature of parameter (u,v) on this geometry - - - - - curvatureDirections(u,v) -> (Vector,Vector) -Computes the directions of maximum and minimum curvature -of parameter (u,v) on this geometry. -The first vector corresponds to the maximum curvature, -the second vector corresponds to the minimum curvature. - - - - - - - Returns the parametric bounds (U1, U2, V1, V2) of this trimmed surface. - - - - - - -isPlanar([float]) -> Bool -Checks if the surface is planar within a certain tolerance. - - - - - - - Returns the global continuity of the surface. - - - - - - - Returns a rotation object to describe the orientation for surface that supports it - - - - - - Builds the U isoparametric curve - - - - - Builds the V isoparametric curve - - - - - Returns true if this patch is periodic in the given parametric direction. - - - - - Returns true if this patch is periodic in the given parametric direction. - - - - - - Checks if this surface is closed in the u parametric direction. - - - - - - - Checks if this surface is closed in the v parametric direction. - - - - - - - Returns the period of this patch in the u parametric direction. - - - - - - - Returns the period of this patch in the v parametric direction. - - - - - - Returns the parameter on the curve -of the nearest orthogonal projection of the point. - - - - - - Returns a B-Spline representation of this surface. - The optional arguments are: - * tolerance (default=1e-7) - * continuity in u (as string e.g. C0, G0, G1, C1, G2, C3, CN) (default='C1') - * continuity in v (as string e.g. C0, G0, G1, C1, G2, C3, CN) (default='C1') - * maximum degree in u (default=25) - * maximum degree in v (default=25) - * maximum number of segments (default=1000) - * precision code (default=0) - Will raise an exception if surface is infinite in U or V (like planes, cones or cylinders) - - - - - - - Returns all intersection points/curves between the surface and the curve/surface. - - - - - - -Returns all intersection curves of this surface and the given surface. -The required arguments are: -* Second surface -* precision code (optional, default=0) - - - - - + + + + + + The abstract class GeometrySurface is the root class of all surface objects. + + + + Return the shape for the geometry. + + + + + Make a shell of the surface. + + + + + Returns the point of given parameter + + + + + Returns the n-th derivative + + + + + value(u,v) -> Point +Computes the point of parameter (u,v) on this surface + + + + + tangent(u,v) -> (Vector,Vector) +Computes the tangent of parameter (u,v) on this geometry + + + + + normal(u,v) -> Vector +Computes the normal of parameter (u,v) on this geometry + + + + + Computes the projection of a point on the surface + +projectPoint(Point=Vector,[Method="NearestPoint"]) +projectPoint(Vector,"NearestPoint") -> Vector +projectPoint(Vector,"LowerDistance") -> float +projectPoint(Vector,"LowerDistanceParameters") -> tuple of floats (u,v) +projectPoint(Vector,"Distance") -> list of floats +projectPoint(Vector,"Parameters") -> list of tuples of floats +projectPoint(Vector,"Point") -> list of points + + + + + isUmbillic(u,v) -> bool +Check if the geometry on parameter is an umbillic point, +i.e. maximum and minimum curvature are equal. + + + + + curvature(u,v,type) -> float +The value of type must be one of this: Max, Min, Mean or Gauss +Computes the curvature of parameter (u,v) on this geometry + + + + + curvatureDirections(u,v) -> (Vector,Vector) +Computes the directions of maximum and minimum curvature +of parameter (u,v) on this geometry. +The first vector corresponds to the maximum curvature, +the second vector corresponds to the minimum curvature. + + + + + Returns the parametric bounds (U1, U2, V1, V2) of this trimmed surface. + + + + + isPlanar([float]) -> Bool +Checks if the surface is planar within a certain tolerance. + + + + + Returns the global continuity of the surface. + + + + + + Returns a rotation object to describe the orientation for surface that supports it + + + + + + Builds the U isoparametric curve + + + + + Builds the V isoparametric curve + + + + + Returns true if this patch is periodic in the given parametric direction. + + + + + Returns true if this patch is periodic in the given parametric direction. + + + + + Checks if this surface is closed in the u parametric direction. + + + + + Checks if this surface is closed in the v parametric direction. + + + + + Returns the period of this patch in the u parametric direction. + + + + + Returns the period of this patch in the v parametric direction. + + + + + Returns the parameter on the curve +of the nearest orthogonal projection of the point. + + + + + Returns a B-Spline representation of this surface. + The optional arguments are: + * tolerance (default=1e-7) + * continuity in u (as string e.g. C0, G0, G1, C1, G2, C3, CN) (default='C1') + * continuity in v (as string e.g. C0, G0, G1, C1, G2, C3, CN) (default='C1') + * maximum degree in u (default=25) + * maximum degree in v (default=25) + * maximum number of segments (default=1000) + * precision code (default=0) + Will raise an exception if surface is infinite in U or V (like planes, cones or cylinders) + + + + + Returns all intersection points/curves between the surface and the curve/surface. + + + + + Returns all intersection curves of this surface and the given surface. +The required arguments are: +* Second surface +* precision code (optional, default=0) + + + + diff --git a/src/Mod/Part/App/HyperbolaPy.xml b/src/Mod/Part/App/HyperbolaPy.xml index 41a9d49edd..1bae540d6b 100644 --- a/src/Mod/Part/App/HyperbolaPy.xml +++ b/src/Mod/Part/App/HyperbolaPy.xml @@ -1,74 +1,72 @@ - - - - - - Describes an hyperbola in 3D space - To create a hyperbola there are several ways: - Part.Hyperbola() - Creates an hyperbola with major radius 2 and minor radius 1 with the - center in (0,0,0) - - Part.Hyperbola(Hyperbola) - Create a copy of the given hyperbola - - Part.Hyperbola(S1,S2,Center) - Creates an hyperbola centered on the point Center, where - the plane of the hyperbola is defined by 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.Hyperbola(Center,MajorRadius,MinorRadius) - Creates an hyperbola with major and minor radii MajorRadius and - MinorRadius, and located in the plane defined by Center and - the normal (0,0,1) - - - - - The major radius of the hyperbola. - - - - - - The minor radius of the hyperbola. - - - - - - The focal distance of the hyperbola. - - - - - - 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. - - - - - - - + + + + + + Describes an hyperbola in 3D space + To create a hyperbola there are several ways: + Part.Hyperbola() + Creates an hyperbola with major radius 2 and minor radius 1 with the + center in (0,0,0) + + Part.Hyperbola(Hyperbola) + Create a copy of the given hyperbola + + Part.Hyperbola(S1,S2,Center) + Creates an hyperbola centered on the point Center, where + the plane of the hyperbola is defined by 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.Hyperbola(Center,MajorRadius,MinorRadius) + Creates an hyperbola with major and minor radii MajorRadius and + MinorRadius, and located in the plane defined by Center and + the normal (0,0,1) + + + + The major radius of the hyperbola. + + + + + + The minor radius of the hyperbola. + + + + + + The focal distance of the hyperbola. + + + + + + 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/OffsetCurvePy.xml b/src/Mod/Part/App/OffsetCurvePy.xml index 02109d84f5..b4b8357ce7 100644 --- a/src/Mod/Part/App/OffsetCurvePy.xml +++ b/src/Mod/Part/App/OffsetCurvePy.xml @@ -1,43 +1,37 @@ - - - - - - - - - - - Sets or gets the offset value to offset the underlying curve. - - - - - - - - Sets or gets the offset direction to offset the underlying curve. - - - - - - - - Sets or gets the basic curve. - - - - - - + + + + + + + + + + Sets or gets the offset value to offset the underlying curve. + + + + + + Sets or gets the offset direction to offset the underlying curve. + + + + + + Sets or gets the basic curve. + + + + + diff --git a/src/Mod/Part/App/OffsetSurfacePy.xml b/src/Mod/Part/App/OffsetSurfacePy.xml index 9285faf3a5..4618984db5 100644 --- a/src/Mod/Part/App/OffsetSurfacePy.xml +++ b/src/Mod/Part/App/OffsetSurfacePy.xml @@ -1,35 +1,31 @@ - - - - - - - - - - - Sets or gets the offset value to offset the underlying surface. - - - - - - - - Sets or gets the basic surface. - - - - - - + + + + + + + + + + Sets or gets the offset value to offset the underlying surface. + + + + + + Sets or gets the basic surface. + + + + + diff --git a/src/Mod/Part/App/ParabolaPy.xml b/src/Mod/Part/App/ParabolaPy.xml index 1606a2ea1e..01cf61ed0d 100644 --- a/src/Mod/Part/App/ParabolaPy.xml +++ b/src/Mod/Part/App/ParabolaPy.xml @@ -1,50 +1,47 @@ - - - - - - Describes a parabola in 3D space - - - - - compute(p1,p2,p3) - The three points must lie on a plane parallel to xy plane and must not be collinear - - - - - - 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. - - - - - - Compute the parameter of this parabola -which is the distance between its focus -and its directrix. This distance is twice the focal length. - - - - - - + + + + + + Describes a parabola in 3D space + + + + compute(p1,p2,p3) + The three points must lie on a plane parallel to xy plane and must not be collinear + + + + + 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. + + + + + + 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/PlateSurfacePy.xml b/src/Mod/Part/App/PlateSurfacePy.xml index 2718848f60..7de2361f4c 100644 --- a/src/Mod/Part/App/PlateSurfacePy.xml +++ b/src/Mod/Part/App/PlateSurfacePy.xml @@ -1,24 +1,24 @@ - - - - - - - - Approximate the plate surface to a B-Spline surface - - - + FatherInclude="Mod/Part/App/GeometrySurfacePy.h" + Include="Mod/Part/App/Geometry.h" + Father="GeometrySurfacePy" + FatherNamespace="Part" + Constructor="true"> + + + + + + + Approximate the plate surface to a B-Spline surface + + + diff --git a/src/Mod/Part/App/RectangularTrimmedSurfacePy.xml b/src/Mod/Part/App/RectangularTrimmedSurfacePy.xml index 79fbe99e1a..5dcea588bd 100644 --- a/src/Mod/Part/App/RectangularTrimmedSurfacePy.xml +++ b/src/Mod/Part/App/RectangularTrimmedSurfacePy.xml @@ -1,40 +1,40 @@ - - - - - - Describes a portion of a surface (a patch) limited by two values of the -u parameter in the u parametric direction, and two values of the v parameter in the v parametric -direction. The domain of the trimmed surface must be within the domain of the surface being trimmed. - -The trimmed surface is defined by: -- the basis surface, and -- the values (umin, umax) and (vmin, vmax) which limit it in the u and v parametric directions. - -The trimmed surface is built from a copy of the basis surface. Therefore, when the basis surface -is modified the trimmed surface is not changed. Consequently, the trimmed surface does not -necessarily have the same orientation as the basis surface. - - - - Modifies this patch by changing the trim values applied to the original surface - - - - - - - - - - + + + + + + Describes a portion of a surface (a patch) limited by two values of the +u parameter in the u parametric direction, and two values of the v parameter in the v parametric +direction. The domain of the trimmed surface must be within the domain of the surface being trimmed. + +The trimmed surface is defined by: +- the basis surface, and +- the values (umin, umax) and (vmin, vmax) which limit it in the u and v parametric directions. + +The trimmed surface is built from a copy of the basis surface. Therefore, when the basis surface +is modified the trimmed surface is not changed. Consequently, the trimmed surface does not +necessarily have the same orientation as the basis surface. + + + + Modifies this patch by changing the trim values applied to the original surface + + + + + + + + + + diff --git a/src/Mod/Part/App/SpherePy.xml b/src/Mod/Part/App/SpherePy.xml index 1484e3058c..adb4e13e87 100644 --- a/src/Mod/Part/App/SpherePy.xml +++ b/src/Mod/Part/App/SpherePy.xml @@ -1,49 +1,49 @@ - - - - - - Describes a sphere in 3D space - - - - The radius of the sphere. - - - - - - Compute the area of the sphere. - - - - - - Compute the volume of the sphere. - - - - - - Center of the sphere. - - - - - - The axis direction of the circle - - - - - + + + + + + Describes a sphere in 3D space + + + + The radius of the sphere. + + + + + + Compute the area of the sphere. + + + + + + Compute the volume of the sphere. + + + + + + Center of the sphere. + + + + + + The axis direction of the circle + + + + + diff --git a/src/Mod/Part/App/SurfaceOfExtrusionPy.xml b/src/Mod/Part/App/SurfaceOfExtrusionPy.xml index 3efa3ca101..d7951b7b68 100644 --- a/src/Mod/Part/App/SurfaceOfExtrusionPy.xml +++ b/src/Mod/Part/App/SurfaceOfExtrusionPy.xml @@ -1,35 +1,31 @@ - - - - - - Describes a surface of linear extrusion - - - - - Sets or gets the direction of revolution. - - - - - - - - Sets or gets the basic curve. - - - - - - + + + + + + Describes a surface of linear extrusion + + + + Sets or gets the direction of revolution. + + + + + + Sets or gets the basic curve. + + + + + diff --git a/src/Mod/Part/App/SurfaceOfRevolutionPy.xml b/src/Mod/Part/App/SurfaceOfRevolutionPy.xml index 449977966f..5eb0de87a8 100644 --- a/src/Mod/Part/App/SurfaceOfRevolutionPy.xml +++ b/src/Mod/Part/App/SurfaceOfRevolutionPy.xml @@ -1,43 +1,37 @@ - - - - - - Describes a surface of revolution - - - - - Sets or gets the location of revolution. - - - - - - - - Sets or gets the direction of revolution. - - - - - - - - Sets or gets the basic curve. - - - - - - + + + + + + Describes a surface of revolution + + + + Sets or gets the location of revolution. + + + + + + Sets or gets the direction of revolution. + + + + + + Sets or gets the basic curve. + + + + + diff --git a/src/Mod/Part/App/TopoShapeVertexPy.xml b/src/Mod/Part/App/TopoShapeVertexPy.xml index 973aa2723e..4dad515505 100644 --- a/src/Mod/Part/App/TopoShapeVertexPy.xml +++ b/src/Mod/Part/App/TopoShapeVertexPy.xml @@ -1,48 +1,48 @@ - - - - - - TopoShapeVertex is the OpenCasCade topological vertex wrapper - - - - X component of this Vertex. - - - - - - Y component of this Vertex. - - - - - - Z component of this Vertex. - - - - - - Position of this Vertex as a Vector - - - - - - Set or get the tolerance of the vertex - - - - - + + + + + + TopoShapeVertex is the OpenCasCade topological vertex wrapper + + + + X component of this Vertex. + + + + + + Y component of this Vertex. + + + + + + Z component of this Vertex. + + + + + + Position of this Vertex as a Vector + + + + + + Set or get the tolerance of the vertex + + + + + diff --git a/src/Mod/Part/App/ToroidPy.xml b/src/Mod/Part/App/ToroidPy.xml index 89ac7f6fd4..dd0aeb7e65 100644 --- a/src/Mod/Part/App/ToroidPy.xml +++ b/src/Mod/Part/App/ToroidPy.xml @@ -1,55 +1,55 @@ - - - - - - Describes a toroid in 3D space - - - - The major radius of the toroid. - - - - - - The minor radius of the toroid. - - - - - - Center of the toroid. - - - - - - The axis direction of the toroid - - - - - - Compute the area of the toroid. - - - - - - Compute the volume of the toroid. - - - - - + + + + + + Describes a toroid in 3D space + + + + The major radius of the toroid. + + + + + + The minor radius of the toroid. + + + + + + Center of the toroid. + + + + + + The axis direction of the toroid + + + + + + Compute the area of the toroid. + + + + + + Compute the volume of the toroid. + + + + + diff --git a/src/Mod/Part/App/TrimmedCurvePy.xml b/src/Mod/Part/App/TrimmedCurvePy.xml index 5749c3ca46..c2032d91e6 100644 --- a/src/Mod/Part/App/TrimmedCurvePy.xml +++ b/src/Mod/Part/App/TrimmedCurvePy.xml @@ -1,28 +1,24 @@ - - - - - - - The abstract class TrimmedCurve is the root class of all trimmed curve objects. - - - - - - Re-trims this curve to the provided parameter range ([Float=First, Float=Last]) - - - - - + + + + + + The abstract class TrimmedCurve is the root class of all trimmed curve objects. + + + + Re-trims this curve to the provided parameter range ([Float=First, Float=Last]) + + + +