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  <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   The <b> digue</b> is an artificial object.
  13
  14   In the HYDROGUI module digue is created using the extrusion operation of profile along the provided path (guide line).
  15
  16   The digue 3d shape is shell.
  17
  18   Each profile vertex is extruded into digue edge.
  19
  20   Each profile edge is extruded into digue face.
  21
  22   All sections of digue 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  digue can be created via:<ol>
  28
  29 <li>The main menu <b> HYDRO => Create  digue</b>;
  30 <li>Context menu of Artificial objects in Object browser - <b>Create  digue</b>;
  31 <li><b>Create  digue</b> toolbar button
  32  </ol>
  33
  34 \image html  digue_toolbar_button.png "Create  digue toolbar button"
  35
  36     Digue input panel appears.
  37
  38   \image html  digue_input_panel.png " Digue input panel"
  39
  40 Arguments of the input panel:
  41
  42 <b>Name</b> - field to define the digue name;<br>
  43 <b>Guide line</b> - combo - box to select the polyline 3D defining the digue guide line;<br>
  44 <b>Profile</b> - combo - box to select the profile object describing digue cross-section;<br>
  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    The  digue is presented as the face and 3D object.
  50    \image html  digue_presentation.png  " Digue example"
  51
  52  <a href="index.html"><b>Back to Main page.</b></a>
  53
  54 */