X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPrimitivesPlugin%2Fdoc%2FcylinderFeature.rst;h=b0f1dac3066186ea8f2134efe1c1b79734e3f094;hb=d3afed6da21a10db226a968698b63af318e6111e;hp=0308890ad4f1f57e1f591d9cff5866912d9737c0;hpb=d3636d9a263bea301d2f8e5c5951c6d0dce0fbf2;p=modules%2Fshaper.git diff --git a/src/PrimitivesPlugin/doc/cylinderFeature.rst b/src/PrimitivesPlugin/doc/cylinderFeature.rst index 0308890ad..b0f1dac30 100644 --- a/src/PrimitivesPlugin/doc/cylinderFeature.rst +++ b/src/PrimitivesPlugin/doc/cylinderFeature.rst @@ -1,29 +1,30 @@ +.. |Cylinder_button.icon| image:: images/Cylinder_button.png Cylinder ======== -The feature Cylinder creates a cylinder solid. +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 -**Portion of cylinder** creates one segment of cylinder. + :height: 24px + +**Portion of cylinder** creates one segment of a cylinder. + +-------------------------------------------------------------------------------- Cylinder -------- @@ -36,20 +37,27 @@ Cylinder Input fields: -- **Point** defines center of the cylinder base selected in 3D OCC viewer or object browser; +- **Point** defines the center of the cylinder base selected in 3D OCC viewer or object browser; - **Vector** defines the axis of the cylinder selected in 3D OCC viewer or object browser; - Dimensions: - **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 """""" -Example is shown below. +An example is shown below. .. image:: images/Cylinder1.png :align: center @@ -57,7 +65,7 @@ Example is shown below. .. centered:: Cylinder -**See Also** a sample TUI Script of a :ref:`tui_create_cylinder` operation. +**See Also** a sample TUI Script of :ref:`tui_create_cylinder` operation. Portion of cylinder ------------------- @@ -68,16 +76,24 @@ Portion of cylinder .. centered:: **Portion of cylinder** property panel -Input fields for ***Portion of cylinder** tab includes in addition **Angle** to create a portion of cylinder. +Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder. + +**TUI Commands**: -**TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)* +.. 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 """""" -Example is shown below. +An example is shown below. .. image:: images/Cylinder2.png :align: center @@ -85,4 +101,4 @@ Example is shown below. .. centered:: Portion of cylinder -**See Also** a sample TUI Script of a :ref:`tui_create_cylportion` operation. +**See Also** a sample TUI Script of :ref:`tui_create_cylportion` operation.