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