doc/salome/gui/HYDRO/channel.h

   1
   2 /**
   3   @file
   4   \brief Help for the channel
   5 */
   6
   7 /**
   8   \page art_channel Channel
   9
  10  <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   The <b>channel</b> is an artificial object.
  13
  14   In the HYDROGUI module channel is created  using the extrusion operation of profile along the provided path (guide line).
  15
  16   The channel 3d shape is shell.
  17
  18   Each profile vertex is extruded into channel edge.
  19
  20   Each profile edge is extruded into channel face.
  21
  22   All sections of channel should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane.
  23
  24   Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell.
  25
  26
  27   The channel can be created via:<ol>
  28
  29 <li>The main menu <b> HYDRO => Create  channel</b>;
  30 <li>Context menu of Artificial objects in Object browser - <b>Create  channel</b>;
  31 <li><b>Create  channel</b> toolbar button
  32  </ol>
  33
  34 \image html  channel_toolbar_button.png "Channel construction toolbar button"
  35
  36   Channel input panel appears.
  37
  38   \image html  channel_input_panel.png " Channel input panel"
  39
  40  Arguments of the input panel:
  41
  42 <b>Name</b> - field to define the channel name;<br>
  43 <b>Guide line</b> - combo - box to select the polyline 3D defining the channel guide line;<br>
  44 <b>Profile</b> - combo - box to select the profile object describing channel cross-section.
  45 <b>Apply</b> - button to generate digue;<br>
  46 <b>Apply and Close</b> - button to generate digue and close input panel;<br>
  47 <b>Close</b> - button to close input panel.
  48
  49
  50    The channel is presented as the face and 3D object.
  51    \image html channel_presentation.png  "channel example"
  52
  53  <a href="index.html"><b>Back to Main page.</b></a>
  54
  55 */