From: asl Date: Mon, 15 Jun 2015 14:24:10 +0000 (+0300) Subject: update of the documentation X-Git-Tag: v1.4.1~1 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=2949d412fd824c9637b2336a0ee8b3f569805824;p=modules%2Fhydro.git update of the documentation --- diff --git a/doc/salome/gui/HYDRO/channel.h b/doc/salome/gui/HYDRO/channel.h new file mode 100644 index 00000000..1ff6ac0f --- /dev/null +++ b/doc/salome/gui/HYDRO/channel.h @@ -0,0 +1,39 @@ + +/** + @file + \brief Help for the channel +*/ + +/** + \page art_channel Channel + + The channel 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:
    + +
  1. The main menu HYDRO => Create channel; +
  2. Context menu of Artificial objects in Object browser - Create channel; +
  3. Create channel toolbar button +
+ +\image html channel_icon.png + + Arguments of the input panel: + + \image html channel_empty.png " Channel input panel" + + +Name - field to define the channel name;
+Guide line - combo - box to select the polyline 3D defining the channel guide line;
+Profile - combo - box to select the profile object describing channel cross-section. +Apply - button to generate digue;
+Apply and Close - button to generate digue and close input panel;
+Close - 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 index 00000000..3e33791e --- /dev/null +++ b/doc/salome/gui/HYDRO/cut_images.h @@ -0,0 +1,28 @@ + +/** + @file + \brief Help for the immersible zone +*/ + +/** + \page cutimages Cut images + +The user can start Cut images operation via following ways:
    +
  1. The main menu HYDRO - Cut images; +
  2. Context menu of any image in Object browser - Cut images; +
  3. Cut images toolbar button +
+Input panel looks like: + + \image html cut_images_input_panel.png "Cut images input panel(TO BE UPDATED)" + +Name - field for defining the name of image after cut. + +It's necessary to select 2 pictures to be cut with help of Image 1 and Image 2 fields.
+
Also, it's possible to change background color of cut image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color 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 index 00000000..94b8b655 --- /dev/null +++ b/doc/salome/gui/HYDRO/digue.h @@ -0,0 +1,39 @@ + +/** + @file + \brief Help for the digue +*/ + +/** + \page art_digue digue + + The digue 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:
    + +
  1. The main menu HYDRO => Create digue; +
  2. Context menu of Artificial objects in Object browser - Create digue; +
  3. Create digue toolbar button +
+ +\image html digue_icon.png + + Arguments of the input panel: + + \image html digue_empty.png " Digue input panel" + + +Name - field to define the digue name;
+Guide line - combo - box to select the polyline 3D defining the digue guide line;
+Profile - combo - box to select the profile object describing digue cross-section;
+Apply - button to generate digue;
+Apply and Close - button to generate digue and close input panel;
+Close - 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 index 00000000..f1bcfe8c --- /dev/null +++ b/doc/salome/gui/HYDRO/fuse_images.h @@ -0,0 +1,28 @@ + +/** + @file + \brief Help for the immersible zone +*/ + +/** + \page fuseimages Fuse images + +The user can start Fuse images operation via following ways:
    +
  1. The main menu HYDRO - Fuse images; +
  2. Context menu of any image in Object browser - Fuse images; +
  3. Fuse images toolbar button. +
+Input panel looks like: + + \image html fuse_images_input_panel.png "Fuse images input panel" + +Name - field for defining the name of image after fusing. + +It's necessary to select 2 pictures to be fused with help of Image 1 and Image 2 fields.
+
Also, it's possible to change background color of fused image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color 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 index 00000000..eb13b47b 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 index 00000000..f037a8d0 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 index 00000000..5187ea51 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 index 00000000..1e57949f 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 index 00000000..19258852 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 index 00000000..df268af3 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 index 00000000..e3c974f3 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 index 00000000..c5e014b0 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 index 00000000..b152bfe9 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 index 00000000..cda9bcbe 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 index 00000000..ec8d9fbd 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 index 00000000..aa3d5d48 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 index 00000000..5ef827e9 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 index 00000000..2968edee 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 index 00000000..ce72152d 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 index 00000000..045dcd51 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 index 00000000..a89c887d 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 index 00000000..84927088 --- /dev/null +++ b/doc/salome/gui/HYDRO/import_image.h @@ -0,0 +1,47 @@ + +/** + @file + \brief Help for the immersible zone +*/ + +/** + \page impimage Import image + + Import image input panel can be opened via following ways:
    +
  1. The main menu HYDRO => Import image; +
  2. Context menu of IMAGES in Object browser => Import image; +
  3. CTRL + I buttons combination; +
  4. Import image toolar button. +
+ + Input panel looks like: + + \image html impot_image_dialog.png "Import image input panel" + + File name - field for defining file to import. Supported formats are .bmp, .jpg, .jpeg, .png, .tif. + + Name - 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.
+ Coordinates of points can be defined via following ways:
    + +
  1. Manually input Geographic coordinates +
    It's necessary to to input latitude and longitude of points. + \image html geographic_coordinates.png "Geographic coordinates" + +
  2. Manually input Plane coordinates(Lambert93) +
    It's necessary to input lambert coordinates of points. + \image html lambert_coordinates.png "Lambert coordinates" + +
  3. Get Plane coordinates (Lambert93) from file +
    It's necessary to load file with lambert coordinates. + +
  4. Choose points on reference image +
    It's necessary to choose reference image from combo box + \image html reference_image.png "Combo-box for defining reference image" +
+*/ diff --git a/doc/salome/gui/HYDRO/mainpage.h b/doc/salome/gui/HYDRO/mainpage.h index 9e6ec0e3..b1cf80f9 100644 --- a/doc/salome/gui/HYDRO/mainpage.h +++ b/doc/salome/gui/HYDRO/mainpage.h @@ -31,4 +31,13 @@ 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 index 00000000..22a25c5b --- /dev/null +++ b/doc/salome/gui/HYDRO/split_image.h @@ -0,0 +1,32 @@ + +/** + @file + \brief Help for the immersible zone +*/ + +/** + \page splitimage Split image + +The user can start Split image operation via following ways:
    +
  1. The main menu HYDRO - Split image; +
  2. Context menu of any image in Object browser - Split image; +
  3. Split image toolbar button +
+Input panel looks like: + + \image html split_image_input_panel.png "Split image input panel" + +Name - field for defining the name of image after cut;
+Modify selected image - if this checkbox is OFF, new object will be created, as result. If checkbox is ON, initial image will be modified. + +
It's necessary to select: + +Also, it's possible to change background color of split image. For this Color radio button should be pushed and Select color dialog box should be called
by double clicking on the area near Color radio button. + + \image html select_color.png "Select color dialog box" + + + +*/