kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Explicitly use App.Vector in docstrings

Browse Source
This commit is contained in:
alexneufeld
2023-03-19 19:02:03 -06:00
committed by wwmayer
parent e567ff7911
commit c78bdb95b8
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/Mod/Part/App/TopoShapePy.xml
View File

@@ -118,7 +118,7 @@ importBrepFromString(str,False) to not display a progress bar.
<UserDocu>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.</UserDocu>
Shp2 = Shp1.extrude(App.Vector(0,0,10)) - extrude the shape 10 mm in the +Z direction.</UserDocu>
</Documentation>
</Methode>
<Methode Name="revolve" Const="true">
@@ -126,7 +126,7 @@ Shp2 = Shp1.extrude(Vector(0,0,10)) - extrude the shape 10 mm in the +Z directio
<UserDocu>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
<UserDocu>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.
</UserDocu>
</Documentation>
</Methode>
@@ -414,14 +414,14 @@ rotated(base,dir,degree) -> shape
<Methode Name="scale">
<Documentation>
<UserDocu>Apply scaling with point and factor to this shape.
scale(factor,[base=Vector(0,0,0)])
scale(factor,[base=App.Vector(0,0,0)])
</UserDocu>
</Documentation>
</Methode>
<Methode Name="scaled" Const="true">
<Documentation>
<UserDocu>Create a new shape with scale.
scaled(factor,[base=Vector(0,0,0)]) -> shape
scaled(factor,[base=App.Vector(0,0,0)]) -> shape
</UserDocu>
</Documentation>
</Methode>
@@ -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)