Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / doc / gui / Tutorial.rst
index f3aba125b08f39888f40e3b851f90b42e06d4ae6..d9bc3eb9adc646fc2523aa558cb23b1a17604454 100644 (file)
@@ -8,7 +8,7 @@ Tutorial
 This exercise illustrates how to create screw-nut shape from scratch.
 
 
-Step1. Sketch.
+Step 1. Sketch
 --------------
 
 At this step we will create a regular hexagon.
@@ -19,179 +19,194 @@ At this step we will create a regular hexagon.
 - Select **XOY** plane in the view
 - Click **Set plane view** button in the Sketch property panel
 
-.. image:: images/tutorial1_1.png
+.. figure:: images/tutorial1_1.png
    :align: center
 
-.. centered::
    Skecth plane XOY
+
 - Start :ref:`Line <sketchLine>` creation via Main Menu *Sketch - > Line*
 - Pick 3 points in the view one by one and select the first one at the end to get a triangle:
 
-.. image:: images/tutorial1_2.png
+.. figure:: images/tutorial1_2.png
    :align: center
 
-.. centered::
    3 Lines forming a triangle
+
 - Hide trihedron via **Show/Hide trihedron** button in viewer toolbar
 - Select **Origin** object from **Part set / Constructions** folder in the object browser
 - Click on the eye icon on the left of the origin item to show it in the view
 - Select both origin and the bottom vertex of the triangle in the view (use **Shift** key for multi-selection)
 
-.. image:: images/tutorial1_3.png
+.. figure:: images/tutorial1_3.png
    :align: center
 
-.. centered::
    Origin and triangle
+
 - Create :ref:`Coincident <sketchCoincident>` constraint via **Coincident** button in Sketch toolbar
-.. image:: images/tutorial1_4.png
+
+.. figure:: images/tutorial1_4.png
    :align: center
 
-.. centered::
    Triangle vertex coincident with origin
+
 - Show trihedron
 - Select both **OY** axis and the upper side of the triangle in the view
 - Create :ref:`Perpendicular <sketchPerpendicular>` constraint via **Pependicular** button in Sketch toolbar
-.. image:: images/tutorial1_5.png
+
+.. figure:: images/tutorial1_5.png
    :align: center
 
-.. centered::
    Upper triangle side perpendicular to OY axis
+
 - Select the left and the upper side of the triangle
 - Create :ref:`Equal <sketchEqual>` constraint via **Equal** button in Sketch toolbar
 - Make the upper and the right sides equal length in the same way
-.. image:: images/tutorial1_6.png
+
+.. figure:: images/tutorial1_6.png
    :align: center
 
-.. centered::
    Equilateral triangle
+
 - Select the left side of the triangle
 - Check **Auxiliary** check box in the property panel and click **Apply** button
-.. image:: images/tutorial1_7.png
+
+.. figure:: images/tutorial1_7.png
    :align: center
 
-.. centered::
    Line property panel
+
 - Make the right side auxiliary in the same way
-.. image:: images/tutorial1_8.png
+
+.. figure:: images/tutorial1_8.png
    :align: center
 
-.. centered::
    The lateral sides are auxiliary
+
 - Start creation of :ref:`Angular copy <sketchAngularCopy>` feature via **Angular copy** button in Sketch toolbar
 - Select the upper side of the triangle for **Segments** parameter in the property panel
 - Select origin in the view as a center of rotation
 - Set **Total number** of objects equal to 6
-.. image:: images/tutorial1_9.png
+
+.. figure:: images/tutorial1_9.png
    :align: center
 
-.. centered::
    Angular copy parameters
+
 - Click **Apply** button
-.. image:: images/tutorial1_10.png
+
+.. figure:: images/tutorial1_10.png
    :align: center
 
-.. centered::
    Regular hexagon
+
 - Select the upper side of the hexagon
 - Start creation of :ref:`Length <sketchLength>` constraint via **Length** button in Sketch toolbar
 - Set length expression equal to "a=115.4" and press **Enter**
-.. image:: images/tutorial1_11.png
+
+.. figure:: images/tutorial1_11.png
    :align: center
 
