Salome HOME
refs #676: repairing of the documentation system and help
[modules/hydro.git] / doc / salome / gui / HYDRO / input / create_profile.doc
diff --git a/doc/salome/gui/HYDRO/input/create_profile.doc b/doc/salome/gui/HYDRO/input/create_profile.doc
new file mode 100644 (file)
index 0000000..77b54d4
--- /dev/null
@@ -0,0 +1,95 @@
+
+/**
+  @file
+  \brief Help for profile
+*/
+
+/**
+  \page create_profile  "Create/Edit profile"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+  
+   The profile can be created via:<ol>
+  <li> The main menu <b>HYDRO => Profile => Create profile</b>;
+  <li> Context menu of <b>PROFILES</b> in Object browser => <b>Create profile</b>;
+  <li> <b>Create profile</b> toolbar button.
+  </ol> 
+  
+\image html create_profile_toolbar_button.png "Create profile toolbar button"
+
+ The profile can be edited via Context menu of existing profile in Object browser => <b>Edit profile</b>.
+
+
+<b>Create/Edit profile</b> input panel appears.
+  
+
+  \image html create_profile_input_panel.png "Create profile input panel"
+
+  \image html profile_edit.png "Edit profile input panel"
+
+Arguments of the input panel:
+  
+  <b>Name</b> - field to define the profile name;<br>
+  <b>Apply</b> - button to create profile;<br>
+  <b>Apply and Close</b> - button to create profile and close input panel;<br>
+  <b>Close</b> - button to close input panel.<br>
+
+
+  The profile contains only one open section. Double click on section activates <b>Edit element</b> panel.
+   
+  \image html edit_element_panel.png "Edit element panel"
+  
+  <b>Name</b> - field to define the section name. This name is not saved into data model and is lost after closing input panel. Note, that figure in the end of name indicates number of points in section as shown in figure Edit profile input panel;<br>
+  <b>Type</b> - combo-box to define type of section: <b>Polyline</b> or <b>Spline</b>;<br>
+  <b>OK</b> - button to validate changes in section and close <b>Edit element</b> panel;<br>
+  <b>Cancel</b> - button to cancel changes in section and close <b>Edit element</b> panel.<br>
+
+  Section  curve is defined by a list of points through which it passes. 
+   
+  2 modes are available for work with points:<ol>
+
+  <li><b>Addition mode</b></li><br>
+  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"
+  Each time when user clicks left mouse button in the input panel built-in viewer a new point is created in a 2D space (U, Z). The point is added always between neighbor points according to coordinate U.
+
+ \image html profile_addition_points.png "Profile built-in viewer"
+  
+  <li><b>Modification mode</b></li><br>
+  In this mode the user can edit points of the profile curve. Can be activated by <b>Modification mode</b> button clicking.<br/>\image html modification_mode_button.png "Modification mode toolbar button"
+       <ul>
+       <li>When user selects a point (or several points) in viewer, its (their) coordinates are shown in the the table of input panel. 
+
+The user can change coordinates directly using table cell widgets;</li>
+       
+       \image html prof_modif_mode_table.png "Table with coordinates"
+
+  <li>When user clicks on existing segment, a new point should be added inside this segment with coordinates corresponding to mouse position; </li>
+       <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 U, Z;</li>
+       <li>The rectangular and additive (holding Ctrl button) selections should be available for points;</li>
+       <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”  or clicking  <b>Remove</b> button.</li>
+  \image html remove_button.png "Remove toolbar button"
+       </ul>
+  
+  </ol>
+  
+  Other operations are available during creation/edition of profile:<ul>
+  <li><b>Undo</b></li><br>
+  Undoes last action.
+  \image html undo_button.png "Undo toolbar button"
+  <li><b>Redo</b></li><br>
+  Redoes last undoing.
+  \image html redo_button.png "Redo toolbar button"
+  <li><b>Clear all</b></li><br>
+  Can be called only if modification mode is activated from section context menu.<br> 
+ Remove all points.
+  <li><b>Set polyline</b></li><br>
+  Can be called only if modification mode is activated from section context menu.<br>
+  Modifies selected section into polyline. 
+  <li><b>Set spline</b></li><br>
+  Can be called only if modification mode is activated from section context menu.<br>
+  Modifies selected section into spline.  
+  </ul>
+ <a href="index.html"><b>Back to Main page.</b></a> 
+*/