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   The <b>channel</b> is an artificial object.
  11
  12   In the HYDROGUI module channel is created  using the extrusion operation of profile along the provided path (guide line).
  13
  14   The channel can be created via:<ol>
  15
  16 <li>The main menu <b> HYDRO => Create  channel</b>;
  17 <li>Context menu of Artificial objects in Object browser - <b>Create  channel</b>;
  18 <li><b>Create  channel</b> toolbar button
  19  </ol>
  20
  21 \image html  channel_icon.png
  22
  23   Arguments of the input panel:
  24
  25   \image html  channel_empty.png " Channel input panel"
  26
  27
  28 <b>Name</b> - field to define the channel name;<br>
  29 <b>Guide line</b> - combo - box to select the polyline 3D defining the channel guide line;<br>
  30 <b>Profile</b> - combo - box to select the profile object describing channel cross-section.
  31 <b>Apply</b> - button to generate digue;<br>
  32 <b>Apply and Close</b> - button to generate digue and close input panel;<br>
  33 <b>Close</b> - button to close input panel.
  34
  35
  36    The channel is presented as the face and 3D object.
  37    \image html channel_presentation.png  "channel presentation"
  38
  39 */