Salome HOME
projects
/
modules
/
shaper.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Ameliorate help pages
[modules/shaper.git]
/
src
/
PrimitivesPlugin
/
doc
/
torusFeature.rst
diff --git
a/src/PrimitivesPlugin/doc/torusFeature.rst
b/src/PrimitivesPlugin/doc/torusFeature.rst
index e9579981bdd233589fa614801a9576ae91fd2d31..31f59fc6ad38f7df462a0ad56d0c1fb630ededb5 100644
(file)
--- a/
src/PrimitivesPlugin/doc/torusFeature.rst
+++ b/
src/PrimitivesPlugin/doc/torusFeature.rst
@@
-1,3
+1,4
@@
+.. |Torus_button.icon| image:: images/Torus_button.png
Torus
=====
Torus
=====
@@
-7,13
+8,7
@@
Torus feature creates a torus solid.
To create a Torus in the active part:
#. select in the Main Menu *Primitives - > Torus* item or
To create a Torus in the active part:
#. select in the Main Menu *Primitives - > Torus* item or
-#. click **Torus** button in the toolbar
-
-.. image:: images/Torus_button.png
- :align: center
-
-.. centered::
- **Torus** button
+#. click |Torus_button.icon| **Torus** button in the toolbar
The following property panel appears.
The following property panel appears.
@@
-31,9
+26,16
@@
Input fields:
- **Radius**;
- **Ring radius**.
- **Radius**;
- **Ring radius**.
-**TUI Command**: *model.addTorus(Part_doc, Point, Axis, Radius1, Radius2)*
+**TUI Command**:
+
+.. py:function:: model.addTorus(Part_doc, Point, Axis, Radius1, Radius2)
-**Arguments**: Part + 1 vertex + 1 vector + 2 real values (first and second radii).
+ :param part: The current part object.
+ :param object: Vertex.
+ :param object: Axis.
+ :param real: Radius 1.
+ :param real: Radius 2.
+ :return: Result object.
Result
""""""
Result
""""""