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

fix some TopoShape documentation

Browse Source
This commit is contained in:
tomate44
2018-01-21 12:03:53 +01:00
parent 3c679c13ca
commit ecce5eea6d
4 changed files with 31 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/Mod/Part/App/TopoShapeCompoundPy.xml
View File

@@ -21,8 +21,11 @@
</Methode>
<Methode Name="connectEdgesToWires" Const="true">
<Documentation>
<UserDocu>Build a compound of wires out of the edges of this compound.</UserDocu>
<UserDocu>Build a compound of wires out of the edges of this compound.
myCompound.connectEdgesToWires( Shared = True, Tolerance = 1e-7)
If Shared is True connection is performed only when adjacent edges share the same vertex.
If Shared is False connection is performed only when ends of adjacent edges are at distance less than Tolerance.</UserDocu>
</Documentation>
</Methode>
</PythonExport>
</GenerateModel>
</GenerateModel>

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

@@ -135,7 +135,9 @@ Part.show(r)
<Methode Name="check" Const="true">
<Documentation>
<UserDocu>Checks the shape and report errors in the shape structure.
This is a more detailed check as done in isValid().</UserDocu>
This is a more detailed check as done in isValid().
myShape.check(runBopCheck = False)
if runBopCheck is True, a BOPCheck analysis is also performed.</UserDocu>
</Documentation>
</Methode>
<Methode Name="fuse" Const="true">

6
src/Mod/Part/App/TopoShapeSolidPy.xml
View File

@@ -82,12 +82,14 @@ shape if the solid has no shells</UserDocu>
</Attribute>
<Methode Name="getMomentOfInertia">
<Documentation>
<UserDocu>computes the moment of inertia of the material system about the axis A.</UserDocu>
<UserDocu>computes the moment of inertia of the material system about the axis A.
mySolid.getMomentOfInertia( point, direction )</UserDocu>
</Documentation>
</Methode>
<Methode Name="getRadiusOfGyration">
<Documentation>
<UserDocu>Returns the radius of gyration of the current system about the axis A.</UserDocu>
<UserDocu>Returns the radius of gyration of the current system about the axis A.
mySolid.getRadiusOfGyration( point, direction )</UserDocu>
</Documentation>
</Methode>
<Methode Name="offsetFaces" ReadOnly="true">

35
src/Mod/Part/App/TopoShapeWirePy.xml
View File

@@ -14,22 +14,25 @@
<Author Licence="LGPL" Name="Juergen Riegel" EMail="Juergen.Riegel@web.de" />
<UserDocu>TopoShapeWire is the OpenCasCade topological wire wrapper</UserDocu>
</Documentation>
<Methode Name="makeOffset" Const="true">
<Documentation>
<UserDocu>Offset the shape by a given amount. DEPRECATED - use makeOffset2D instead.</UserDocu>
</Documentation>
</Methode>
<Methode Name="add">
<Documentation>
<UserDocu>Add an edge to the wire</UserDocu>
</Documentation>
</Methode>
<Methode Name="fixWire">
<Documentation>
<UserDocu>Fix wire</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeHomogenousWires" Const="true">
<Methode Name="makeOffset" Const="true">
<Documentation>
<UserDocu>Offset the shape by a given amount. DEPRECATED - use makeOffset2D instead.</UserDocu>
</Documentation>
</Methode>
<Methode Name="add">
<Documentation>
<UserDocu>Add an edge to the wire</UserDocu>
</Documentation>
</Methode>
<Methode Name="fixWire">
<Documentation>
<UserDocu>Fix wire
A face and a tolerance can optionally be supplied to the algorithm :
myWire.fixWire( face, tolerance )
</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeHomogenousWires" Const="true">
<Documentation>
<UserDocu>Make this and the given wire homogenous to have the same number of edges</UserDocu>
</Documentation>