-.. centered::
    Fully fixed regular hexagon
+
 - Click **Apply** button in the *Skecth* property panel to finish the sketch creation
-.. image:: images/tutorial1_12.png
+
+.. figure:: images/tutorial1_12.png
    :align: center
 
-.. centered::
    Finished Sketch
+
 - Check item corresponding to the created parameter **a** under **Part_1 / Parameters** node
-.. image:: images/tutorial1_13.png
+
+.. figure:: images/tutorial1_13.png
    :align: center
 
-.. centered::
    Parameter created during the Sketch operation
 
-Step2. Polyline.
+Step 2. Polyline
 ----------------
 
 - Start :ref:`Parameter <parameter>` creation via Main Menu *Part - > Parameter*
 - Set parameter name = "h", set parameter expression = "90", set comment = "nut height"
-.. image:: images/tutorial2_0.png
+
+.. figure:: images/tutorial2_0.png
    :align: center
 
-.. centered::
    Creation of parameter h = 90
+
 - Click **Apply** button to finish parameter creation
 - Start :ref:`Point <constructionPoint>` creation via Main Menu *Construction - > Point*
 - Set x = 50, y = 0, z = 0
-.. image:: images/tutorial2_1.png
+
+.. figure:: images/tutorial2_1.png
    :align: center
 
-.. centered::
    Construction of point (50, 0, 0)
+
 - Click **Apply** button to finish point creation
 - Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, h), (50, 0, h) in the same way
 - Select the created points in the object browser under **Part_1 / Constructions** node
 - Click right mouse button and select **Color...** item in the popup menu
 - Select blue color and click **OK** button
-.. image:: images/tutorial2_2.png
+
+.. figure:: images/tutorial2_2.png
    :align: center
 
-.. centered::
    Points created from scratch
+
 - Start :ref:`Polyline <buildPolyline>` creation via Main Menu *Build - > Polyline*
 - Select all the 7 points (use **Shift** key for multi-selection)
 - Check **Closed** check box
-.. image:: images/tutorial2_3.png
+
+.. figure:: images/tutorial2_3.png
    :align: center
 
-.. centered::
    Creation of closed polyline from 7 points
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial2_4.png
+
+.. figure:: images/tutorial2_4.png
    :align: center
 
-.. centered::
    Closed Polyline
 
-Step3. Face.
+Step 3. Face
 ------------
 
 - Start :ref:`Face <buildFace>` creation via Main Menu *Build - > Face*
 - Select **Polyline_1_1** in the object browser under **Part_1 / Results** node
-.. image:: images/tutorial3_1.png
+
+.. figure:: images/tutorial3_1.png
    :align: center
 
-.. centered::
    Construction of face from a polyline
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial3_2.png
+
+.. figure:: images/tutorial3_2.png
    :align: center
 
-.. centered::
    Face
 
-Step4. Revolution.
+Step 4. Revolution
 ------------------
 
 - Start :ref:`Revolution <featureRevolution>` creation via Main Menu *Features - > Revolution*
 - Select the face created at step 3 in the view
 - Click on axis input field in the property panel and select **OZ** axis in the view
-.. image:: images/tutorial4_1.png
+
+.. figure:: images/tutorial4_1.png
    :align: center
 
-.. centered::
    Revolution around OZ by 360 degrees
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial4_2.png
+
+.. figure:: images/tutorial4_2.png
    :align: center
 
-.. centered::
    Solid created by rotation of face
 
-Step5. Extrusion.
+Step 5. Extrusion
 -----------------
 
 - Start :ref:`Extrusion <featureExtrusion>` creation via Main Menu *Features - > Extrusion*
@@ -200,115 +215,122 @@ Step5. Extrusion.
 - Check **By bounding planes and offsets option**
 - Select the bottom face of the revolution shape as **From** plane
 - Select the top face of the revolution shape as **To** plane
-.. image:: images/tutorial5_1.png
+
+.. figure:: images/tutorial5_1.png
    :align: center
 
-.. centered::
    Extrusion along OZ axis by bounding planes
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial5_2.png
+
+.. figure:: images/tutorial5_2.png
    :align: center
 
