Salome HOME
Fix line length issue
[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 expression equal to "a=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 - Check item corresponding to the created parameter **a** under **Part_1 / Parameters** node
110 .. image:: images/tutorial1_13.png
111    :align: center
112
113 .. centered::
114    Parameter created during the Sketch operation
115
116 Step2. Polyline.
117 ----------------
118
119 - Start :ref:`Parameter <parameter>` creation via Main Menu *Part - > Parameter*
120 - Set parameter name = "h", set parameter expression = "90", set comment = "nut height"
121 .. image:: images/tutorial2_0.png
122    :align: center
123
124 .. centered::
125    Creation of parameter h = 90
126 - Click **Apply** button to finish parameter creation
127 - Start :ref:`Point <constructionPoint>` creation via Main Menu *Construction - > Point*
128 - Set x = 50, y = 0, z = 0
129 .. image:: images/tutorial2_1.png
130    :align: center
131
132 .. centered::
133    Construction of point (50, 0, 0)
134 - Click **Apply** button to finish point creation
135 - Create points (80, 0, 0), (112, 0, 13), (112, 0, 48), (80, 0, 63), (80, 0, h), (50, 0, h) in the same way
136 - Select the created points in the object browser under **Part_1 / Constructions** node
137 - Click right mouse button and select **Color...** item in the popup menu
138 - Select blue color and click **OK** button
139 .. image:: images/tutorial2_2.png
140    :align: center
141
142 .. centered::
143    Points created from scratch
144 - Start :ref:`Polyline <buildPolyline>` creation via Main Menu *Build - > Polyline*
145 - Select all the 7 points (use **Shift** key for multi-selection)
146 - Check **Closed** check box
147 .. image:: images/tutorial2_3.png
148    :align: center
149
150 .. centered::
151    Creation of closed polyline from 7 points
152 - Click **Apply** button in the property panel
153 .. image:: images/tutorial2_4.png
154    :align: center
155
156 .. centered::
157    Closed Polyline
158
159 Step3. Face.
160 ------------
161
162 - Start :ref:`Face <buildFace>` creation via Main Menu *Build - > Face*
163 - Select **Polyline_1_1** in the object browser under **Part_1 / Results** node
164 .. image:: images/tutorial3_1.png
165    :align: center
166
167 .. centered::
168    Construction of face from a polyline
169 - Click **Apply** button in the property panel
170 .. image:: images/tutorial3_2.png
171    :align: center
172
173 .. centered::
174    Face
175
176 Step4. Revolution.
177 ------------------
178
179 - Start :ref:`Revolution <featureRevolution>` creation via Main Menu *Features - > Revolution*
180 - Select the face created at step 3 in the view
181 - Click on axis input field in the property panel and select **OZ** axis in the view
182 .. image:: images/tutorial4_1.png
183    :align: center
184
185 .. centered::
186    Revolution around OZ by 360 degrees
187 - Click **Apply** button in the property panel
188 .. image:: images/tutorial4_2.png
189    :align: center
190
191 .. centered::
192    Solid created by rotation of face
193
194 Step5. Extrusion.
195 -----------------
196
197 - Start :ref:`Extrusion <featureExtrusion>` creation via Main Menu *Features - > Extrusion*
198 - Select the hexagon created at step 1
199 - Click on axis input field in the property panel and select **OZ** axis in the view
200 - Check **By bounding planes and offsets option**
201 - Select the bottom face of the revolution shape as **From** plane
202 - Select the top face of the revolution shape as **To** plane
203 .. image:: images/tutorial5_1.png
204    :align: center
205
206 .. centered::
207    Extrusion along OZ axis by bounding planes
208 - Click **Apply** button in the property panel
209 .. image:: images/tutorial5_2.png
210    :align: center
211
212 .. centered::
213    Solid created by extrusion of sketch
214
215 Step6. Common.
216 --------------
217
218 - Start :ref:`Common <featureCommon>` creation via Main Menu *Features - > Common*
219 - Select the extrusion and the revolution in the object browser under **Part_1 / Results** node (use **Shift** key for multi-selection)
220 .. image:: images/tutorial6_1.png
221    :align: center
222
223 .. centered::
224    Common creation
225 - Click **Apply** button in the property panel
226 .. image:: images/tutorial6_2.png
227    :align: center
228
229 .. centered::
230    The revolution and the extrusion common part
231
232 Step7. Fillet.
233 --------------
234
235 - Start :ref:`Fillet <featureFillet>` creation via Main Menu *Features - > Fillet*
236 - Select the edge
237 .. image:: images/tutorial7_1.png
238    :align: center
239
240 .. centered::
241    Select edge for a Fillet
242 - Select **Radius** parameter equal to 10
243 .. image:: images/tutorial7_2.png
244    :align: center
245
246 .. centered::
247    Fillet with radius = 10
248 - Click **Apply** button in the property panel
249 .. image:: images/tutorial7_3.png
250    :align: center
251
252 .. centered::
253    Fillet
254
255 Step8. Box.
256 -----------
257
258 - Click right mouse button in the view and select **Hide all** item in the popup menu to clear the view
259 - Start :ref:`Box <box_feature>` creation via Main Menu *Primitives - > Box*
260 - Set **DX** = 10, **DY** = 120, **DZ** = 20
261 .. image:: images/tutorial8_1.png
262    :align: center
263
264 .. centered::
265    Box creation
266 - Click **Apply** button in the property panel
267 .. image:: images/tutorial8_2.png
268    :align: center
269
270 .. centered::
271    Box
272
273 Step9. Translation.
274 -------------------
275
276 - Start :ref:`Translation <featureTranslation>` creation via Main Menu *Part - > Translation*
277 - Check **By X, Y and Z dimensions** option on the top of the property panel
278 - Select the box in the view
279 - Set **DX** = -10, **DY** = 20, **DZ** = 70
280 .. image:: images/tutorial9_1.png
281    :align: center
282
283 .. centered::
284    Box translation
285 - Click **Apply** button in the property panel
286 .. image:: images/tutorial9_2.png
287    :align: center
288
289 .. centered::
290    Translated Box
291
292 Step10. Angular Copy.
293 ---------------------
294
295 - Start :ref:`Angular Copy <featureAngularCopy>` creation via Main Menu *Part - > Angular Copy*
296 - Select the box in the view
297 - Click on axis input field in the property panel and select **OZ** axis in the view
298 - Set **Nb copies** parameter equal to 6
299 .. image:: images/tutorial10_1.png
300    :align: center
301
302 .. centered::
303    Angular Copy around OZ
304 - Click **Apply** button in the property panel
305 .. image:: images/tutorial10_2.png
306    :align: center
307
308 .. centered::
309    Copied Box
310
311 Step11. Cut.
312 ------------
313
314 - Select **Fillet_1_1** item in the object browser under **Part_1 / Results** node
315 - Click on the eye icon on the left of the result item to show it in the view
316 - Start :ref:`Cut <featureCut>` creation via Main Menu *Features - > Cut*
317 - Select the fillet object in the view as a main object
318 - Select the angular copy object in the object browser as a tool object
319 .. image:: images/tutorial11_1.png
320    :align: center
321
322 .. centered::
323    Cut creation
324 - Click **Apply** button in the property panel
325 - Select the created **Cut_1_1** item in the object browser under **Part_1 / Results** node
326 - Click right mouse button and select **Color...** item in the popup menu
327 - Set (R: 255, G: 214, B: 0) color and click **OK** button
328
329 .. image:: images/tutorial11_2.png
330    :align: center
331
332 .. centered::
333    Cut
334
335
336 **See Also** a :ref:`TUI Script <tui_tutorial>` reproducing all the tutorial steps.