]> SALOME platform Git repositories - modules/hydro.git/commitdiff
Salome HOME
update of the documentation
authorasl <asl@opencascade.com>
Mon, 15 Jun 2015 14:24:10 +0000 (17:24 +0300)
committerasl <asl@opencascade.com>
Mon, 15 Jun 2015 14:24:10 +0000 (17:24 +0300)
24 files changed:
doc/salome/gui/HYDRO/channel.h [new file with mode: 0644]
doc/salome/gui/HYDRO/cut_images.h [new file with mode: 0644]
doc/salome/gui/HYDRO/digue.h [new file with mode: 0644]
doc/salome/gui/HYDRO/fuse_images.h [new file with mode: 0644]
doc/salome/gui/HYDRO/images/channel_empty.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/channel_icon.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/channel_presentation.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/cut_images_input_panel.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/digue_empty.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/digue_icon.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/digue_presentation.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/fuse_images_input_panel.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/fuse_images_toolbar_button.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/geographic_coordinates.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/import_image_enabled.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/import_image_toolbar_button.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/impot_image_dialog.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/lambert_coordinates.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/reference_image.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/select_color.png [new file with mode: 0644]
doc/salome/gui/HYDRO/images/split_image_input_panel.png [new file with mode: 0644]
doc/salome/gui/HYDRO/import_image.h [new file with mode: 0644]
doc/salome/gui/HYDRO/mainpage.h
doc/salome/gui/HYDRO/split_image.h [new file with mode: 0644]

