doc/salome/gui/HYDRO/polyline.h

   1
   2 /**
   3   @file
   4   \brief Help for the polyline
   5 */
   6
   7 /**
   8   \page polyline Polyline
   9
  10    <a href="index.html"><b>Back to Main page.</b></a>
  11
  12   The polyline creation is available only in the OCC viewer.
  13
  14   <b>Create polyline</b> input panel can be opened via:<ol>
  15   <li> The main menu <b>HYDRO => Create polyline</b>;
  16   <li> Context menu of <b>POLYLINES</b> in Object browser => <b>Create polyline</b>;
  17   <li> <b>Create polyline</b> toolar button.\image html create_polyline_toolbar_button.png "Create polyline toolbar button"
  18   </ol>
  19
  20   Arguments of the input panel:
  21
  22   \image html create_polyline_input_panel.png "Create polyline input panel"
  23
  24   <b>Name</b> - field to define the polyline name;<br>
  25     <b>Apply</b> - button to create polyline;<br>
  26 <b>Apply and Close</b> - button to create polyline and close input panel;<br>
  27 <b>Close</b> - button to close input panel.<br>
  28   The polyline creation starts by creation of one or several sections. For adding new section it's necessary to click <b>Insert new section</b> button. \image html insert_new_section_button.png "Insert new section toolbar button"
  29
  30   <b>Add element</b> panel is necessary to define parameters of section.
  31
  32   \image html add_element_panel.png "Add element panel"
  33
  34   <b>Name</b> - field to define the section name;<br>
  35   <b>Type</b> - combo-box to define type of section: <b>Polyline</b> or <b>Spline</b>;<br>
  36   <b>Closed</b> - if this checkbox is OFF, new section will be open. If checkbox is ON, new section will be closed;<br>
  37   <b>Add</b> - button to add new section into the list.<br>
  38
  39   A polyline may include several sections not connected with each other.
  40
  41   3 modes are available for work with points:<ol>
  42   <li><b>Addition mode</b></li><br>
  43   In this mode only point’s creation is available. Can be activated by <b>Addition mode</b> button clicking.<br/> \image html addition_mode_button.png "Addition mode toolbar button"
  44   Each time when user clicks left mouse button in the viewer a new point is created (the plane X,Y, i.e. Z = 0 should be used for coordinates obtaining). The point is added always to the end of points list.
  45   Note that addition of points is performed always to the current (selected) section of the polyline. User should select in the dialog box another section to start points addition to it.
  46   <li><b>Modification mode</b></li><br>
  47   In this mode the user can edit the built sections and points of the polyline. Can be activated by <b>Modification mode</b> button clicking.<br/>\image html modification_mode_button.png "Modification mode toolbar button"
  48         <ul>
  49         <li>When user selects a point (or several points) in viewer, its coordinates are shown in the input panel in the table, so the user can change it directly using table cell widgets;</li>
  50         <li>When user clicks on existing segment, a new point should be added inside this segment with coordinates corresponding to mouse position; the new point is inserted between segment tail points;</li>
  51         <li>When user selects one or several points in viewer, he can activate the “drag-n-drop” mode (holding the mouse left button) to move all selected points inside the plane X, Y;</li>
  52         <li>The rectangular and additive (holding Ctrl button) selections should be available for points;</li>
  53         <li>User can remove points selecting one or several points and pressing “Delete” on keyboard or calling the popup menu and clicking on operation “Delete”.</li>
  54         </ul>
  55         \image html modif_mode_table.png "Table with coordinates"
  56   <li><b>Detection mode</b></li><br>
  57   TO BE UPDATED
  58   </ol>
  59
  60   Another operations are available during creation/edition of polyline:<ul>
  61   <li><b>Undo</b></li><br>
  62   Undoes last action.
  63   \image html undo_button.png "Undo toolbar button"
  64   <li><b>Redo</b></li><br>
  65   Redoes last undoing.
  66   \image html redo_button.png "Redo toolbar button"
  67   <li><b>Remove</b></li><br>
  68   Can be called by <b>Remove</b> button clicking.
  69   \image html remove_button.png "Remove toolbar button"
  70   Removes selected section(s) if no mode is activated.<br>
  71   Removes selected points if modification mode is activated.<br>
  72   <li><b>Join selected sections</b></li><br>
  73   Can be called with help of:<ul>
  74   <li><b>Join selected sections</b> toolbar button, if 2 or more selected sections are selected in the list</li>;<br>
  75   \image html join_selected_sections_button.png "Join selected sections toolbar button"
  76   <li><b>Join</b> command, called from context menu of 2 or more selected sections</li>;<br>
  77   </ul>
  78   Joines sections selected in the list inside <b>Sections</b> area, creating one section.
  79   <li><b>Join all sections</b></li><br>
  80   Can be called with help of <b>Join all sections</b> command  from context menu inside <b>Sections</b> area.<br>
  81   Joines all existing sections, having creating one section having type closed polyline.<br>
  82   <li><b>Clear all</b></li><br>
  83   Can be called only if modification mode is activated from context menu inside <b>Sections</b> area.<br>
  84   <li><b>Set closed</b></li><br>
  85   Can be called only if modification mode is activated from context menu of selected section(s).<br>
  86   Modifies selected section into closed.
  87   <li><b>Set open</b></li><br>
  88   Can be called only if modification mode is activated from context menu of selected section(s).<br>
  89   Modifies selected section into open.
  90   <li><b>Set polyline</b></li><br>
  91   Can be called only if modification mode is activated from context menu of selected section(s).<br>
  92   Modifies selected section into polyline.
  93   <li><b>Set spline</b></li><br>
  94   Can be called only if modification mode is activated from context menu of selected section(s).<br>
  95   Modifies selected section into spline.
  96   </ul>
  97
  98  Additionally, the HYDROGUI module supports \ref export_polyline "export" and \ref import_polyline "import polyline".
  99
 100  <a href="index.html"><b>Back to Main page.</b></a>
 101 */