Salome HOME
Merge branch 'fbt/addAngleInCylPrimitive'
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_extrusion_alongpath.doc
index 7095d2e59b56f858d7fa0e4925aa419efc8f6d35..8c543023267310530f903366ac20b68c9d97c0d7 100644 (file)
@@ -7,12 +7,13 @@ To generate a \b Pipe in the <b>Main Menu</b> select <b>New Entity - > Generatio
 \n Firstly, to create an extruded \b Pipe shape, you can define the <b>Base
 Object</b> (vertex, edge, planar wire, face or shell), which will be extruded
 and the <b>Path Object</b> (edge or wire) along which the <b>Base 
 \n Firstly, to create an extruded \b Pipe shape, you can define the <b>Base
 Object</b> (vertex, edge, planar wire, face or shell), which will be extruded
 and the <b>Path Object</b> (edge or wire) along which the <b>Base 
-Object</b> will be extruded.
+Object</b> will be extruded.<br>
+It is possible to select in GUI several Base Objects to make several pipes (using Shift button).
 \n In this mode the default pipe generation algorithm is used. The pipe
 \n In this mode the default pipe generation algorithm is used. The pipe
-is created in such a way that the <b>angle between the normal vector</b> to
-the base shape <b>and the tangent to the path</b> wire at any point of the
-given path <b>is kept constant</b>.
-\n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. 
+is created so that the <b>angle between the normal vector</b> to
+the base shape <b>and the tangent to the path</b> wire remains constant at any point of the
+given path.
+\n <b>Select unpublished edges</b> checkbox - if checked, allows to select an edge of any other shape as the path object. 
 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
 solid or compsolid).
 
 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
 solid or compsolid).
 
@@ -20,22 +21,24 @@ solid or compsolid).
 \n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
 shell) serving as base object + 1 shape (edge or wire) for
 definition of the path.
 \n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
 shell) serving as base object + 1 shape (edge or wire) for
 definition of the path.
+\n <b>Advanced options</b> \ref preview_anchor "Preview"
 
 \image html pipe.png
 
 <b>Example:</b>
 
 
 \image html pipe.png
 
 <b>Example:</b>
 
-\image html pipe_wire_edgesn.png "Extrusion of wire"
+\image html pipe_wire_edgesn.png "Extrusion of wire"
 
 \n Secondly, you can define the <b>Base
 Object</b> (edge, planar wire or face), which will be extruded, 
 the <b>Path Object</b> (edge or wire) along which the <b>Base 
 
 \n Secondly, you can define the <b>Base
 Object</b> (edge, planar wire or face), which will be extruded, 
 the <b>Path Object</b> (edge or wire) along which the <b>Base 
-Object</b> will be extruded and the <b>Vector</b> (edge or wire).
+Object</b> will be extruded and the <b>BiNormal Vector</b> (edge or
+wire).
+
 \n In contrast to the default mode, in this mode the pipe is generated
 \n In contrast to the default mode, in this mode the pipe is generated
-in such a way that the <b>angle between the normal vector</b> to the base
-shape <b>and the BiNormal vector</b> given as the third argument <b>is kept
-constant</b>.
-\n Check Box <b>Select unpublished edges</b> - if checked, allows to select an edge of any other shape as the path object. 
+to preserve the constant <b>angle between the normal vector</b> to the base
+shape <b>and the BiNormal vector</b> given as the third argument.
+\n <b>Select unpublished edges</b> checkbox - if checked, allows to select an edge of any other shape as the path object. 
 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
 solid or compsolid).
 
 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
 solid or compsolid).
 
@@ -49,7 +52,34 @@ BiNormal direction to perform the extrusion.
 
 <b>Example:</b>
 
 
 <b>Example:</b>
 
-\image html pipebinormalsn.png "Extrusion of face with BiNormal parameter"
+\image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter"
+
+\n Thirdly, it is possible to additionally select profiles of the pipe object to be built. For this, you can define the following parameters:
+- <b>Base Object</b> or a list of objects (edges, planar wires, faces or shells), which will be extruded;
+- <b>Locations</b> - a vertex or a list of vertices that specify the locations of extruded <b>Base Objects</b> on the resulting <b>Path Object</b>. The number of Base Objects should be equal to the number of <b>Locations</b>.
+- <b>Path Object</b> (edge or wire), along which the <b>Base Object</b> will be extruded.
+
+Additional controls:
+- If <b>With contact</b> is checked, the section is translated in contact with the spine.
+- If <b>With correction</b> is checked, the section is rotated to be orthogonal to the spine
+tangent in the corresponding point.
+
+\n The \b Result of the operation will be a shell or a solid.
+
+\n <b>TUI Command:</b> <em>geompy.MakePipeWithDifferentSections(baseShape, locations, pathShape, withContact, withCorrection)</em>
+\n <b>Arguments:</b> Name + list of shapes (edges, planar wires, faces or shells) serving as base object + 
+list of locations (vertices) on the path corresponding specified list of the shapes + 
+1 shape (edge or wire) for definition of the path + 
+2 Boolean parameters (withContact, withCorrection).
+\n <b>Advanced options</b> \ref preview_anchor "Preview"
+
+\image html pipe3.png
+
+<b>Example:</b>
+
+\image html pipe3_init.png "Base objects and Location vertices"
+
+\image html pipe3_res.png "Extrusion of the profile shapes along the path shape"
 
 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 \ref tui_creation_pipe "Complex Geometric Objects".
 
 Our <b>TUI Scripts</b> provide you with useful examples of creation of
 \ref tui_creation_pipe "Complex Geometric Objects".