-.. centered::
    Solid created by extrusion of sketch
 
-Step6. Common.
+Step 6. Common
 --------------
 
 - Start :ref:`Common <featureCommon>` creation via Main Menu *Features - > Common*
 - Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection)
-.. image:: images/tutorial6_1.png
+
+.. figure:: images/tutorial6_1.png
    :align: center
 
-.. centered::
    Common creation
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial6_2.png
+
+.. figure:: images/tutorial6_2.png
    :align: center
 
-.. centered::
    The revolution and the extrusion common part
 
-Step7. Fillet.
+Step 7. Fillet
 --------------
 
 - Start :ref:`Fillet <featureFillet>` creation via Main Menu *Features - > Fillet*
 - Select the edge
-.. image:: images/tutorial7_1.png
+
+.. figure:: images/tutorial7_1.png
    :align: center
 
-.. centered::
    Select edge for a Fillet
+
 - Select **Radius** parameter equal to 10
-.. image:: images/tutorial7_2.png
+
+.. figure:: images/tutorial7_2.png
    :align: center
 
-.. centered::
    Fillet with radius = 10
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial7_3.png
+
+.. figure:: images/tutorial7_3.png
    :align: center
 
-.. centered::
    Fillet
 
-Step8. Box.
+Step 8. Box
 -----------
 
 - Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view
 - Start :ref:`Box <box_feature>` creation via Main Menu *Primitives - > Box*
 - Set **DX** = 10, **DY** = 120, **DZ** = 20
-.. image:: images/tutorial8_1.png
+
+.. figure:: images/tutorial8_1.png
    :align: center
 
-.. centered::
    Box creation
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial8_2.png
+
+.. figure:: images/tutorial8_2.png
    :align: center
 
-.. centered::
    Box
 
-Step9. Translation.
+Step 9. Translation
 -------------------
 
 - Start :ref:`Translation <featureTranslation>` creation via Main Menu *Part - > Translation*
 - Check **By X, Y and Z dimensions** option on the top of the property panel
 - Select the box in the view
 - Set **DX** = -10, **DY** = 20, **DZ** = 70
-.. image:: images/tutorial9_1.png
+
+.. figure:: images/tutorial9_1.png
    :align: center
 
-.. centered::
    Box translation
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial9_2.png
+
+.. figure:: images/tutorial9_2.png
    :align: center
 
-.. centered::
    Translated Box
 
-Step10. Angular Copy.
+Step 10. Angular Copy
 ---------------------
 
 - Start :ref:`Angular Copy <featureAngularCopy>` creation via Main Menu *Part - > Angular Copy*
 - Select the box in the view
 - Click on axis input field in the property panel and select **OZ** axis in the view
 - Set **Nb copies** parameter equal to 6
-.. image:: images/tutorial10_1.png
+
+.. figure:: images/tutorial10_1.png
    :align: center
 
-.. centered::
    Angular Copy around OZ
+
 - Click **Apply** button in the property panel
-.. image:: images/tutorial10_2.png
+
+.. figure:: images/tutorial10_2.png
    :align: center
 
-.. centered::
    Copied Box
 
-Step11. Cut.
+Step 11. Cut
 ------------
 
 - Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node
@@ -316,21 +338,20 @@ Step11. Cut.
 - Start :ref:`Cut <featureCut>` creation via Main Menu *Features - > Cut*
 - Select the fillet object in the view as a main object
 - Select the angular copy object in the object browser as a tool object
-.. image:: images/tutorial11_1.png
+
+.. figure:: images/tutorial11_1.png
    :align: center
 
-.. centered::
    Cut creation
+
 - Click **Apply** button in the property panel
 - Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node
 - Click right mouse button and select **Color...** item in the popup menu
 - Set (R: 255, G: 214, B: 0) color and click **OK** button
 
-.. image:: images/tutorial11_2.png
+.. figure:: images/tutorial11_2.png
    :align: center
 
-.. centered::
    Cut
 
-
-**See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.
\ No newline at end of file
+**See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.