doc/salome/gui/HYDRO/polyline3d.h

   1
   2 /**
   3   @file
   4   \brief Help for the polyline 3d
   5 */
   6
   7 /**
   8   \page polyline3d Polyline 3D
   9
  10   <a href="index.html"><b>Back to Main page.</b></a>
  11
  12 The polyline 3D object is used as guide line for creation of channel or digue.<br>
  13 Creation of polyline 3D is available only in the OCC viewer.<br>
  14   <b>Create polyline 3D</b> input panel can be opened via:<ol>
  15   <li> The main menu <b>HYDRO => Create polyline 3D</b>;
  16   <li> Context menu of <b>POLYLINES 3D</b> in Object browser => <b>Create polyline 3D</b>;
  17   <li> <b>Create polyline 3D</b> toolar button.\image html create_polyline_3d_toolbar_button.png "Create polyline 3D toolbar button"
  18   </ol>
  19
  20   Arguments of the input panel:
  21
  22   \image html create_polyline_3d_input_panel.png "Create polyline 3D input panel"
  23
  24 <b>Name</b> - field for defining the name of polyline 3D;<br>
  25 <b>Apply</b> - button to create polyline 3D;<br>
  26 <b>Apply and Close</b> - button to create polyline 3D and close input panel;<br>
  27 <b>Close</b> - button to close input panel.<br>
  28
  29 Following parameters have to be defined to create polyline 3d object:<ul>
  30 <li><b>Polyline</b></li> - any polyline object can be selected in this field;
  31 <li><b>Profile</b> or <b>Bathymetry</b> - one of this fields should be filled by any profile or bathymetry accordingly.</li>
  32 </ul>
  33
  34 <b>Example</b>:<br>
  35
  36 \image html polyline_3d_example.png "Polyline 3D example"
  37
  38 <a href="index.html"><b>Back to Main page.</b></a>
  39 */