Salome HOME
Add tutorial help page.
[modules/shaper.git] / doc / gui / Tutorial.rst
1
2 .. _tutorial:
3
4
5 Tutorial
6 ========
7
8 This exercise illustrates how to create screw-nut shape from scratch.
9
10
11 Step1. Sketch.
12 --------------
13
14 At this step we will create a regular hexagon.
15
16 - Create a :ref:`new-part` via Main Menu *Part - > New part*
17 - Start :ref:`Sketch <sketchPlugin>` creation via Main Menu *Sketch - > Sketch*
18 - Set **Size of the view** parameter equal to 250 in the Sketch dialog
19 - Select **XOY** plane in the view
20 - Click **Set plane view** button in the Sketch property panel
21
22 .. image:: images/tutorial1_1.png
23    :align: center
24
25 .. centered::
26    Skecth plane XOY
27 - Start :ref:`Line <sketchLine>` creation via Main Menu *Sketch - > Line*
28 - Pick 3 points in the view one by one and select the first one at the end to get a triangle:
29
30 .. image:: images/tutorial1_2.png
31    :align: center
32
33 .. centered::
34    3 Lines forming a triangle
35 - Hide trihedron via **Show/Hide trihedron** button in viewer toolbar
36 - Select **Origin** object from **Part set / Constructions** folder in the object browser
37 - Click on the eye icon on the left of the origin item to show it in the view
38 - Select both origin and the bottom vertex of the triangle in the view (use **Shift** key for multi-selection)
39
40 .. image:: images/tutorial1_3.png
41    :align: center
42
43 .. centered::
44    Origin and triangle
45 - Create :ref:`Coincident <sketchCoincident>` constraint via **Coincident** button in Sketch toolbar
46 .. image:: images/tutorial1_4.png
47    :align: center
48
49 .. centered::
50    Triangle vertex coincident with origin
51 - Show trihedron
52 - Select both **OY** axis and the upper side of the triangle in the view
53 - Create :ref:`Perpendicular <sketchPerpendicular>` constraint via **Pependicular** button in Sketch toolbar
54 .. image:: images/tutorial1_5.png
55    :align: center
56
57 .. centered::
58    Upper triangle side perpendicular to OY axis
59 - Select the left and the upper side of the triangle
60 - Create :ref:`Equal <sketchEqual>` constraint via **Equal** button in Sketch toolbar
61 - Make the upper and the right sides equal length in the same way
62 .. image:: images/tutorial1_6.png
63    :align: center
64
65 .. centered::
66    Equilateral triangle
67 - Select the left side of the triangle
68 - Check **Auxiliary** check box in the property panel and click **Apply** button
69 .. image:: images/tutorial1_7.png
70    :align: center
71
72 .. centered::
73    Line property panel
74 - Make the right side auxiliary in the same way
75 .. image:: images/tutorial1_8.png
76    :align: center
77
78 .. centered::
79    The lateral sides are auxiliary
80 - Start creation of :ref:`Angular copy <sketchAngularCopy>` feature via **Angular copy** button in Sketch toolbar
81 - Select the upper side of the triangle for **Segments** parameter in the property panel
82 - Select origin in the view as a center of rotation
83 - Set **Total number** of objects equal to 6
84 .. image:: images/tutorial1_9.png
85    :align: center
86
87 .. centered::
88    Angular copy parameters
89 - Click **Apply** button
90 .. image:: images/tutorial1_10.png
91    :align: center
92
93 .. centered::
94    Regular hexagon
95 - Select the upper side of the hexagon
96 - Start creation of :ref:`Length <sketchLength>` constraint via **Length** button in Sketch toolbar
97 - Set length value equal to 115.4 and press **Enter**
98 .. image:: images/tutorial1_11.png
99    :align: center
100
101 .. centered::
102    Fully fixed regular hexagon
103 - Click **Apply** button in the *Skecth* property panel to finish the sketch creation
104 .. image:: images/tutorial1_12.png
105    :align: center
106
107 .. centered::
108    Finished Sketch
109
110 Step2. Polyline.
111 ----------------
112
113 - Start :ref:`Point <constructionPoint>` creation via Main Menu *Construction - > Point*
114 - Set x = 50, y = 0, z = 0
115 .. image:: images/tutorial2_1.png
116    :align: center
117
118 .. centered::
119    Construction of point (50, 0, 0)
120 - Click **Apply** button to finish point creation
121 - Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, 90), (50, 0, 90) in the same way
122 - Select the created points in the object browser under **Part_1 / Constructions** node
123 - Click right mouse button and select **Color...** item in the popup menu
124 - Select blue color and click **OK** button
125 .. image:: images/tutorial2_2.png
126    :align: center
127
128 .. centered::
129    Points created from scratch
130 - Start :ref:`Polyline <buildPolyline>` creation via Main Menu *Build - > Polyline*
131 - Select all the 7 points (use **Shift** key for multi-selection)
132 - Check **Closed** check box
133 .. image:: images/tutorial2_3.png
134    :align: center
135
136 .. centered::
137    Creation of closed polyline from 7 points
138 - Click **Apply** button in the property panel
139 .. image:: images/tutorial2_4.png
140    :align: center
141
142 .. centered::
143    Closed Polyline
144
145 Step3. Face.
146 ------------
147
148 - Start :ref:`Face <buildFace>` creation via Main Menu *Build - > Face*
149 - Select **Polyline_1_1** in the object browser under **Part_1 / Results** node
150 .. image:: images/tutorial3_1.png
151    :align: center
152
153 .. centered::
154    Construction of face from a polyline
155 - Click **Apply** button in the property panel
156 .. image:: images/tutorial3_2.png
157    :align: center
158
159 .. centered::
160    Face
161
162 Step4. Revolution.
163 ------------------
164
165 - Start :ref:`Revolution <featureRevolution>` creation via Main Menu *Features - > Revolution*
166 - Select the face created at step 3 in the view
167 - Click on axis input field in the property panel and select **OZ** axis in the view
168 .. image:: images/tutorial4_1.png
169    :align: center
170
171 .. centered::
172    Revolution around OZ by 360 degrees
173 - Click **Apply** button in the property panel
174 .. image:: images/tutorial4_2.png
175    :align: center
176
177 .. centered::
178    Solid created by rotation of face
179
180 Step5. Extrusion.
181 -----------------
182
183 - Start :ref:`Extrusion <featureExtrusion>` creation via Main Menu *Features - > Extrusion*
184 - Select the hexagon created at step 1
185 - Click on axis input field in the property panel and select **OZ** axis in the view
186 - Set **To size** parameter equal to 100
187 .. image:: images/tutorial5_1.png
188    :align: center
189
190 .. centered::
191    Extrusion along OZ axis from 0 to 100
192 - Click **Apply** button in the property panel
193 .. image:: images/tutorial5_2.png
194    :align: center
195
196 .. centered::
197    Solid created by extrusion of sketch
198
199 Step6. Common.
200 --------------
201
202 - Start :ref:`Common <featureCommon>` creation via Main Menu *Features - > Common*
203 - Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection)
204 .. image:: images/tutorial6_1.png
205    :align: center
206
207 .. centered::
208    Common creation
209 - Click **Apply** button in the property panel
210 .. image:: images/tutorial6_2.png
211    :align: center
212
213 .. centered::
214    The revolution and the extrusion common part
215
216 Step7. Fillet.
217 --------------
218
219 - Start :ref:`Fillet <featureFillet>` creation via Main Menu *Features - > Fillet*
220 - Select the edge
221 .. image:: images/tutorial7_1.png
222    :align: center
223
224 .. centered::
225    Select edge for a Fillet
226 - Select **Radius** parameter equal to 10
227 .. image:: images/tutorial7_2.png
228    :align: center
229
230 .. centered::
231    Fillet with radius = 10
232 - Click **Apply** button in the property panel
233 .. image:: images/tutorial7_3.png
234    :align: center
235
236 .. centered::
237    Fillet
238
239 Step8. Box.
240 -----------
241
242 - Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view
243 - Start :ref:`Box <box_feature>` creation via Main Menu *Primitives - > Box*
244 - Set **DX** = 10, **DY** = 120, **DZ** = 20
245 .. image:: images/tutorial8_1.png
246    :align: center
247
248 .. centered::
249    Box creation
250 - Click **Apply** button in the property panel
251 .. image:: images/tutorial8_2.png
252    :align: center
253
254 .. centered::
255    Box
256
257 Step9. Translation.
258 -------------------
259
260 - Start :ref:`Translation <featureTranslation>` creation via Main Menu *Part - > Translation*
261 - Check **By X, Y and Z dimensions** option on the top of the property panel
262 - Select the box in the view
263 - Set **DX** = -10, **DY** = 20, **DZ** = 70
264 .. image:: images/tutorial9_1.png
265    :align: center
266
267 .. centered::
268    Box translation
269 - Click **Apply** button in the property panel
270 .. image:: images/tutorial9_2.png
271    :align: center
272
273 .. centered::
274    Translated Box
275
276 Step10. Angular Copy.
277 ---------------------
278
279 - Start :ref:`Angular Copy <featureAngularCopy>` creation via Main Menu *Part - > Angular Copy*
280 - Select the box in the view
281 - Click on axis input field in the property panel and select **OZ** axis in the view
282 - Set **Nb copies** parameter equal to 6
283 .. image:: images/tutorial10_1.png
284    :align: center
285
286 .. centered::
287    Angular Copy around OZ
288 - Click **Apply** button in the property panel
289 .. image:: images/tutorial10_2.png
290    :align: center
291
292 .. centered::
293    Copied Box
294
295 Step11. Cut.
296 ------------
297
298 - Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node
299 - Click on the eye icon on the left of the result item to show it in the view
300 - Start :ref:`Cut <featureCut>` creation via Main Menu *Features - > Cut*
301 - Select the fillet object in the view as a main object
302 - Select the angular copy object in the object browser as a tool object
303 .. image:: images/tutorial11_1.png
304    :align: center
305
306 .. centered::
307    Cut creation
308 - Click **Apply** button in the property panel
309 - Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node
310 - Click right mouse button and select **Color...** item in the popup menu
311 - Set (R: 255, G: 214, B: 0) color and click **OK** button
312
313 .. image:: images/tutorial11_2.png
314    :align: center
315
316 .. centered::
317    Cut
318
319
320 **See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.