Salome HOME
Update GEOM documentation
[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 so that the <b>angle between the normal vector</b> to
13 the base shape <b>and the tangent to the path</b> wire remains constant at any point of the
14 given path.
15 \n <b>Select unpublished edges</b> checkbox - 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 a 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>BiNormal Vector</b> (edge or
34 wire).
35
36 \n In contrast to the default mode, in this mode the pipe is generated
37 to preserve the constant <b>angle between the normal vector</b> to the base
38 shape <b>and the BiNormal vector</b> given as the third argument.
39 \n <b>Select unpublished edges</b> checkbox - if checked, allows to select an edge of any other shape as the path object. 
40 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
41 solid or compsolid).
42
43 \n <b>TUI Command:</b> <em>geompy.MakePipeBiNormalAlongVector(baseShape, pathShape, binormalShape)</em>
44 \n <b>Arguments:</b> Name + 1 shape (edge, planar wire or face) 
45 serving as base object + 1 shape (edge or wire) for
46 definition of the path + 1 shape (edge or wire) to set a fixed 
47 BiNormal direction to perform the extrusion.
48
49 \image html pipe2.png
50
51 <b>Example:</b>
52
53 \image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter"
54
55 Our <b>TUI Scripts</b> provide you with useful examples of creation of
56 \ref tui_creation_pipe "Complex Geometric Objects".
57
58 */