doc/salome/gui/HYDRO/digue.h

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