X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPrimitivesPlugin%2Fdoc%2FcylinderFeature.rst;h=b0f1dac3066186ea8f2134efe1c1b79734e3f094;hb=d3afed6da21a10db226a968698b63af318e6111e;hp=7a09ffd35e4a162067aea818b007e471eec44007;hpb=bcd96990e1fca77402d522bc8b095ebfa1091894;p=modules%2Fshaper.git diff --git a/src/PrimitivesPlugin/doc/cylinderFeature.rst b/src/PrimitivesPlugin/doc/cylinderFeature.rst index 7a09ffd35..b0f1dac30 100644 --- a/src/PrimitivesPlugin/doc/cylinderFeature.rst +++ b/src/PrimitivesPlugin/doc/cylinderFeature.rst @@ -1,3 +1,4 @@ +.. |Cylinder_button.icon| image:: images/Cylinder_button.png Cylinder ======== @@ -7,24 +8,24 @@ Cylinder feature creates a cylinder solid. To create a Cylinder in the active part: #. select in the Main Menu *Primitives - > Cylinder* item or -#. click **Cylinder** button in the toolbar - -.. image:: images/Cylinder_button.png - :align: center - -.. centered:: - **Cylinder** button +#. click |Cylinder_button.icon| **Cylinder** button in the toolbar There are 2 algorithms for creation of a Cylinder: .. image:: images/cylinder_32x32.png :align: left + :height: 24px + **Cylinder** creates a cylinder. .. image:: images/cylinder_portion_32x32.png :align: left + :height: 24px + **Portion of cylinder** creates one segment of a cylinder. +-------------------------------------------------------------------------------- + Cylinder -------- @@ -42,9 +43,16 @@ Input fields: - **Radius**; - **Height**. -**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height)* +**TUI Commands**: -**Arguments**: Part + 1 vertex +1 vector + 2 real values (radius, height). +.. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height) + + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius. + :param real: Height. + :return: Result object. Result """""" @@ -70,9 +78,17 @@ Portion of cylinder Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder. -**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)* +**TUI Commands**: + +.. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle) -**Arguments**: 1 Part + 1 vertex +1 vector + 3 real values (radius, height and angle). + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius. + :param real: Height. + :param real: Angle. + :return: Result object. Result """"""