Salome HOME
Redesign SALOME documentation
[modules/gui.git] / doc / salome / gui / input / gl_2d_viewer.rst
diff --git a/doc/salome/gui/input/gl_2d_viewer.rst b/doc/salome/gui/input/gl_2d_viewer.rst
new file mode 100755 (executable)
index 0000000..7fc3947
--- /dev/null
@@ -0,0 +1,93 @@
+.. _gl_2d_viewer_page:
+
+************
+GL 2D Viewer
+************
+
+Operations
+##########
+
+The functionalities of GL viewer are available via its Viewer
+Toolbar. Buttons marked with small downward triangles have extended
+functionality which can be accessed by locking on them with left mouse
+button.  
+
+.. image:: ../images/glviewer_toolbar.png
+       :align: center
+
+____
+                                                                                                 
+.. image:: ../../../../src/GLViewer/resources/gl_view_dump.png                                                                       
+       :align: center
+                                                                                                  
+**Dump View** - exports an object from the viewer in bmp, png or jpeg image format.               
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_fitall.png                                                                     
+       :align: center
+                                                                                                  
+**Fit all** - scales the presentation so that it could fit within the Viewer boundaries.          
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_fitarea.png                                                                    
+       :align: center
+                                                                                                  
+**Fit area** - resizes the view to place in the visible area only the contents of a frame drawn   
+with pressed left mouse button.                                                                   
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_fitselect.png                                                                  
+       :align: center
+                                                                                                  
+**Fit selection** - resizes the view to fit in the visible area only currently selected objects.  
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_zoom.png                                                                       
+       :align: center
+                                                                                                  
+**Zoom** - allows to zoom in and out.                                                             
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_pan.png                                                                        
+       :align: center
+                                                                                                  
+**Panning** - if the represented objects are greater that the                                     
+visible area and you don't wish to use **Fit all** functionality,                                 
+click on this button and you'll be able to drag the scene to see its                              
+remote parts.                                                                                     
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_glpan.png                                                                      
+       :align: center
+                                                                                                  
+**Global panning** - allows to select a point to be the center of                                 
+the presentation showing all displayed objects in the visible ares.                               
+                                                                                                  
+____
+                                                                                                  
+.. image:: ../../../../src/GLViewer/resources/gl_view_reset.png                                                                      
+       :align: center
+                                                                                                  
+**Reset** - restores the default position the scene.                                              
+                                                                                                  
+____
+
+
+.. _gl_background:
+
+Background
+##########
+
+GL Viewer background can be customized using the "Change background"
+popup menu command that opens standard "Select Color" dialog box:
+
+.. image:: ../images/selectcolor.png
+       :align: center
+
+