--- /dev/null
+
+/**
+ @file
+ \brief Help for the bathymetry
+*/
+
+/**
+ \page bathymetry Bathymetry
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ Bathymetry is an altitude object. It associates an altitude value to each point on the 2D plane.
+
+ <b>Import bathymetry</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Import bathymetry</b>;
+ <li> Context menu of <b>BATHYMETRIES</b> in Object browser => <b>Import bathymetry</b>;
+ <li> <b>CTRL + B</b> buttons combination;
+ <li> <b>Import bathymetry</b> toolar button.\image html import_bathymetry_toolbar_button.png "Import bathymetry toolbar button"
+ </ol>
+
+ Arguments of the input panel:
+
+ \image html import_bathymetry_input_panel.png "Import bathymetry input panel"
+
+<b>File name</b> - field to select file to import. Supported format: <b>.XYZ</b>(Bathymetry files);<br>
+<b>Name</b> - field to define bathymetry object name;<br>
+<b>Invert altitude object</b> - if this checkbox is ON, Z-coordinates of imported bathymetry become inverted. If checkbox is OFF, file is imported without modification.<br>
+<b>Apply</b> - button to create bathymetry object;<br>
+<b>Apply and Close</b> - button to create bathymetry object and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+<b>Example</b>:<br>
+
+\image html bathymetry_example.png "Bathymetry zone example"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the box obstacle
+*/
+
+/**
+ \page box_obstacle Box obstacle
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+
+ In the HYDROGUI module box obstacle is a geometrical primitive Box.
+
+
+ The obstacle can be created via:<ol>
+<li>The main menu <b> HYDRO => Obstacle => Create box</b>;</li>
+<li>Context menu of OBSTACLES in Object browser - <b>Create box</b>;</li>
+<li><b>Create box obstacle</b> toolbar button </li>
+ </ol>
+
+\image html box_toolbar_button.png "Create box obstacle toolbar button"
+
+ <b>Box construction</b> dialog box from Geometry module appears
+ \image html box_dialog.png "Box construction dialog box"
+
+User sets necesssary arguments and clicks <b>Apply and Close</b> button.
+
+<b>Box construction</b> dialog box is closed and a new geometrical object box appears in the Geometry module with defined by user name and dimensions.
+
+Help for this dialog is located in Salome Geometry User's guide => Creating geometrical objects => Creating primitives => Box.
+
+
+ <b>Import GEOM object as obstacle</b> input panel appears.
+
+
+ - \ref import_obstacle_GEOM "Import GEOM object as obstacle"
+
+ The box obstacle is presented as the face and 3D object.
+ \image html box_presentation.png "Box obstacle example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+/**
+ @file
+ \brief Help for the calculation case
+*/
+
+/**
+ \page calculation_case Calculation case
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the change layer order
+*/
+
+/**
+ \page change_layer_order Change layer order
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module allows the user to define priority of visibility 2d objects.<br>
+ This feature is executed with help of <b>Change layer order</b> dialog box, which can be called via according command in context menu, called in OCC viewer.<br>
+
+<b>Change layer order</b> dialog box looks like:
+
+ \image html change_layer_order_dialog_box.png "Change layer order dialog box"
+
+ Only shown objects are presented in the dialog box.<br>
+
+ Controls of the dialog box: <br>
+
+ <b>Move the item(s) on top</b> - button to move selected in the list objects on top, i.e. set for them the highest visibility priority;<br>
+ \image html move_item_on_top_button.png "Move the item(s) on top button"
+ <b>Move the item(s) up</b> - button to move selected in the list objects up, i.e. increase visibility priority on one point;<br>
+ \image html move_item_up_button.png "Move the item(s) up button"
+ <b>Move the item(s) down</b> - button to move selected in the list objects down, i.e. decrease visibility priority on one point;<br>
+ \image html move_item_down_button.png "Move the item(s) down button"
+ <b>Move the item(s) on bottom</b> - button to move selected in the list objects on bottom, i.e. set for them least visibility priority;<br>
+ \image html move_item_on_bottom_button.png "Move the item(s) on bottom button"
+ <b>All objects</b> - check-box to show all objects(even hidden) in the list;<br>
+ <b>Apply</b> - button to apply modifications done;<br>
+ <b>Apply and Close</b> - button to apply modifications done and close dialog box;<br>
+ <b>Close</b> - button to close dialog box.
+
+ Example:
+ \image html example_change_layer_order_before.png "Before changing layer order"
+
+ \image html example_change_layer_order_after.png "After changing layer order"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+
+*/
/**
\page art_channel Channel
+ <a href="index.html"><b>Back to Main page.</b></a>
+
The <b>channel</b> is an artificial object.
In the HYDROGUI module channel is created using the extrusion operation of profile along the provided path (guide line).
+ The channel 3d shape is shell.
+
+ Each profile vertex is extruded into channel edge.
+
+ Each profile edge is extruded into channel face.
+
+ All sections of channel should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane.
+
+ Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell.
+
+
The channel can be created via:<ol>
<li>The main menu <b> HYDRO => Create channel</b>;
<li><b>Create channel</b> toolbar button
</ol>
-\image html channel_icon.png
+\image html channel_toolbar_button.png "Channel construction toolbar button"
- Arguments of the input panel:
+ Channel input panel appears.
- \image html channel_empty.png " Channel input panel"
+ \image html channel_input_panel.png " Channel input panel"
+ Arguments of the input panel:
<b>Name</b> - field to define the channel name;<br>
<b>Guide line</b> - combo - box to select the polyline 3D defining the channel guide line;<br>
The channel is presented as the face and 3D object.
- \image html channel_presentation.png "channel presentation"
+ \image html channel_presentation.png "channel example"
+ <a href="index.html"><b>Back to Main page.</b></a>
+
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the color object
+*/
+
+/**
+ \page color Color object(s)
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module supports changing object's color. This operation is available for all objects except images, bathymetries and strickler tables.<br>
+
+ To change color of the object, it's necessary to select it and call <b>Color</b> command from context menu.<br>
+
+ <b>Set color</b> dialog box looks like:
+
+ \image html set_color_dialog_box.png "Set color dialog box"
+
+ Controls inside the dialog:
+
+ <b>Transparent</b> - radio button to make object transparent;<br>
+ <b>Color</b> - radio button to color the object with selected color;<br>
+ <b>Border</b> - check-box to define any color for object's border;<br>
+ <b>OK</b> - button to apply modifications;<br>
+ <b>Cancel</b> - button to reject color changing.<br>
+
+ To change color it's necessary to check <b>Color</b> radio button and double click on the colored field near it.<br>
+
+ To change border color it's necessary to check <b>Border</b> check box and double click on the colored field near it.<br>
+
+ Appearing <b>Select color</b> dialog box looks like:
+
+ \image html select_color.png "Select color dialog box"
+
+ Example:
+
+ \image html color_example.png "Color example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the copy/paste
+*/
+
+/**
+ \page copy_paste Copy/Paste object(s)
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to copy and paste objects in HYDROGUI module.
+
+ To <b>copy</b> any object it's necessary to select it and use one of the following ways:<ol>
+ <li>The main menu <b>Edit => Copy</b>;</li>
+ <li><b>CTRL + C</b> buttons combination; </li>
+ <li>Call context menu of object(s) and <b>Copy</b> command</li>
+ </ol>
+
+ When objects have been copied, they can be pasted into the study. To <b>paste</b> them use one of the following ways:<ol>
+ <li>The main menu <b>Edit => Paste</b>;</li>
+ <li><b>CTRL + V</b> buttons combination; </li>
+ </ol>
+
+ <b>Paste</b> operation creates new objects, identical to copied and adds them to according branch: <b>polyline</b> - in <b>POLYLINES</b> branch, <b>stream</b> - in <b>NATURAL OBJECTS</b> branch, etc.
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the copy_position
+*/
+
+/**
+ \page copy_position Copy position
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to copy local coordinates of any position in OCC view.<br>
+
+ For this it is necessary to put the mouse on interesting position in OCC view, call context menu and select <b>Copy position</b> command.<br>
+
+ Local coordinates become remembered and ready for pasting.
+
+*/
--- /dev/null
+
+/**
+ @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>
+
+*/
/**
@file
- \brief Help for the immersible zone
+ \brief Help for the cut images
*/
/**
\page cutimages Cut images
+
+ <a href="index.html"><b>Back to Main page.</b></a>
-The user can start <b>Cut images</b> operation via
following ways:<ol>
+The user can start <b>Cut images</b> operation via:<ol>
<li>The main menu <b>HYDRO - Cut images</b>;
<li>Context menu of any image in Object browser - <b>Cut images</b>;
-<li><b>Cut images</b> toolbar button
+<li><b>Cut images</b> toolbar button.\image html cut_images_toolbar_button.png "Cut images toolbar button"
</ol>
-Input panel looks like:
+ Arguments of the input panel:
\image html cut_images_input_panel.png "Cut images input panel(TO BE UPDATED)"
-<b>Name</b> - field for defining the name of image after cut.
-
+<b>Name</b> - field for defining the name of image after cut;<br>
+<b>Image 1</b> - field for defining the image which will be cut;<br>
+<b>Image 2</b> - field for defining the image which will cut;<br>
+<b>Apply</b> - button to create cut image object;<br>
+<b>Apply and Close</b> - button to create cut image object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
It's necessary to select 2 pictures to be cut with help of <b>Image 1</b> and <b>Image 2</b> fields.<br>
<br>Also, it's possible to change background color of cut image. For this <b>Color</b> radio button should be pushed and <b>Select color</b> dialog box should be called<br> by double clicking on the area near <b>Color</b> radio button.
\image html select_color.png "Select color dialog box"
-
+<a href="index.html"><b>Back to Main page.</b></a>
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the cylinder obstacle
+*/
+
+/**
+ \page cylinder_obstacle Cylinder obstacle
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ In the HYDROGUI module cylinder obstacle is a geometrical primitive cylinder.
+
+
+ The cylinder obstacle can be created via:<ol>
+<li>The main menu <b> HYDRO => Obstacle => Create cylinder</b>;</li>
+<li>Context menu of OBSTACLES in Object browser - <b>Create cylinder</b>;</li>
+<li><b>Create cylinder obstacle</b> toolbar button </li>
+ </ol>
+
+\image html cylinder_toolbar_button.png "Create cylinder obstacle toolbar button"
+
+ <b>Cylinder construction</b> dialog box from Geometry module appears
+ \image html cylinder_dialog.png "Cylinder construction dialog box"
+
+User sets necesssary arguments and clicks <b>Apply and Close</b> button.
+
+<b>Cylinder construction</b> dialog box is closed and a new geometrical object cylinder appears in the Geometry module with defined by user name and dimensions.
+
+Help for this dialog is located in Salome Geometry User's guide => Creating geometrical objects => Creating primitives => Cylinder.
+
+
+ <b>Import GEOM object as obstacle</b> input panel appears.
+
+
+ - \ref import_obstacle_GEOM "Import GEOM object as obstacle"
+
+ The cylinder obstacle is presented as the face and 3D object.
+ \image html cylinder_presentation.png "Cylinder obstacle example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the delete object(s)
+*/
+
+/**
+ \page delete Delete object(s)
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to delete one or more objects in HYDROGUI module.<br>
+ Following ways are available for beginning this action:<ol>
+ <li>Select object(s) and push <b>Delete</b> button;</li>
+ <li>Select object(s), call context menu and call <b>Delete</b> button;</li>
+ </ol>
+
+ Further 2 possible ways are possible:<ol>
+ <li>If deleting objects are not used as references for another objects, <b>Delete objects</b> dialog box appears: <br>
+
+ \image html delete_objects_dialog_box.png "Delete objects dialog box" </li>
+ <li>If removing objects are used as references for another objects, <b>Delete objects</b> warning appears: <br>
+
+ \image html delete_objects_warning.png "Delete objects warning"
+ In this case, firstly, it's necessary to remove objects which have been created basing on deleting objects. After that first case will be available.</li>
+ </ol>
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
*/
/**
- \page art_digue digue
+ \page art_digue Digue
+
+ <a href="index.html"><b>Back to Main page.</b></a>
The <b> digue</b> is an artificial object.
In the HYDROGUI module digue is created using the extrusion operation of profile along the provided path (guide line).
+
+ The digue 3d shape is shell.
+
+ Each profile vertex is extruded into digue edge.
+
+ Each profile edge is extruded into digue face.
+
+ All sections of digue should be perpendicular to the extrusion path (guide line), they are NOT parallel to the initial profile plane.
+
+ Note, that sharp corners in the extrusion path (guide line) can lead to selfinteresctions in the resulting shell.
The digue can be created via:<ol>
<li><b>Create digue</b> toolbar button
</ol>
-\image html digue_icon.png
+\image html digue_toolbar_button.png "Create digue toolbar button"
- Arguments of the input panel:
+ Digue input panel appears.
- \image html digue_empty.png " Digue input panel"
+ \image html digue_input_panel.png " Digue input panel"
+Arguments of the input panel:
<b>Name</b> - field to define the digue name;<br>
<b>Guide line</b> - combo - box to select the polyline 3D defining the digue guide line;<br>
<b>Close</b> - button to close input panel.
The digue is presented as the face and 3D object.
- \image html digue_presentation.png " Digue presentation"
+ \image html digue_presentation.png " Digue example"
+ <a href="index.html"><b>Back to Main page.</b></a>
+
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the dump study
+*/
+
+/**
+ \page dump_study Dump study
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module supports dumping documents into Python scripts. This operation can be called via:<ol>
+ <li> The main menu <b>File => Dump study</b>;</li>
+ <li> <b>CTRL + D</b> buttons combination;</li>
+ </ol>
+
+
+ <b>Dump study</b> dialog box looks like:
+
+ \image html dump_study_dialog_box.png "Dump study dialog box"
+
+ Controls inside <b>Dump study</b> dialog box:<ul>
+ <li><b>Publish in study</b> - check-box to </li>
+ <li><b>Multi file dump</b> - check-box to </li>
+ <li><b>Save GUI state</b> - check-box to </li>
+ </ul>
+
+ In case if the user tries to save file with the name already used, warning appears, suggested overwriting existing file :
+ \image html warning_dump.png "Warning"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the export polyline
+*/
+
+/**
+ \page export_polyline Export polyline
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to export polylines from HYDROGUI module. This operation can be called from context menu of selected polylines in Object browser.
+
+ <b>Export polyline</b> dialog box appears:
+ \image html export_polyline_dialog_box.png "Export polyline dialog box"
+
+ <b>Supported format</b> - <b>.SHP</b>(shape files).
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the export strickler table
+*/
+
+/**
+ \page export_strickler_table Export strickler table
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to export strickler table from HYDROGUI module. This operation is accessible from context menu of selected strickler table in Object browser.<br>
+
+ <b>Export Strickler table</b> looks like:
+ \image html export_strickler_table_input_panel.png "Export strickler table input panel"
+
+ Arguments of the input panel:
+
+<b>File name</b> - field to define file to export;<br>
+<b>Name</b> - field to show name of strickler table to export;<br>
+<b>Apply</b> - button to export strickler table object;<br>
+<b>Apply and Close</b> - button to export strickler table object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
+
+
+
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the find bottom
+*/
+
+/**
+ \page findbottom Find bottom
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ <b>Find bottom</b> operation builds polyline simulating the river bottom. The bottom polyline is constructed as the spline connecting the points with the minimal altitude from each profile inside the stream.
+
+ <b>Find stream bottom</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Stream => Find bottom</b>;
+ <li>Context menu of <b>Stream</b> object in Object browser - <b>Find bottom</b>;</li>
+ </ol>
+
+ Arguments of the input panel:
+
+ \image html find_bottom_input_panel.png "Find stream bottom input panel"
+
+<b>Stream object</b> - combo-box to define reference stream object;<br>
+<b>Apply</b> - button to build stream's bottom;<br>
+<b>Apply and Close</b> - button to build stream's bottom and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+<b>Example</b>:<br>
+
+\image html find_bottom_example.png "Find bottom example"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/
/**
@file
- \brief Help for the immersible zone
+ \brief Help for the fuse images
+*/
+
+/*
+div.inline-image,
+div.inline-image > div {
+ display:inline;
+}
*/
/**
\page fuseimages Fuse images
-The user can start <b>Fuse images</b> operation via following ways:<ol>
-<li>The main menu <b>HYDRO - Fuse images</b>;
-<li>Context menu of any image in Object browser - <b>Fuse images</b>;
-<li><b>Fuse images</b> toolbar button.
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+The user can start <b>Fuse images</b> operation via:<ol>
+<li>The main menu <b>HYDRO - Fuse images</b>; </li>
+<li>Context menu of any image in Object browser - <b>Fuse images</b>; </li>
+<li><b>Fuse images</b> toolbar button. \image html fuse_images_toolbar_button.png "Fuse images toolbar button"
</ol>
-Input panel looks like:
+
+
+
+
+ Arguments of the input panel:
\image html fuse_images_input_panel.png "Fuse images input panel"
-<b>Name</b> - field for defining the name of image after fusing.
+<b>Name</b> - field for defining the name of image after fusing;<br>
+<b>Image 1</b> - field for defining the first fusing image;<br>
+<b>Image 2</b> - field for defining the second fusing image;<br>
+<b>Apply</b> - button to create fused image object;<br>
+<b>Apply and Close</b> - button to create fused image object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
-It's necessary to select 2 pictures to be fused with help of <b>Image 1</b> and <b>Image 2</b> fields.<br>
<br>Also, it's possible to change background color of fused image. For this <b>Color</b> radio button should be pushed and <b>Select color</b> dialog box should be called<br> by double clicking on the area near <b>Color</b> radio button.
\image html select_color.png "Select color dialog box"
-
+<a href="index.html"><b>Back to Main page.</b></a>
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the general services
+*/
+
+/**
+ \page general_services General services
+
+ The HYRDOGUI module supports following services:
+ - \ref save "Save file"
+ - \ref open "Open file"
+ - \ref dump_study "Dump study"
+ - \ref load_script "Load script"
+ - \ref undo_redo "Undo/Redo actions"
+ - \ref copy_paste "Copy/Paste object(s)"
+ - \ref delete "Delete object(s)"
+ - \ref color "Color object"
+ - \ref show_hide "Show/Hide object(s)"
+ - \ref update "Update object"
+ - \ref rename "Rename object"
+ - \ref submersible "Submersible"
+ - \ref copy_position "Copy position"
+ - \ref change_layer_order "Change layer order"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the georeferencement profile
+*/
+
+/**
+ \page georeferencement_profile Georeferencement of profiles
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ Georeferencement of profiles in HYDROGUI module is accessible via:<ul>
+ <li>The main menu <b>HYDRO => Profile => Georeferencement</b>;</li>
+ <li>Context menu of PROFILES in Object browser - <b>Georeferencement</b>;</li>
+ <li>Context menu of selected profiles in Object browser - <b>Georeferencement</b>;</li>
+ <li><b>Profile(s)georeferencement</b> toolar button.</li>
+
+\image html georeferencement_toolbar_button.png "Profile(s) georeferencement toolbar button"
+ </ul>
+
+ <b>Georeferencement profile</b> input panel appears. The table widget shows either all profiles existing in document or selected profiles depending on the radio button activated:
+
+ \image html profiles_georeferencement_all.png "Profiles georeferencement input panel- All profiles"
+ \image html profiles_georeferencement_selected.png "Profiles georeferencement input panel- Selected profiles"
+
+If the user starts the operation via main menu, context menu of PROFILES or toolar button then the radio button All is activated automatically; if via context menu of selected profiles - Selected radio button.
+
+The user can input/change the coordinates of G, D profile points directly in the table using cell widgets or selecting a cell in the table and clicking in viewer.
+
+<b>Apply</b> - button to validate changes;<br>
+<b>Apply and Close</b> - button to validate changes and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+
+2D profiles that were georeferenced become 3D profiles and their names color is changed from red to black.
+
+\image html georeferencemented_profiles.png "Profiles in Object browser before and after georeferencement"
+
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+/**
+ @file
+ \brief Help for the image
+*/
+
+/**
+ \page image Image
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+Image is a picture area, the user is interested in. Images can be used to better visualize the study zone, the positioning of the geometries - polylines, bathymetries, etc.<br>
+ The HYDROGUI module supports the following operations with images:
+
+ - \ref impimage "Import image"
+ - \ref fuseimages "Fuse images"
+ - \ref cutimages "Cut images"
+ - \ref splitimage "Split image"
+
+
+*/
/**
\page imzone Immersible zone
- The <b>immersible zone</b> is a natural object.
- In the HYDROGUI module it is the face limited by one polyline.
- It simulates the zone under the water.
-
- The immersible zone can be created via the main menu HYDRO => Create immersible zone.
-
- In the dialog box:
-
- \image html immersible_zone_dlg.png "Immersible zone dialog box"
-
- the user should select the polyline limited the immersible zone and the bathymetry object associated with the immersible zone.
-
- The immersible zone can be defined on the polyline with one contour, in this case it will be a simple face limited by the contour:
-
- \image html simple_immersible_zone.png "A simple immersible zone"
-
- Also the immersible zone can be defined on the polyline with two contours (one inside another),
- in this case it will be a face limited by external contour with the hole limited by the internal contour.
-
- \image html immersible_zone_with_hole.png "An immersible zone with a hole"
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The <b>immersible zone</b> is a natural object describing the area that is (or may be) under the water.
+
+ <b>Create immersible zone</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Create immersible zone</b>;
+ <li> Context menu of <b>NATURAL OBJECTS</b> in Object browser => <b>Create immersible zone</b>;
+ <li> <b>Create immersible zone</b> toolar button.\image html create_immersible_zone_toolbar_button.png "Create immersible zone toolbar button"
+ </ol>
+
+ Arguments of the input panel:
+
+ \image html create_immersible_zone_input_panel.png "Create immersible zone input panel"
+
+<b>Name</b> - field to define the immersible zone name;<br>
+<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>
+<b>Bathymetry</b> - combo - box to select the bathymetry object describing immersible zone's profile;<br>
+<b>Apply</b> - button to generate immersible zone;<br>
+<b>Apply and Close</b> - button to generate immersible zone and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+<b>Example</b>:<br>
+
+\image html immersible_zone_example.png "Immersible zone example"
+
+<a href="index.html"><b>Back to Main page.</b></a>
*/
/**
@file
- \brief Help for the immersible zone
+ \brief Help for the import image
*/
/**
\page impimage Import image
- <b>Import image</b> input panel can be opened via following ways:<ol>
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ <b>Import image</b> input panel can be opened via:<ol>
<li> The main menu <b>HYDRO => Import image</b>;
<li> Context menu of <b>IMAGES</b> in Object browser => <b>Import image</b>;
<li> <b>CTRL + I</b> buttons combination;
- <li> <b>Import image</b> toolar button.
+ <li> <b>Import image</b> toolar button. \image html import_image_toolbar_button.png "Import image toolbar button"
</ol>
- Input panel looks like:
+ Arguments of the input panel:
\image html impot_image_dialog.png "Import image input panel"
- <b>File name</b> - field for defining file to import. Supported formats are .bmp, .jpg, .jpeg, .png, .tif.
-
- <b>Name</b> - field for defining the name of image after import. By default - the name of the file.
-
+<b>File name</b> - field for defining file to import. Supported formats are .bmp, .jpg, .jpeg, .png, .tif.<br>
+<b>Name</b> - field for defining the name of image after import. By default - the name of the file;<br>
+<b>Apply</b> - button to create image object;<br>
+<b>Apply and Close</b> - button to create image object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
Another fields become enabled:
\image html import_image_enabled.png "Enabled Import image input panel"
- Coordinates of 2 mandatory points have to be defined for positioning the image (points A and B). Additionally, it's possible to activate point C for more exact positioning.<br>
- Coordinates of points can be defined via following ways:<ol>
+ By default, two points should be used for the image positioning. The corresponding transformation should be built using the rules: only panning, rotation and scaling are allowed; the scaling is same along X, Y; all angles are kept.<br>
+ An additional check box allows the user to activate usage of the 3-rd point (unchecked by default). When user activates it he can select the 3-rd point exactly as previous two and in this case the complete affine transformation is applied (note that angles can be not kept and scaling along X, Y may be different in this case).<br>
+
+ Coordinates of points can be defined via:<ol>
<li> <b>Manually input Geographic coordinates</b>
<br>It's necessary to to input latitude and longitude of points.
\image html lambert_coordinates.png "Lambert coordinates"
<li> <b>Get Plane coordinates (Lambert93) from file</b>
- <br>It's necessary to load file with lambert coordinates.
+ <br>It's necessary to load file with lambert coordinates. Supported format - <b>.GRF</b> (image georeferencement file)
<li> <b>Choose points on reference image</b>
<br>It's necessary to choose reference image from combo box
\image html reference_image.png "Combo-box for defining reference image"
</ol>
+
+<a href="index.html"><b>Back to Main page.</b></a>
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for Import obstacle from file operation
+*/
+
+/**
+ \page import_obstacle Import obstacle from file
+
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ An obstacle can be imported into the HYDROGUI module from external file.
+
+
+ The <b>Import obstacle</b> operation can be started via:<ol>
+
+<li>The main menu <b> HYDRO => Obstacle => Import obstacle </b>;
+<li>Context menu of OBSTACLES in Object browser - <b>Import obstacle</b>;
+<li><b>Import obstacle from file</b> toolbar button
+ </ol>
+
+\image html import_obstacle_toolbar_button.png "Import obstacle from file toolbar button"
+
+
+ <b>Import obstacle</b> input panel appears.
+
+
+ \image html import_obstacle_create_input_panel.png " Import obstacle input panel - Create mode"
+
+ \image html import_obstacle_input_panel.png " Import obstacle input panel - Modify mode"
+
+Arguments of the input panel:
+
+<b>File name</b> - field for defining file to import.
+
+
+The user clicks <b>Open File</b> button.
+
+
+\image html open_file_icon.png "Open File button"
+
+
+<b>Open File</b> dialog box appears.
+
+
+\image html open_file_dialog.png "Open File dialog"
+
+
+The user selects type of file to be imported. Supported formats are BREP, IGES, STEP.
+
+
+The user selects folder in <b>Look in</b> filed and desired file in this folder.
+
+The user clicks <b>Open</b> button.
+
+<b>Open File</b> dialog box is closed. Selected file appears in <b>File name</b>.
+
+
+<b>Name</b> - field to define the obstacle name. By default name is the same as file name without extension;<br>
+<b>Mode</b> - allows to generate a new obstacle (radio-button <b>Create new</b>) or replace existing obstacle (radio-button <b>Modify</b>) ;<br>
+<b>Apply</b> - button to import obstacle;<br>
+<b>Apply and Close</b> - button to import obstacle and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+ The obstacle is presented as the face and 3D object.
+ \image html obstacle_presentation.png "Obstacle example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for Import GEOM object as obstacle operation
+*/
+
+/**
+ \page import_obstacle_GEOM Import GEOM object as obstacle
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ A geometrical object can be imported into the HYDROGUI module as an obstacle.
+
+
+ The <b>Import GEOM object as obstacle</b> operation can be started via Context menu of GEOM object in Object browser - <b>Import as obstacle</b>.
+
+ The user can select one/several objects in GEOM, in this case for each selected object the corresponding instance of HYDRO obstacle will be created.
+
+
+ <b>Import GEOM object as obstacle</b> input panel appears.
+
+The same input panel appears after creation of new geometrical primitives as results of <b>Create box</b> and <b>Create cylinder</b> operations.
+
+<b>Import GEOM object as obstacle</b> input panel appears.
+
+ \image html box_input_panel_create.png " Import GEOM object as obstacle input panel - Create mode"
+
+ \image html box_input_panel.png " Import GEOM object as obstacle input panel - Modify mode"
+
+Arguments of the input panel:
+
+<b>Name</b> - field to define the obstacle name. By default name is the same as name of corresponding GEOM object;<br>
+<b>Mode</b> - allows to generate a new obstacle (radio-button <b>Create new</b>) or replace existing obstacle (radio-button <b>Modify</b>) ;<br>
+<b>Apply</b> - button to generate obstacle;<br>
+<b>Apply and Close</b> - button to generate obstacle and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+ The obstacle is presented as the face and 3D object.
+ \image html box_presentation.png "Box obstacle example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the import polyline
+*/
+
+/**
+ \page import_polyline Import polyline
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to import polylines in HYDROGUI module. This operation is accessible via:<ul>
+ <li>The main menu <b>HYDRO => Import polyline</b>;</li>
+ <li><b>Import polyline</b> toolar button. \image html import_polyline_toolbar_button.png "Import polyline toolbar button"</li>
+ </ul>
+
+ <b>Import polyline</b> dialog box appears:
+ \image html import_polyline_dialog_box.png "Import polyline dialog box"
+
+<b>Supported formats</b> - <b>.SX</b>(sinusX files) and <b>.SHP</b>(shape files).
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the import profile
+*/
+
+/**
+ \page import_profile Import profile
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ Import profiles in HYDROGUI module from external file is accessible via:<ul>
+ <li>The main menu <b>HYDRO => Profile => Import profiles</b>;</li>
+ <li>Context menu of PROFILES in Object browser - <b>Import profiles</b>;</li>
+ <li><b>Import profiles from file(s)</b> toolar button.</li>
+
+\image html import_profile_toolbar_button.png "Import profiles from file(s) toolbar button"
+ </ul>
+
+ <b>Import profile</b> dialog box appears:
+ \image html import_profile_dialog_box.png "Import profile dialog box"
+
+
+The user selects folder in <b>Look in</b> filed and one or several desired file in this folder.
+
+The user clicks <b>Open</b> button.
+
+<b>Open File</b> dialog box is closed. Selected profile(s) appear(s) in Object browser. 2D profiles names are colored in red, 3D profile names with georteferncement are colored in black.
+
+\image html imported_profiles.png "Imported profiles in Object browser"
+
+The profile file format is text where each line corresponds to one point in the profile.
+
+Depending on number of values in line two use cases can be distinguished: <ul>
+
+<li> 2D case - each line contains 2 double values (parametric case). Note, that the X values should increase so if the current value is less than previous it can be interpreted as start of new profile.</li>
+<li> 3D case - each line contains 3 double values. First and last points are interpreted as points of georeferencement: first point is G (left bank), last point is D (right bank). The intermediate points should be recalculated to parametric presentation according to rule: the profile is straight segment on plan, and for each point U is equal to distance from the current point to the first point and Z is taken as is from the file.</li>
+ </ul>
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the import strickler table
+*/
+
+/**
+ \page import_strickler_table Import strickler table
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to import strickler table in HYDROGUI module. This operation is accessible via:<ul>
+ <li>The main menu <b>HYDRO => Import strickler table</b>;</li>
+ <li> Context menu of <b>STRICKLER TABLES</b> in Object browser => <b>Import strickler table</b>;</li>
+ <li><b>Import strickler table</b> toolar button. \image html import_strickler_table_toolbar_button.png "Import strickler table toolbar button"</li>
+ </ul>
+
+ <b>Import strickler table</b> input panel looks like:
+ \image html import_strickler_table_input_panel.png "Import strickler table input panel"
+ Arguments of the input panel:
+
+<b>File name</b> - field to define file to import;<br>
+<b>Name</b> - field to define the name of strickler table object after import. By default - the name of the file;<br>
+<b>Apply</b> - button to create strickler table object;<br>
+<b>Apply and Close</b> - button to create strickler table object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
+*/
--- /dev/null
+/**
+ @file
+ \brief Help for the land cover
+*/
+
+/**
+ \page land_cover Land cover
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the load script
+*/
+
+/**
+ \page load_script Load script
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module supports loading Python scripts. This operation can be called via:<ol>
+ <li> The main menu <b>File => Load script</b>;</li>
+ <li> <b>CTRL + T</b> buttons combination;</li>
+ </ol>
+
+
+ <b>Load python script</b> dialog box looks like:
+
+ \image html load_python_script_dialog_box.png "Load python script dialog box"
+
+ When script loading is done, according message appears in Python console. In case of problems during loading, error appears in Python console.
+
+ \image html python_console.png "Python console"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the local CS
+*/
+
+/**
+ \page local_cs Local CS
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module allows the user to change local coordinate system to avoid big numbers with Lambert 93 coordinates.<br>
+ For this <b>Local CS transformation</b> input panel should be called via:<ul>
+ <li> The main menu <b>HYDRO => Change local CS</b>;</li>
+ <li>Context menu of <b>HYDRO</b> in Object browser => <b> Change local CS</b>.</li>
+ </ul>
+<b>Local CS transformation</b> input panel looks like:
+
+ \image html local_cs_transformation_input_panel.png "Local CS transformation input panel"
+
+ Arguments of the input panel: <br>
+
+ <b>LX</b> - spin-box to define value of OX in local CS;<br>
+ <b>LY</b> - spin-box to define value of OY in local CS.<br>
+ <b>Apply</b> - button to transform local coordinate system;<br>
+ <b>Apply and Close</b> - button to transform local coordinate system and close input panel;<br>
+ <b>Close</b> - button to close input panel.
+
+<a href="index.html"><b>Back to Main page.</b></a>
+
+*/
The HYDROGUI module supports the following objects:
- \ref imzone "Immersible zone"
+ - \ref p_profile "Profile"
+ - \ref create_profile "Create profile"
+ - \ref import_profile "Import profile"
+ - \ref georeferencement_profile "Profile georeferencement"
- \ref art_digue "Digue"
- \ref art_channel "Channel"
+ - \ref obstacle "Obstacle"
+ - \ref box_obstacle "Create Box obstacle"
+ - \ref cylinder_obstacle "Create Cylinder obstacle"
+ - \ref import_obstacle_GEOM "Import obstacle from GEOMETRY"
+ - \ref import_obstacle "Import obstacle from file"
+ - \ref translate_obstacle "Translation of an obstacle"
+
+
+ - \ref polyline3d "Polyline 3D"
+ - \ref polyline "Polyline"
+ - \ref export_polyline "Export polyline"
+ - \ref import_polyline "Import polyline"
+ - \ref bathymetry "Bathymetry"
+ - \ref strickler_table "Strickler table"
+ - \ref export_strickler_table "Export strickler table"
+ - \ref import_strickler_table "Import strickler table"
+ - \ref stream "Stream"
+ - \ref impimage "Find bottom"
+ - \ref profilesinterpolation "Profiles interpolation"
+ - \ref image "Image"
+ - \ref impimage "Import image"
+ - \ref fuseimages "Fuse images"
+ - \ref cutimages "Cut images"
+ - \ref splitimage "Split image"
+ - \ref calculation_case "Calculation case"
+
+The HYDROGUI module supports the following \ref general_services "services":<br>
+
+
+ - \ref general_services "General services"
+ - \ref preferences "Preferences"
+ - \ref save "Save file"
+ - \ref open "Open file"
+ - \ref dump_study "Dump study"
+ - \ref load_script "Load script"
+ - \ref undo_redo "Undo/Redo actions"
+ - \ref copy_paste "Copy/Paste object(s)"
+ - \ref delete "Delete object(s)"
+ - \ref color "Color object"
+ - \ref show_hide "Show/Hide object(s)"
+ - \ref update "Update object"
+ - \ref rename "Rename object"
+ - \ref submersible "Submersible"
+ - \ref copy_position "Copy position"
+ - \ref change_layer_order "Change layer order"
+ - \ref local_cs "Local CS"
- The HYDROGUI module supports the following operations:
- - \ref impimage "Import image"
- - \ref fuseimages "Fuse images"
- - \ref cutimages "Cut images"
- - \ref splitimage "Split image"
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the obstacle
+*/
+
+/**
+ \page obstacle Obstacle
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ In the HYDROGUI module obstacle is 3D object created in or imported from Geometry module or from external file.
+
+
+ The HYDROGUI module supports the following techniques of obstacles creation:
+
+
+ - \ref box_obstacle "Create Box obstacle"
+ - \ref cylinder_obstacle "Create Cylinder obstacle"
+ - \ref import_obstacle_GEOM "Import obstacle from GEOMETRY"
+ - \ref import_obstacle "Import obstacle from file"
+ - \ref translate_obstacle "Translation of an obstacle"
+
+ The obstacle is presented as the 2D face and 3D object.
+ \image html box_presentation.png "Box obstacle example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the open file
+*/
+
+/**
+ \page open Open file
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module supports opening documents. This operation can be called via:<ol>
+ <li> The main menu <b>File => Open</b>;</li>
+ <li> <b>CTRL + O</b> buttons combination;</li>
+ <li> <b>Open document</b> toolar button. </li>
+ \image html open_document_toolbar_button.png "Open document toolbar button"
+ </ol>
+
+ In case if there is an active study in the session, <b>Close active study</b> warning appears:
+ \image html close_active_study_warning.png "Close active study warning"
+
+ <b>Save & Close</b> - button to save active study and open new file;<br>
+ <b>Close w/o saving</b> - button to ingore saving active study and open new file;<br>
+ <b>Cancel</b> - button to reject opening new file.br>
+
+ <b>Open file</b> dialog box looks like:
+ \image html open_file_dialog_box.png "Save file dialog box"
+
+ <b>Supported format: .HDF</b><br>
+
+ Additionally, <b>Reopen file</b> operation is supported. It can be called from the main menu <b>File => Reopen</b>. After that dialog box appears, clarifying the user's desire to reopen document:
+ \image html reopen_file_dialog_box.png "Reopen file dialog box"
+
+ <b>Yes</b> - button to reopen file and lost all not saved data;<br>
+ <b>No</b> - button to reject reopening.<br>
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the polyline
+*/
+
+/**
+ \page polyline Polyline
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The polyline creation is available only in the OCC viewer.
+
+ <b>Create polyline</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Create polyline</b>;
+ <li> Context menu of <b>POLYLINES</b> in Object browser => <b>Create polyline</b>;
+ <li> <b>Create polyline</b> toolar button.\image html create_polyline_toolbar_button.png "Create polyline toolbar button"
+ </ol>
+
+ Arguments of the input panel:
+
+ \image html create_polyline_input_panel.png "Create polyline input panel"
+
+ <b>Name</b> - field to define the polyline name;<br>
+ <b>Apply</b> - button to create polyline;<br>
+<b>Apply and Close</b> - button to create polyline and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
+ 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"
+
+ <b>Add element</b> panel is necessary to define parameters of section.
+
+ \image html add_element_panel.png "Add element panel"
+
+ <b>Name</b> - field to define the section name;<br>
+ <b>Type</b> - combo-box to define type of section: <b>Polyline</b> or <b>Spline</b>;<br>
+ <b>Closed</b> - if this checkbox is OFF, new section will be open. If checkbox is ON, new section will be closed;<br>
+ <b>Add</b> - button to add new section into the list.<br>
+
+ A polyline may include several sections not connected with each other.
+
+ 3 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 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.
+ 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.
+ <li><b>Modification mode</b></li><br>
+ 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"
+ <ul>
+ <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>
+ <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>
+ <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>
+ <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”.</li>
+ </ul>
+ \image html modif_mode_table.png "Table with coordinates"
+ <li><b>Detection mode</b></li><br>
+ TO BE UPDATED
+ </ol>
+
+ Another operations are available during creation/edition of polyline:<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>Remove</b></li><br>
+ Can be called by <b>Remove</b> button clicking.
+ \image html remove_button.png "Remove toolbar button"
+ Removes selected section(s) if no mode is activated.<br>
+ Removes selected points if modification mode is activated.<br>
+ <li><b>Join selected sections</b></li><br>
+ Can be called with help of:<ul>
+ <li><b>Join selected sections</b> toolbar button, if 2 or more selected sections are selected in the list</li>;<br>
+ \image html join_selected_sections_button.png "Join selected sections toolbar button"
+ <li><b>Join</b> command, called from context menu of 2 or more selected sections</li>;<br>
+ </ul>
+ Joines sections selected in the list inside <b>Sections</b> area, creating one section.
+ <li><b>Join all sections</b></li><br>
+ Can be called with help of <b>Join all sections</b> command from context menu inside <b>Sections</b> area.<br>
+ Joines all existing sections, having creating one section having type closed polyline.<br>
+ <li><b>Clear all</b></li><br>
+ Can be called only if modification mode is activated from context menu inside <b>Sections</b> area.<br>
+ <li><b>Set closed</b></li><br>
+ Can be called only if modification mode is activated from context menu of selected section(s).<br>
+ Modifies selected section into closed.
+ <li><b>Set open</b></li><br>
+ Can be called only if modification mode is activated from context menu of selected section(s).<br>
+ Modifies selected section into open.
+ <li><b>Set polyline</b></li><br>
+ Can be called only if modification mode is activated from context menu of selected section(s).<br>
+ Modifies selected section into polyline.
+ <li><b>Set spline</b></li><br>
+ Can be called only if modification mode is activated from context menu of selected section(s).<br>
+ Modifies selected section into spline.
+ </ul>
+
+ Additionally, the HYDROGUI module supports \ref export_polyline "export" and \ref import_polyline "import polyline".
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the polyline 3d
+*/
+
+/**
+ \page polyline3d Polyline 3D
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+The polyline 3D object is used as guide line for creation of channel or digue.<br>
+Creation of polyline 3D is available only in the OCC viewer.<br>
+ <b>Create polyline 3D</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Create polyline 3D</b>;
+ <li> Context menu of <b>POLYLINES 3D</b> in Object browser => <b>Create polyline 3D</b>;
+ <li> <b>Create polyline 3D</b> toolar button.\image html create_polyline_3d_toolbar_button.png "Create polyline 3D toolbar button"
+ </ol>
+
+ Arguments of the input panel:
+
+ \image html create_polyline_3d_input_panel.png "Create polyline 3D input panel"
+
+<b>Name</b> - field for defining the name of polyline 3D;<br>
+<b>Apply</b> - button to create polyline 3D;<br>
+<b>Apply and Close</b> - button to create polyline 3D and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
+
+Following parameters have to be defined to create polyline 3d object:<ul>
+<li><b>Polyline</b></li> - any polyline object can be selected in this field;
+<li><b>Profile</b> or <b>Bathymetry</b> - one of this fields should be filled by any profile or bathymetry accordingly.</li>
+</ul>
+
+<b>Example</b>:<br>
+
+\image html polyline_3d_example.png "Polyline 3D example"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/
+/**
+ @file
+ \brief Help for the HYDRO module Preferences
+*/
+
+/**
+ \page preferences Preferences
+
+ <a href="index.html"><b>Back to Main page</b></a>
+
+
+ Salome application supports Preferences. The Preferences dialog box can be called via:<ol>
+
+ <li> The main menu <b>File => Preferences</b>; </li>
+
+ <li> <b>CTRL + R</b> buttons combination.</li>
+
+ </ol>
+
+
+
+ <b>Preferences</b> dialog box appears. Help for all sections of <b>Preferences</b> dialog box except HYDRO can be found in Introduction to Salome platform.
+
+The user selects <b>HYDRO</b> in Available preferences section:
+
+
+
+ \image html preferences.png "Preferences dialog box"
+
+
+
+ Controls inside <b>Preferences</b> dialog box:
+
+
+<b>Type</b> - combo - box to select the cursor presentation for edition operation;<br>
+
+\image html preferences_type.png "Type combo-box in Preferences dialog box"
+
+
+<b>Make automatic fit all after show object operation</b> - check - box swith on/off Fit all;<br>
+<b>Default Strickler coefficient</b> field is used for Strickler coefficient asigned to area not covered by land cover or land cover with undefined type;<br>
+<b>OK</b> - button to validate changes and close dialog box;<br>
+<b>Apply</b> - button to validate changes;<br>
+<b>Defaults</b> - button to restore default values in all fields;<br>
+<b>Close</b> - button to close dialog box;<br>
+<b>Import</b> - button to import Preferences from external xml file.
+
+ The user clicks <b>Import</b> button. <b>Import preferences</b> dialog box appears:
+
+\image html preferences_import.png "Import preferences dialog box"
+
+
+
+The user selects folder in <b>Look in</b> filed and desired file in this folder.
+
+The user clicks <b>Open</b> button.
+
+<b>Import preferences</b> dialog box is closed. Prefernces are updated.
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for profile
+*/
+
+/**
+ \page p_profile Profile
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+The profile is used for definition of a stream cross-section or as a base of extrusion to generate a channel or digue.
+
+The 2D profiles are built/defined in a 2D space (U, Z). The coordinate U is parametric coordinate, it has no unit. The coordinate Z is real altitude (in meters).
+
+To build 2D profile Use function
+
+ - \ref create_profile "Create profile".
+
+
+
+2D profile object is internal data model object and can not be shown in OCC viewer. 2D profile names are colored in red in object browser.
+
+
+
+Created 2D profiles should be positioned in 3D space using Georeferencement to be converted into 3D profiles:
+
+- \ref georeferencement_profile "Profile georeferencement".
+
+
+3D profile is 3D wire describing profile curve in 3d space.
+3D profile names are colored in black in object browser.
+
+
+Both 2D and 3D profiles can be imported from external file:
+
+ - \ref import_profile "Import profile"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
+
+
+
+
+
+
+
--- /dev/null
+
+/**
+ @file
+ \brief Help for the find bottom
+*/
+
+/**
+ \page profilesinterpolation Profiles interpolation
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ <b>Profiles interpolation</b> operation builds additional profiles to get more detailed river bed.
+
+ <b>Profiles interpolation</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Stream => Profiles interpolation</b>;
+ <li>Context menu of <b>Stream</b> object in Object browser - <b>Profiles interpolation</b>;</li>
+ </ol>
+
+ <b>Profiles interpolation</b> input panel looks like:
+
+ \image html profiles_interpolation_input_panel.png "Profiles interpolation input panel"
+
+ Arguments of the input panel: <br>
+
+<b>Stream object</b> - combo-box to define reference stream object;<br>
+<b>Interpolator</b> - combo-box to define interpolation algorithm used. Currently only linear interpolation is accessible;<br>
+<b>Description</b> - field, describing interpolation method's features;<br>
+<b>Profile 1</b> - combo-box to define profile, which will be the <b>start</b> of interpolation;<br>
+<b>Profile 1</b> - combo-box to define profile, which will be the <b>end</b> of interpolation;<br>
+<b>Number of profiles</b> - spin-box to define the quantity of profiles which will be created;<br>
+<b>Parameters</b> - field to set additional interpolation parameters (name as string, value as string): <ul>
+<li>complete line of parameters should be input by user as a single text line and it should be parsed by spaces i.e. for example “len 5 hypothesis linear” will give additional parameters “len” = “5”; “hypothesis” = “linear”;</li>
+<li>the sense of such parameters depends on the interpolator implementation;</li>
+<li>parameters are passed to interpolator by several calls of “set” function (for each pair name, value);</li>
+</ul>
+<b>Apply</b> - button to build stream's bottom;<br>
+<b>Apply and Close</b> - button to build stream's bottom and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+The input panel built-in viewer shows profiles from selected reference stream object and profiles to be created during interpolation. The existing profiles are shown as black curves, the new profiles – as red curves:
+
+\image html profile_interpolation_preview.png "Profile interpolation preview"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the rename object
+*/
+
+/**
+ \page rename Rename object
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ It is possible to rename any object in HYDROGUI module.<br>
+
+ Following ways are available for starting this action:<ol>
+ <li>Select object and push <b>F2</b> button;</li>
+ <li>Select object, call context menu and call <b>Rename</b> button;</li>
+ <li>Double click on interesting object.</li>
+ </ol>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the save file
+*/
+
+/**
+ \page save Save file
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module supports saving documents in <b>.HDF</b> format. This operation can be called via:<ol>
+ <li> The main menu <b>File => Save</b>;</li>
+ <li> <b>CTRL + S</b> buttons combination;</li>
+ <li> <b>CTRL + SHIFT + S</b> buttons combination for <b>Save As...</b> operation;</li>
+ <li> <b>Save document</b> toolar button. </li>
+ \image html save_document_toolbar_button.png "Save document toolbar button"
+ </ol>
+
+ <b>Save file</b> dialog box looks like:
+ \image html save_file_dialog_box.png "Save file dialog box"
+
+
+ In case if the user tries to save document with name already used, warning appears, suggested overwriting existing file :
+ \image html save_file_warning.png "Warning"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the show/hide object
+*/
+
+/**
+ \page show_hide Show/hide object(s)
+
+ <a href="index.html"><b>Back to Main page</b></a>:<br>
+
+ \ref general_services "Back to general services"
+
+ It is possible to show and hide objects in the viewer in HYDROGUI module.<br>
+
+ The user can show object(s) via the following commands:<ol>
+ <li><b>Show all</b></li> - shows all objects. Can be executed from context menu called from viewer or Object browser;</li>
+ <li><b>Show</b></li> - shows selected objects. Can be executed from context menu of selected objects;</li>
+ <li><b>Show only</b></li> - shows selected objects and hides already shown objects. Can be executed from context menu of selected objects;</li>
+ <li><b>Eye</b> icon</li> - locates in Object browser near every object. Just click on it to show object, if it is hidden.
+
+ \image html eye_icons.png "Eye icons of shown and hidden objects"
+ </ol>
+
+ The user can hide object(s) via the following commands:<ol>
+ <li><b>Hide all</b></li> - hides all objects. Can be executed from context menu called from viewer or Object browser;</li>
+ <li><b>Hide</b></li> - hides selected objects. Can be executed from context menu of selected objects;</li>
+ <li><b>Eye</b> icon</li> - locates in Object browser near every object. Just click on it to hide object, if it is shown.
+ </ol>
+
+*/
/**
@file
- \brief Help for the immersible zone
+ \brief Help for the split image
*/
/**
\page splitimage Split image
-The user can start <b>Split image</b> operation via following ways:<ol>
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+The user can start <b>Split image</b> operation via:<ol>
<li>The main menu <b>HYDRO - Split image</b>;
<li>Context menu of any image in Object browser - <b>Split image</b>;
-<li><b>Split image</b> toolbar button
+<li><b>Split image</b> toolbar button \image html split_image_toolbar_button.png "Split image toolbar button"
</ol>
-Input panel looks like:
-
+ Arguments of the input panel:
\image html split_image_input_panel.png "Split image input panel"
<b>Name</b> - field for defining the name of image after cut;<br>
-<b>Modify selected image</b> - if this checkbox is OFF, new object will be created, as result. If checkbox is ON, initial image will be modified.
-
-<br>It's necessary to select:<ul>
- <li> Reference image to be split with help of <b>Image</b> fields;
- <li> Polyline to be the tool for split with help of <b>Polyline</b> field. Only <b>closed polylines</b> can be selected in this field.<br></ul>
+<b>Modify selected image</b> - if this checkbox is OFF, new object will be created, as result. If checkbox is ON, initial image will be modified.<br>
+<b>Image</b> - field for defining the reference image to be split;<br>
+<b>Polyline</b> - field for defining the the tool for split. Only <b>closed polylines</b> can be selected in this field; <br>
+<b>Apply</b> - button to create split image object;<br>
+<b>Apply and Close</b> - button to create split image object and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
Also, it's possible to change background color of split image. For this <b>Color</b> radio button should be pushed and <b>Select color</b> dialog box should be called<br> by double clicking on the area near <b>Color</b> radio button.
\image html select_color.png "Select color dialog box"
-
+<a href="index.html"><b>Back to Main page.</b></a>
*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the stream
+*/
+
+/**
+ \page stream Stream
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ <b>Stream</b> is a natural object simulating the river bed.
+
+ <b>Create stream</b> input panel can be opened via:<ol>
+ <li> The main menu <b>HYDRO => Stream => Create stream</b>;
+ <li> Context menu of <b>NATURAL OBJECTS</b> in Object browser => <b>Create stream</b>;
+ <li> <b>Create steam</b> toolar button.\image html create_stream_toolbar_button.png "Create stream toolbar button"
+ </ol>
+
+ Arguments of the input panel:
+
+ \image html create_stream_input_panel.png "Create stream input panel"
+
+<b>Name</b> - field to define the stream name;<br>
+<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>
+<b>Hydraulic axis</b> - combo - box to select the polyline, which is hydraulic axis of the river. Rules are following:<ul>
+<li>Polyline should be open;</li>
+<li>Polyline should consist from one section only;</li>
+<li>Polyline cannot be self-intersected or contain sharp angles, which can lead to self-intersections in resulting shell.</li>
+</ul>
+<b>Apply</b> - button to generate stream;<br>
+<b>Apply and Close</b> - button to generate stream and close input panel;<br>
+<b>Close</b> - button to close input panel.<br>
+
+Also it's necessary to add profiles into the list. For this select one/several profiles objects in the object browser and click the button <b>Add</b>. The rules are following:<ol>
+<li>Invalid (not positioned) profiles can not be added; they are simply ignored;</li>
+<li>Profile can not be added several times to the list; such profiles are simply ignored;</li>
+<li>Each added profile should intersect with the selected hydraulic axis; if for certain profile does not intersect, it is ignored.</li>
+</ol>
+It's possible to remove added profiles from the list. For this select profile(s) in the list and click <b>Remove</b> button.<br>
+
+Generated stream object contains 3D object, simulating the river bed, and its projection on XY plane, which is used for calculation.<br>
+
+Following operations are available with stream:
+ - \ref findbottom "Find bottom"
+ - \ref profilesinterpolation "Profiles interpolation"
+
+<b>Examples</b>:<br>
+
+\image html stream_3d_example.png "Stream 3D example"
+\image html stream_2d_example.png "Stream 2D example"
+
+<a href="index.html"><b>Back to Main page.</b></a>
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the strickler table
+*/
+
+/**
+ \page strickler_table Strickler table
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the submersible
+*/
+
+/**
+ \page submersible Submersible
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ Objects in HYDROGUI module have <b>Submersible</b> mark.<br>
+
+ Regions, created basing on <b>submersible objects are included</b> in final geometry during export calculation case. Regions, created basing on <b>not submersible objects are excluded</b> from final geometry.<br>
+
+ It is possible to define, is submersible the object or not, with help of its context menu and according command.
+
+\image html submersible.png "Submersible context menu command"
+
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for translate obstacle operation
+*/
+
+/**
+ \page translate_obstacle
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ An obstacle can be copied and translated in the HYDROGUI module.
+
+
+ The <b>Translation of an obstacle</b> operation can be started via Context menu of obstacle object in Object browser - <b>Translate</b>.
+
+
+
+ <b>Translation of an obstacle</b> input panel appears.
+
+ \image html translate_obstacle_input_panel.png " Translation of an obstacle input panel"
+
+Arguments of the input panel:
+
+<b>Name</b> - uneditable field containing the initial obstacle name;<br>
+<b>Dx, Dy, Dz</b> - components of translation vector;<br>
+<b>Apply</b> - button to generate obstacle;<br>
+<b>Apply and Close</b> - button to generate obstacle and close input panel;<br>
+<b>Close</b> - button to close input panel.
+
+
+ \image html translate_obstacle_example.png "Translation of an obstacle example"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the undo redo
+*/
+
+/**
+ \page undo_redo Undo/Redo actions
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+ The HYDROGUI module supports two levels of <b>Undo/Redo</b> functionality:<ul>
+ <li><b>Global</b> undo/redo<br>
+ Global undo reverts last operation, redo performs latest undone operation (if there is any);</li>
+ <li><b>Local</b> undo/redo - is available only for \ref create_profile "profiles" and \ref polyline "polylines" creation/edition</li>.
+ </ul>
+
+ <b>Global Undo</b> operation can be executed via:<ol>
+ <li> The main menu <b>Edit => Undo</b>;</li>
+ <li><b>Undo</b> toolbar button; </li>
+
+ \image html undo_toolbar_button.png "Undo toolbar button"
+
+ <li><b>CTRL + Z</b> buttons combination; </li>
+ <li>Selection of operations to be undone with help of <b>Undo</b> combo-box</li>
+
+ \image html undo_combo_box.png "Undo combo-box"
+ </ol>
+
+ <b>Global Redo</b> operation can be executed via:<ol>
+ <li> The main menu <b>Edit => Redo</b>;</li>
+ <li><b>Redo</b> toolbar button; </li>
+
+ \image html redo_toolbar_button.png "Redo toolbar button"
+
+ <li><b>CTRL + Y</b> buttons combination; </li>
+ <li>Selection of operations to be redone with help of <b>Redo</b> combo-box</li>
+ </ol>
+
+ \image html redo_combo_box.png "Redo combo-box"
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
--- /dev/null
+
+/**
+ @file
+ \brief Help for the update object
+*/
+
+/**
+ \page update Update object(s)
+
+Note that objects update is not automatic in The HYDRO GUI project.
+
+For example, in the case when one of profiles used in Stream is changed, the Stream is marked as not updated in object browser.
+
+\image html not_updated_stream.png "Not updated stream in object browser"
+
+
+The user starts the Update operation via context menu of <b>NATURAL OBJECTS/Stream_1 </b> in Object browser => <b>Update</b>.
+
+The Stream object is updated. If the <b>Stream_1_bottom</b> polyline exists, it is also updated together with parent stream.
+
+
+\image html updated_stream.png "Updated stream in object browser"
+
+
+ <a href="index.html"><b>Back to Main page.</b></a>
+
+*/