diff --git a/doc/salome/gui/HYDRO/channel.h b/doc/salome/gui/HYDRO/channel.h
new file mode 100644 (file)
index 0000000..1ff6ac0
--- /dev/null
@@ -0,0 +1,39 @@
+
+/**
+  @file
+  \brief Help for the channel
+*/
+
+/**
+  \page art_channel Channel
+
+  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 can be created via:<ol>
+
+<li>The main menu <b> HYDRO => Create  channel</b>;
+<li>Context menu of Artificial objects in Object browser - <b>Create  channel</b>;
+<li><b>Create  channel</b> toolbar button 
+ </ol> 
+
+\image html  channel_icon.png 
+
+  Arguments of the input panel: 
+
+  \image html  channel_empty.png " Channel 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>
+<b>Profile</b> - combo - box to select the profile object describing channel cross-section.
+<b>Apply</b> - button to generate digue;<br>
+<b>Apply and Close</b> - button to generate digue and close input panel;<br>
+<b>Close</b> - button to close input panel.  
+
+
+   The channel is presented as the face and 3D object.
+   \image html channel_presentation.png  "channel presentation" 
+  
+*/
diff --git a/doc/salome/gui/HYDRO/cut_images.h b/doc/salome/gui/HYDRO/cut_images.h
new file mode 100644 (file)
index 0000000..3e33791
--- /dev/null
@@ -0,0 +1,28 @@
+
+/**
+  @file
+  \brief Help for the immersible zone
+*/
+
+/**
+  \page cutimages Cut images
+
+The user can start <b>Cut images</b> operation via following ways:<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 
+</ol>   
+Input panel looks like: 
+
+  \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.
+
+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"
+  
+
+
+*/
diff --git a/doc/salome/gui/HYDRO/digue.h b/doc/salome/gui/HYDRO/digue.h
new file mode 100644 (file)
index 0000000..94b8b65
--- /dev/null
@@ -0,0 +1,39 @@
+
+/**
+  @file
+  \brief Help for the digue
+*/
+
+/**
+  \page art_digue digue
+
+  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 can be created via:<ol>
+
+<li>The main menu <b> HYDRO => Create  digue</b>;
+<li>Context menu of Artificial objects in Object browser - <b>Create  digue</b>;
+<li><b>Create  digue</b> toolbar button 
+ </ol> 
+
+\image html  digue_icon.png 
+
+  Arguments of the input panel: 
+
+  \image html  digue_empty.png " Digue 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>Profile</b> - combo - box to select the profile object describing digue cross-section;<br>
+<b>Apply</b> - button to generate digue;<br>
+<b>Apply and Close</b> - button to generate digue and close input panel;<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" 
+  
+*/
diff --git a/doc/salome/gui/HYDRO/fuse_images.h b/doc/salome/gui/HYDRO/fuse_images.h
new file mode 100644 (file)
index 0000000..f1bcfe8
--- /dev/null
@@ -0,0 +1,28 @@
+
+/**
+  @file
+  \brief Help for the immersible zone
+*/
+
+/**
+  \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.
+</ol>   
+Input panel looks like: 
+
+  \image html fuse_images_input_panel.png "Fuse images input panel"
+  
+<b>Name</b> - field for defining the name of image after fusing.
+
+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"
+  
+
+
+*/
diff --git a/doc/salome/gui/HYDRO/images/channel_empty.png b/doc/salome/gui/HYDRO/images/channel_empty.png
new file mode 100644 (file)
index 0000000..eb13b47
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/channel_empty.png differ
diff --git a/doc/salome/gui/HYDRO/images/channel_icon.png b/doc/salome/gui/HYDRO/images/channel_icon.png
new file mode 100644 (file)
index 0000000..f037a8d
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/channel_icon.png differ
diff --git a/doc/salome/gui/HYDRO/images/channel_presentation.png b/doc/salome/gui/HYDRO/images/channel_presentation.png
new file mode 100644 (file)
index 0000000..5187ea5
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/channel_presentation.png differ
diff --git a/doc/salome/gui/HYDRO/images/cut_images_input_panel.png b/doc/salome/gui/HYDRO/images/cut_images_input_panel.png
new file mode 100644 (file)
index 0000000..1e57949
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/cut_images_input_panel.png differ
diff --git a/doc/salome/gui/HYDRO/images/digue_empty.png b/doc/salome/gui/HYDRO/images/digue_empty.png
new file mode 100644 (file)
index 0000000..1925885
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/digue_empty.png differ
diff --git a/doc/salome/gui/HYDRO/images/digue_icon.png b/doc/salome/gui/HYDRO/images/digue_icon.png
new file mode 100644 (file)
index 0000000..df268af
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/digue_icon.png differ
diff --git a/doc/salome/gui/HYDRO/images/digue_presentation.png b/doc/salome/gui/HYDRO/images/digue_presentation.png
new file mode 100644 (file)
index 0000000..e3c974f
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/digue_presentation.png differ
diff --git a/doc/salome/gui/HYDRO/images/fuse_images_input_panel.png b/doc/salome/gui/HYDRO/images/fuse_images_input_panel.png
new file mode 100644 (file)
index 0000000..c5e014b
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/fuse_images_input_panel.png differ
diff --git a/doc/salome/gui/HYDRO/images/fuse_images_toolbar_button.png b/doc/salome/gui/HYDRO/images/fuse_images_toolbar_button.png
new file mode 100644 (file)
index 0000000..b152bfe
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/fuse_images_toolbar_button.png differ
diff --git a/doc/salome/gui/HYDRO/images/geographic_coordinates.png b/doc/salome/gui/HYDRO/images/geographic_coordinates.png
new file mode 100644 (file)
index 0000000..cda9bcb
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/geographic_coordinates.png differ
diff --git a/doc/salome/gui/HYDRO/images/import_image_enabled.png b/doc/salome/gui/HYDRO/images/import_image_enabled.png
new file mode 100644 (file)
index 0000000..ec8d9fb
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/import_image_enabled.png differ
diff --git a/doc/salome/gui/HYDRO/images/import_image_toolbar_button.png b/doc/salome/gui/HYDRO/images/import_image_toolbar_button.png
new file mode 100644 (file)
index 0000000..aa3d5d4
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/import_image_toolbar_button.png differ
diff --git a/doc/salome/gui/HYDRO/images/impot_image_dialog.png b/doc/salome/gui/HYDRO/images/impot_image_dialog.png
new file mode 100644 (file)
index 0000000..5ef827e
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/impot_image_dialog.png differ
diff --git a/doc/salome/gui/HYDRO/images/lambert_coordinates.png b/doc/salome/gui/HYDRO/images/lambert_coordinates.png
new file mode 100644 (file)
index 0000000..2968ede
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/lambert_coordinates.png differ
diff --git a/doc/salome/gui/HYDRO/images/reference_image.png b/doc/salome/gui/HYDRO/images/reference_image.png
new file mode 100644 (file)
index 0000000..ce72152
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/reference_image.png differ
diff --git a/doc/salome/gui/HYDRO/images/select_color.png b/doc/salome/gui/HYDRO/images/select_color.png
new file mode 100644 (file)
index 0000000..045dcd5
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/select_color.png differ
diff --git a/doc/salome/gui/HYDRO/images/split_image_input_panel.png b/doc/salome/gui/HYDRO/images/split_image_input_panel.png
new file mode 100644 (file)
index 0000000..a89c887
Binary files /dev/null and b/doc/salome/gui/HYDRO/images/split_image_input_panel.png differ
diff --git a/doc/salome/gui/HYDRO/import_image.h b/doc/salome/gui/HYDRO/import_image.h
new file mode 100644 (file)
index 0000000..8492708
--- /dev/null
@@ -0,0 +1,47 @@
+
+/**
+  @file
+  \brief Help for the immersible zone
+*/
+
+/**
+  \page impimage Import image
+
+  <b>Import image</b> input panel can be opened via following ways:<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.
+  </ol> 
+   
+  Input panel looks like: 
+
+  \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.
+  
+  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>
+  
+  <li> <b>Manually input Geographic coordinates</b>
+       <br>It's necessary to to input latitude and longitude of points.
+       \image html geographic_coordinates.png "Geographic coordinates"
+  
+  <li> <b>Manually input Plane coordinates(Lambert93)</b>
+       <br>It's necessary to input lambert coordinates 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.
+  
+  <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> 
+*/
index 9e6ec0e387371c70133d2ba39cc9db91959b152c..b1cf80f9b68976816b7b9b92227b11ae1ba558d9 100644 (file)
 
   The HYDROGUI module supports the following objects:
   - \ref imzone "Immersible zone"
+  - \ref art_digue "Digue"
+  - \ref art_channel "Channel"
+
+  The HYDROGUI module supports the following operations:
+  - \ref impimage "Import image"
+  - \ref fuseimages "Fuse images"
+  - \ref cutimages "Cut images"
+  - \ref splitimage "Split image"
+
 */
diff --git a/doc/salome/gui/HYDRO/split_image.h b/doc/salome/gui/HYDRO/split_image.h
new file mode 100644 (file)
index 0000000..22a25c5
--- /dev/null
@@ -0,0 +1,32 @@
+
+/**
+  @file
+  \brief Help for the immersible zone
+*/
+
+/**
+  \page splitimage Split image
+
+The user can start <b>Split image</b> operation via following ways:<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 
+ </ol> 
+Input panel looks like: 
+
+  \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>
+
+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"
+  
+
+
+*/