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.<br>
  11 It is possible to select in GUI several Base Objects to make several pipes (using Shift button).
  12 \n In this mode the default pipe generation algorithm is used. The pipe
  13 is created so that the <b>angle between the normal vector</b> to
  14 the base shape <b>and the tangent to the path</b> wire remains constant at any point of the
  15 given path.
  16 \n <b>Select unpublished edges</b> checkbox - if checked, allows to select an edge of any other shape as the path object.
  17 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
  18 solid or compsolid).
  19
  20 \n <b>TUI Command:</b> <em>geompy.MakePipe(baseShape, pathShape)</em>
  21 \n <b>Arguments:</b> Name + 1 shape (vertex, edge, planar wire, face or
  22 shell) serving as base object + 1 shape (edge or wire) for
  23 definition of the path.
  24 \n <b>Advanced options</b> \ref preview_anchor "Preview"
  25
  26 \image html pipe.png
  27
  28 <b>Example:</b>
  29
  30 \image html pipe_wire_edgesn.png "Extrusion of a wire"
  31
  32 \n Secondly, you can define the <b>Base
  33 Object</b> (edge, planar wire or face), which will be extruded,
  34 the <b>Path Object</b> (edge or wire) along which the <b>Base
  35 Object</b> will be extruded and the <b>BiNormal Vector</b> (edge or
  36 wire).
  37
  38 \n In contrast to the default mode, in this mode the pipe is generated
  39 to preserve the constant <b>angle between the normal vector</b> to the base
  40 shape <b>and the BiNormal vector</b> given as the third argument.
  41 \n <b>Select unpublished edges</b> checkbox - if checked, allows to select an edge of any other shape as the path object.
  42 \n The \b Result of the operation will be a GEOM_Object (edge, face, shell,
  43 solid or compsolid).
  44
  45 \n <b>TUI Command:</b> <em>geompy.MakePipeBiNormalAlongVector(baseShape, pathShape, binormalShape)</em>
  46 \n <b>Arguments:</b> Name + 1 shape (edge, planar wire or face)
  47 serving as base object + 1 shape (edge or wire) for
  48 definition of the path + 1 shape (edge or wire) to set a fixed
  49 BiNormal direction to perform the extrusion.
  50
  51 \image html pipe2.png
  52
  53 <b>Example:</b>
  54
  55 \image html pipebinormalsn.png "Extrusion of a face with BiNormal parameter"
  56
  57 \n Third, to create a shape by extrusion of the profile shapes along the path shape,
  58 you can define the <b>Base Object</b>s (edges, planar wires, faces or shells), which will be extruded,
  59 the <b>Locations</b> (vertices that specify locations on the <b>Path Object</b> corresponding to the
  60 specified <b>Base Object</b>s; list of the <b>Locations</b> should be either empty or of the same
  61 length as list of <b>Base Object</b>s) and the <b>Path Object</b> (edge or wire) along which the
  62 <b>Base Object</b> will be extruded.
  63
  64 Additional controls:
  65 - <b>With contact</b> checkbox - if checked, the section is translated to be in contact with the spine.
  66 - <b>With correction</b> checkbox - if checked, the section is rotated to be orthogonal to the spine
  67 tangent in the corresponding point.
  68
  69 \n The \b Result of the operation will be a GEOM_Object (shell or solid).
  70
  71 \n <b>TUI Command:</b> <em>geompy.MakePipeWithDifferentSections(baseShape, locations, pathShape, withContact, withCorrection)</em>
  72 \n <b>Arguments:</b> Name + list of shapes (edges, planar wires, faces or shells) serving as base object +
  73 list of locations (vertices) on the path corresponding specified list of the shapes +
  74 1 shape (edge or wire) for definition of the path +
  75 2 bool parameters (withContact, withCorrection).
  76 \n <b>Advanced options</b> \ref preview_anchor "Preview"
  77
  78 \image html pipe3.png
  79
  80 <b>Example:</b>
  81
  82 \image html pipe3_init.png "Initial objects"
  83
  84 \image html pipe3_init1.png "Extrusion of the profile shapes along the path shape"
  85
  86 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  87 \ref tui_creation_pipe "Complex Geometric Objects".
  88
  89 */