Salome HOME
Update from BR_V5_DEV 13Feb2009
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_extrusion_alongpath.doc
1 /*!
2
3 \page create_extrusion_alongpath_page Pipe Construction
4
5 To generate a \b Pipe in the <b>Main Menu</b> select <b>New Entity - > Generation  - > Extrusion along a path</b>
6
7 \n Firstly, to create an extruded \b Pipe shape, you can define the <b>Base
8 Object</b> (vertex, edge, planar wire, face or shell), which will be extruded
9 and the <b>Path Object</b> (edge or wire) along which the <b>Base 
10 Object</b> will be extruded.
11 \n In this mode the default pipe generation algorithm is used. The pipe
12 is created in such a way that the <b>angle between the normal vector</b> to
13 the base shape <b>and the tangent to the path</b> wire at any point of the
14 given path <b>is kept constant</b>.
15 \n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. 
16 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
17 solid or compsolid).
18
19 \n <b>TUI Command:</b> <em>geompy.MakePipe(baseShape, pathShape)</em>
20 \n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
21 shell) serving as base object + 1 shape (edge or wire) for
22 definition of the path.
23
24 \image html pipe.png
25
26 <b>Example:</b>
27
28 \image html pipe_wire_edgesn.png "Extrusion of wire"
29
30 \n Secondly, you can define the <b>Base
31 Object</b> (edge, planar wire or face), which will be extruded, 
32 the <b>Path Object</b> (edge or wire) along which the <b>Base 
33 Object</b> will be extruded and the <b>Vector</b> (edge or wire).
34 \n In contrast to the default mode, in this mode the pipe is generated
35 in such a way that the <b>angle between the normal vector</b> to the base
36 shape <b>and the BiNormal vector</b> given as the third argument <b>is kept
37 constant</b>.
38 \n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. 
39 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
40 solid or compsolid).
41
42 \n <b>TUI Command:</b> <em>geompy.MakePipeBiNormalAlongVector(baseShape, pathShape, binormalShape)</em>
43 \n <b>Arguments:</b> Name + 1 shape (edge, planar wire or face) 
44 serving as base object + 1 shape (edge or wire) for
45 definition of the path + 1 shape (edge or wire) to set a fixed 
46 BiNormal direction to perform the extrusion.
47
48 \image html pipe2.png
49
50 <b>Example:</b>
51
52 \image html pipebinormalsn.png "Extrusion of face with BiNormal parameter"
53
54 Our <b>TUI Scripts</b> provide you with useful examples of creation of
55 \ref tui_creation_pipe "Complex Geometric Objects".
56
57 */