doc/salome/gui/HYDRO/immersible_zone.h

   1
   2 /**
   3   @file
   4   \brief Help for the immersible zone
   5 */
   6
   7 /**
   8   \page imzone Immersible zone
   9
  10   <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   The <b>immersible zone</b> is a natural object describing the area that is (or may be) under the water.
  13
  14   <b>Create immersible zone</b> input panel can be opened via:<ol>
  15   <li> The main menu <b>HYDRO => Create immersible zone</b>;
  16   <li> Context menu of <b>NATURAL OBJECTS</b> in Object browser => <b>Create immersible zone</b>;
  17   <li> <b>Create immersible zone</b> toolar button.\image html create_immersible_zone_toolbar_button.png "Create immersible zone toolbar button"
  18   </ol>
  19
  20   Arguments of the input panel:
  21
  22   \image html create_immersible_zone_input_panel.png "Create immersible zone input panel"
  23
  24 <b>Name</b> - field to define the immersible zone name;<br>
  25 <b>Polyline</b> - combo - box to select the polyline defining the immersible zone border. The combo box contains only closed polylines allowed for the immersible zones creation.<br>
  26 <b>Bathymetry</b> - combo - box to select the bathymetry object describing immersible zone's profile;<br>
  27 <b>Apply</b> - button to generate immersible zone;<br>
  28 <b>Apply and Close</b> - button to generate immersible zone and close input panel;<br>
  29 <b>Close</b> - button to close input panel.
  30
  31 <b>Example</b>:<br>
  32
  33 \image html immersible_zone_example.png "Immersible zone example"
  34
  35 <a href="index.html"><b>Back to Main page.</b></a>
  36 */