From c78bdb95b8578af7943b8a0955d2043e487f6c4d Mon Sep 17 00:00:00 2001 From: alexneufeld Date: Sun, 19 Mar 2023 19:02:03 -0600 Subject: [PATCH] Explicitly use App.Vector in docstrings --- src/Mod/Part/App/TopoShapePy.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Mod/Part/App/TopoShapePy.xml b/src/Mod/Part/App/TopoShapePy.xml index 1d49dc3255..8102ed8530 100644 --- a/src/Mod/Part/App/TopoShapePy.xml +++ b/src/Mod/Part/App/TopoShapePy.xml @@ -118,7 +118,7 @@ importBrepFromString(str,False) to not display a progress bar. Extrude the shape along a vector. extrude(vector) -> Shape -- -Shp2 = Shp1.extrude(Vector(0,0,10)) - extrude the shape 10 mm in the +Z direction. +Shp2 = Shp1.extrude(App.Vector(0,0,10)) - extrude the shape 10 mm in the +Z direction. @@ -126,7 +126,7 @@ Shp2 = Shp1.extrude(Vector(0,0,10)) - extrude the shape 10 mm in the +Z directio Revolve the shape around an Axis to a given degree. revolve(base, direction, angle) -- -Part.revolve(Vector(0,0,0),Vector(0,0,1),360) - revolves the shape around the Z Axis 360 degree. +Part.revolve(App.Vector(0,0,0),App.Vector(0,0,1),360) - revolves the shape around the Z Axis 360 degree. Hints: Sometimes you want to create a rotation body out of a closed edge or wire. Example: @@ -400,7 +400,7 @@ translated(vector) -> shape Apply the rotation (base,dir,degree) to the current location of this shape rotate(base,dir,degree) -- -Shp.rotate(Vector(0,0,0),Vector(0,0,1),180) - rotate the shape around the Z Axis 180 degrees. +Shp.rotate(App.Vector(0,0,0),App.Vector(0,0,1),180) - rotate the shape around the Z Axis 180 degrees. @@ -414,14 +414,14 @@ rotated(base,dir,degree) -> shape Apply scaling with point and factor to this shape. -scale(factor,[base=Vector(0,0,0)]) +scale(factor,[base=App.Vector(0,0,0)]) Create a new shape with scale. -scaled(factor,[base=Vector(0,0,0)]) -> shape +scaled(factor,[base=App.Vector(0,0,0)]) -> shape @@ -789,9 +789,9 @@ distToShape(shape) -> (dist, vectors, infos) dist is the minimum distance, in mm (float value). vectors is a list of pairs of App.Vector. Each pair corresponds to solution. -Example: [(Vector (2.0, -1.0, 2.0), Vector (2.0, 0.0, 2.0)), (Vector (2.0, --1.0, 2.0), Vector (2.0, -1.0, 3.0))] First vector is a point on self, second -vector is a point on s. +Example: [(App.Vector(2.0, -1.0, 2.0), App.Vector(2.0, 0.0, 2.0)), +(App.Vector(2.0, -1.0, 2.0), App.Vector(2.0, -1.0, 3.0))] +First vector is a point on self, second vector is a point on s. infos contains additional info on the solutions. It is a list of tuples: (topo1, index1, params1, topo2, index2, params2)