From 9a27677da627e9712fca028159e04153c4a3a0dd Mon Sep 17 00:00:00 2001 From: rnv Date: Tue, 23 Jan 2018 12:14:25 +0300 Subject: [PATCH] Update GUI documentation: final cleanup and some corrections. --- doc/salome/gui/CMakeLists.txt | 2 +- doc/salome/gui/doxyfile.in | 82 ---- doc/salome/gui/input/common_functionality.doc | 141 ------ doc/salome/gui/input/gl_2d_viewer.doc | 71 --- .../gui/input/howtos_and_best_practives.doc | 463 ------------------ doc/salome/gui/input/index.doc | 82 ---- doc/salome/gui/input/introduction_to_gui.doc | 68 --- doc/salome/gui/input/occ_3d_viewer.doc | 379 -------------- doc/salome/gui/input/plot2d_viewer.doc | 245 --------- doc/salome/gui/input/python_viewer.doc | 97 ---- doc/salome/gui/input/qxscene_2d_viewer.doc | 54 -- doc/salome/gui/input/salome_architecture.doc | 110 ----- doc/salome/gui/input/salome_desktop.doc | 89 ---- .../gui/input/select_color_and_font.doc | 32 -- doc/salome/gui/input/setting_preferences.doc | 425 ---------------- .../gui/input/study_management_chapter.doc | 143 ------ doc/salome/gui/input/text_user_interface.doc | 78 --- doc/salome/gui/input/themes.doc | 42 -- .../gui/input/using_catalog_generator.doc | 65 --- doc/salome/gui/input/using_find_tool.doc | 76 --- doc/salome/gui/input/using_input_widgets.doc | 64 --- doc/salome/gui/input/using_notebook.doc | 40 -- doc/salome/gui/input/using_object_browser.doc | 52 -- doc/salome/gui/input/using_pluginsmanager.doc | 208 -------- doc/salome/gui/input/using_registry_tool.doc | 49 -- doc/salome/gui/input/viewers_chapter.doc | 38 -- doc/salome/gui/input/vtk_3d_viewer.doc | 279 ----------- .../gui/input/working_with_python_scripts.doc | 28 -- doc/salome/gui/static/footer.html | 14 - doc/salome/gui/static/header.html.in | 23 - doc/salome/gui/static/salome_extra.css | 29 -- doc/salome/gui/static/switchers.js | 2 +- src/LightApp/CMakeLists.txt | 2 + src/LightApp/LightApp_Application.cxx | 104 +++- src/LightApp/LightApp_Application.h | 1 + src/LightApp/resources/LightApp.xml | 1 - src/LightApp/resources/LightApp_images.ts | 8 + src/LightApp/resources/LightApp_msg_en.ts | 12 + src/LightApp/resources/icon_earth.png | Bin 0 -> 1670 bytes src/LightApp/resources/icon_life_ring.png | Bin 0 -> 1549 bytes src/STD/CMakeLists.txt | 1 + src/STD/STD_Application.cxx | 3 +- src/STD/resources/STD_images.ts | 4 + src/STD/resources/about.png | Bin 0 -> 459 bytes 44 files changed, 130 insertions(+), 3576 deletions(-) delete mode 100755 doc/salome/gui/doxyfile.in delete mode 100644 doc/salome/gui/input/common_functionality.doc delete mode 100644 doc/salome/gui/input/gl_2d_viewer.doc delete mode 100644 doc/salome/gui/input/howtos_and_best_practives.doc delete mode 100644 doc/salome/gui/input/index.doc delete mode 100644 doc/salome/gui/input/introduction_to_gui.doc delete mode 100644 doc/salome/gui/input/occ_3d_viewer.doc delete mode 100644 doc/salome/gui/input/plot2d_viewer.doc delete mode 100644 doc/salome/gui/input/python_viewer.doc delete mode 100644 doc/salome/gui/input/qxscene_2d_viewer.doc delete mode 100644 doc/salome/gui/input/salome_architecture.doc delete mode 100644 doc/salome/gui/input/salome_desktop.doc delete mode 100644 doc/salome/gui/input/select_color_and_font.doc delete mode 100644 doc/salome/gui/input/setting_preferences.doc delete mode 100644 doc/salome/gui/input/study_management_chapter.doc delete mode 100644 doc/salome/gui/input/text_user_interface.doc delete mode 100755 doc/salome/gui/input/themes.doc delete mode 100644 doc/salome/gui/input/using_catalog_generator.doc delete mode 100644 doc/salome/gui/input/using_find_tool.doc delete mode 100755 doc/salome/gui/input/using_input_widgets.doc delete mode 100644 doc/salome/gui/input/using_notebook.doc delete mode 100644 doc/salome/gui/input/using_object_browser.doc delete mode 100644 doc/salome/gui/input/using_pluginsmanager.doc delete mode 100644 doc/salome/gui/input/using_registry_tool.doc delete mode 100644 doc/salome/gui/input/viewers_chapter.doc delete mode 100644 doc/salome/gui/input/vtk_3d_viewer.doc delete mode 100644 doc/salome/gui/input/working_with_python_scripts.doc delete mode 100755 doc/salome/gui/static/footer.html delete mode 100755 doc/salome/gui/static/header.html.in delete mode 100644 doc/salome/gui/static/salome_extra.css create mode 100755 src/LightApp/resources/icon_earth.png create mode 100755 src/LightApp/resources/icon_life_ring.png create mode 100755 src/STD/resources/about.png diff --git a/doc/salome/gui/CMakeLists.txt b/doc/salome/gui/CMakeLists.txt index 3c2ef5c05..c382524d6 100755 --- a/doc/salome/gui/CMakeLists.txt +++ b/doc/salome/gui/CMakeLists.txt @@ -78,7 +78,7 @@ ADD_CUSTOM_TARGET(check_translations ADD_DEPENDENCIES(check_translations usr_docs) FOREACH(pofile ${POFILES}) - GET_FILENAME_COMPONENT(fn_wo_path ${pofile} NAME) + GET_FILENAME_COMPONENT(fn_wo_path ${pofile} NAME) ADD_CUSTOM_COMMAND(TARGET check_translations POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different ${pofile} ${CMAKE_CURRENT_SOURCE_DIR}/locale/fr/LC_MESSAGES/${fn_wo_path}) diff --git a/doc/salome/gui/doxyfile.in b/doc/salome/gui/doxyfile.in deleted file mode 100755 index 5926c1bb4..000000000 --- a/doc/salome/gui/doxyfile.in +++ /dev/null @@ -1,82 +0,0 @@ -# Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE -# -# Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, -# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS -# -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation; either -# version 2.1 of the License, or (at your option) any later version. -# -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -# -# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com -# - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -PROJECT_NAME = "SALOME GUI User's Guide" -OUTPUT_DIRECTORY = GUI -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -TAB_SIZE = 5 - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES - -#--------------------------------------------------------------------------- -#Input related options -#--------------------------------------------------------------------------- -INPUT = @CMAKE_CURRENT_SOURCE_DIR@/input -FILE_PATTERNS = *.doc -IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images \ - @PROJECT_SOURCE_DIR@/src/OCCViewer/resources \ - @PROJECT_SOURCE_DIR@/src/VTKViewer/resources \ - @PROJECT_SOURCE_DIR@/src/SVTK/resources \ - @PROJECT_SOURCE_DIR@/src/Plot2d/resources \ - @PROJECT_SOURCE_DIR@/src/GLViewer/resources \ - @PROJECT_SOURCE_DIR@/src/QxScene/resources \ - -#--------------------------------------------------------------------------- -#HTML related options -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = . -HTML_HEADER = @CMAKE_CURRENT_BINARY_DIR@/static/header.html -HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html -HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css -TOC_EXPAND = YES -DISABLE_INDEX = NO -GENERATE_TREEVIEW = YES -TREEVIEW_WIDTH = 300 - -#--------------------------------------------------------------------------- -#SORT related options -#--------------------------------------------------------------------------- -SORT_GROUP_NAMES = NO - -#--------------------------------------------------------------------------- -#LaTeX related option -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO - -#--------------------------------------------------------------------------- -#RTF related options -#--------------------------------------------------------------------------- -GENERATE_RTF = NO - -#--------------------------------------------------------------------------- -#Search engine -#--------------------------------------------------------------------------- -SEARCHENGINE = NO diff --git a/doc/salome/gui/input/common_functionality.doc b/doc/salome/gui/input/common_functionality.doc deleted file mode 100644 index 1963d6ec3..000000000 --- a/doc/salome/gui/input/common_functionality.doc +++ /dev/null @@ -1,141 +0,0 @@ -/*! - -\page common_functionality_page Functionality common for OCC and VTK viewers - -\anchor viewer_background -

Background

- -Viewers background can be customized using the "Change background" -popup menu command that opens the following dialog box: - -\image html change_background_dlg.png - -The following types of the background are supported: - -- Single color: the background is colored with the solid color - specified by the user in the dialog box. - -- Gradient background: the background is gradiently colored according - to two colors and the gradient type specified in the dialog box. The - following types of background are supported: - - - Horizontal - - - Vertical - - - First diagonal - - - Second diagonal - - - First corner - - - Second corner - - - Third corner - - - Fourth corner - -- \b Image: allows to set image as viewer background and define filling type: - - - \b Center: the image is located at the center of the viewer backgound - - - \b Tile: the image fills the entire viewer backgound one by one - - - \b Stretch: the image is stretched to the entire viewer backgound. - -Default background for the OCC viewer is specified via the -\ref occ_preferences "OCC 3D Viewer Preferences" and for the -VTK viewer via the \ref vtk_preferences "VTK 3D Viewer Preferences". - -
- -

Selection

- -An element can be selected by clicking on it with the left mouse button. -Selecting objects with locked \em Shift key produces a multi selection. - -Additionally, when the viewer owns an input focus, an object can be selected -by pressing \em "S" on the keyboard. Pressing \em "S" when holding -\em Shift key allows adding/removing an object to/from the current selection. - -OCC viewer provides a way to navigate between the selectable objects. -This feature (disabled by default) is used in some dialog boxes (for example, -in Geometry module). When there are several objects which suit current -selection requirements (specified by the dialog) under the current mouse cursor, -it is possible to switch between them by means of mouse scroll wheel. -The same can be also done by pressing \em "N" and \em "P" keys. - -There are also two additional selection mechanisms: rectangle and -polyline selection. - -

Rectangle selection

- -Rectangle Selection is the basic and commonly used selection tool. - -To select a rectangle area press and hold the left mouse button while drawing the diagonal of the selection rectangle in the viewer. - -\image html rectselectionvtk.png - -As a result, the objects within the rectangle are selected. - -\image html rectselectionvtk2.png - -\note It is possible to add an area to the existing selection by holding down -\em Shift key while selecting. - -

Polyline selection

- -OCC and VTK Viewers feature a special Polyline Selection mechanism, -which allows selecting an arbitrary part of the graphic area using a -polygon frame (rubber band), instead of the usual selection with a -rectangular frame. - -To produce a Polyline Selection, press and hold the right mouse button and draw -the first side of the selection polygon, then change the direction by clicking -the left mouse button add draw another side, etc. Click twice by left mouse -button to finish drawing. - -\image html polyselectionvtk11.png - -As a result, the objects within the polygon are selected. - -\image html polyselectionvtk21.png - -To add an area to the existing selection it is necessary to hold down -\em Shift key while selecting. - -
- -\anchor viewer_navigation_modes -

Navigation modes

- -OCC and VTK 3D viewers support two different navigation modes: - -- Salome standard controls - - Rectangle selection in this mode is performed by the left mouse button - and polyline selection by the right mouse button; - multiple selection is available when \em Shift button is pressed. - - Also, holding \em Ctrl key with pressed mouse buttons performs the following view transformations: - - \em Ctrl + left mouse button - zooming; - - \em Ctrl + middle mouse button - panning; - - \em Ctrl + right mouse button - rotation. - -- Keyboard free style - - This mode allows performing all view transformations without using the - keyboard (only by the mouse): - - Left mouse button performs view rotation; - - Middle mouse button performs panning; - - Right mouse button makes zooming. - - In this style rectangle selection is done by the left mouse button with \em Ctrl key pressed; - polyline selection is done by the right mouse button with \em Ctrl key pressed. - -In both styles selection of objects in the viewer can be performed by pressing -\em "S" key or by the left mouse button click. - -Zooming can be alternatively done by scrolling mouse wheel. - -*/ diff --git a/doc/salome/gui/input/gl_2d_viewer.doc b/doc/salome/gui/input/gl_2d_viewer.doc deleted file mode 100644 index 3f0c35f57..000000000 --- a/doc/salome/gui/input/gl_2d_viewer.doc +++ /dev/null @@ -1,71 +0,0 @@ -/*! - -\page 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 html glviewer_toolbar.png -
- -\image html gl_view_dump.png - -Dump View - exports an object from the viewer in bmp, png or -jpeg image format. -
- -\image html gl_view_fitall.png - -Fit all - scales the presentation so that it could fit within -the Viewer boundaries. -
- -\image html gl_view_fitarea.png - -Fit area - resizes the view to place in the visible area only -the contents of a frame drawn with pressed left mouse button. -
- -\image html gl_view_fitselect.png - -Fit selection - resizes the view to fit in the visible area -only currently selected objects. -
- -\image html gl_view_zoom.png - -Zoom - allows to zoom in and out. -
- -\image html gl_view_pan.png - -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 html gl_view_glpan.png - -Global panning - allows to select a point to be the center of -the presentation showing all displayed objects in the visible ares. -
- -\image html gl_view_reset.png - -Reset - restores the default position the scene. -
- -\anchor gl_background -

Background

- -GL Viewer background can be customized using the "Change background" -popup menu command that opens standard "Select Color" dialog box: - -\image html selectcolor.png - -*/ diff --git a/doc/salome/gui/input/howtos_and_best_practives.doc b/doc/salome/gui/input/howtos_and_best_practives.doc deleted file mode 100644 index e064bf281..000000000 --- a/doc/salome/gui/input/howtos_and_best_practives.doc +++ /dev/null @@ -1,463 +0,0 @@ -/*! - -\page howtos How-To's and Best Practices - -These documents provide guidelines and best practices explaining different aspects -and usage examples of SALOME platform. - -- \subpage use_case_builder -- \subpage drag_and_drop -- \subpage using_pluginsmanager - -\page use_case_builder Customize data tree representation in the Object browser by means of use case builder - -\tableofcontents - -In SALOME, the representation of the data tree in the Object browser for the \a full -(CORBA-based) module is done basing on the study contents as it is supplied by SALOME -data server (SALOMEDS). In contrast to the \a light module which data tree is completely -defined and can be easily attuned by the module specific implementation, \a full module -must publish its data in the CORBA study by means of the corresponding API of SALOME -data server, namely \c SALOMEDS::StudyBuilder. As soon as data entities are published -in the study, they are shown in the Object browser, in the same order as they appear -in the study tree. Re-arrangement of the data entities with such approach is not a -trivial task: for example, when copying/moving any data entity at the new position -within the tree, it is necessary to copy all its attributes as well -and to clear (in case of move operation) the data entity at the original position. Also, it is not possible to -make some data items in the tree "invisible" for the user (though it might be useful). - -Use case builder provides an alternative and more flexible way for customizing the -data tree representation. It implements another approach to the data tree hierarchy, -based on the tree node attributes. With use case builder it is possible to arrange -and easily re-arrange the data items in the data tree in any appropriate way. - -For example, with use case builder it is easy to implement such operations as -\ref drag_and_drop "Drag and Drop" and Copy/Cut/Paste. With use case builder approach -it is not important how data entities are arranged in the study tree, they even may -lie on the same level - use case builder allows providing custom data tree -representation, completely indepedent on the study data tree itself. It is even possible -to hide some data entities in the tree representation while still keeping them in the -study (to store specific module data). - -Object browser automatically checks it the module root data object -contains a tree node attribute and switches to the browsing of the -data tree for such module using the use case -builder. Otherwise, it browses data using an ordinary study tree iterator. Thus, it is -possible to have in the same study some modules based on use case builder approach and -others not using it. - -\section use_case_builder_usage Use case builder usage - -To obtain a reference to the use case builder, the function \c GetUseCaseBuilder() of the -\c SALOMEDS::Study interface can be used: - -\code -interface Study -{ - // Get reference to the use case builder - UseCaseBuilder GetUseCaseBuilder(); -}; -\endcode - -\c SALOMEDS::UseCaseBuilder interface of the \c SALOMEDS CORBA module provides several -methods that can be used to build a custom data tree. Its API is -similar to the API of -\c SALOMEDS::StudyBuilder interface - it operates with terms \a "father object" and -\a "child object". In addition, use case builder uses term \a "current object" that is -used as a parent of the children objects added if the parent is not explicitly -specified. - -\code -interface UseCaseBuilder -{ - // Set top-level root object of the use case tree as the current one. - // This method is usually used to add SComponent items to the top level of the tree - boolean SetRootCurrent(); - - // Set the object theObject as the current object of the use case builder - boolean SetCurrentObject(in SObject theObject); - - // Append object SObject to the end of children list of the current object - boolean Append(in SObject theObject); - - // Append object SObject to the end of children list of the parent object theFather - boolean AppendTo(in SObject theFather, in SObject theObject); - - // Insert object theFirst before the object theNext (under the same parent object) - boolean InsertBefore(in SObject theFirst, in SObject theNext); - - // Remove object from the use case tree (without removing it from the study) - boolean Remove(in SObject theObject); - - // Check if the object theObject has children (in the use case tree) - boolean HasChildren(in SObject theObject); - - // Get father object of the given object theObject in the use cases tree - SObject GetFather(in SObject theObject); - - // Check if given object theObject is added to the use case tree - boolean IsUseCaseNode(in SObject theObject); - - // Get the current object of the use case builder - SObject GetCurrentObject(); -}; -\endcode - -\section browse_use_case_tree Browsing use case data tree - -Browsing the use case tree can be done by means of the use case iterator, that is -provided by the \c SALOMEDS::UseCaseIterator interface of the \c SALOMEDS CORBA -module. Access to the use case iterator can be done via \c SALOMEDS::UseCaseBuilder -interface: - -\code -interface UseCaseBuilder -{ - // Get a reference to the use case iterator and initialize it - // by the given object theObject - UseCaseIterator GetUseCaseIterator(in SObject theObject); -}; -\endcode - -The API of the \c SALOMEDS::UseCaseIterator interface is similar to the -\c SALOMEDS::ChildIterator: - -\code -interface UseCaseIterator -{ - // Activate or reset use case iterator; boolean parameter allLevels - // specifies if the iterator should browse recursively on all sub-levels or - // on the first sub-level only. - void Init(in boolean allLevels); - // Check if the iterator can browse to the next item - boolean More(); - // Browse the iterator to the next object - void Next(); - // Get the object currently pointed by the iterator - SObject Value(); -}; -\endcode - -Typical usage of the \c UseCaseIterator is as follows: - -\code -// get use case builder -SALOMEDS::UseCaseBuilder_var useCaseBuilder = study->GetUseCaseBuilder(); - -// get the use case iterator -SALOMEDS::UseCaseIterator_var iter = useCaseIter->GetUseCaseIterator( sobject.in() ); -// iterate through the sub-items recursively -for ( useCaseIter->Init( true ); useCaseIter->More(); useCaseIter->Next() ) { - SALOMEDS::SObject_var child = useCaseIter->Value(); - // do something with the child - // ... - // clean-up - child->UnRegister(); -} -// clean-up -useCaseIter->UnRegister(); -useCaseBuilder->UnRegister(); -\endcode - -\section use_case_compatibility Remark about compatibility with existing studies - -If you decide to switch your module to the use case builder approach to provide -customization for the data tree representation, you must take care of compatibility -with existing SALOME studies. Basically it means that you have to add -a simple code to \c Load() (and \c LoadASCII() if necessary) method -of your module, which adds tree node attributes to all data entities -in the data tree of your module. The simplest way to do -this is to iterate through all data items and recursively add them to -the use case builder: - -\code -// find component -SALOMEDS::SComponent_var comp = study->FindComponent( "MYMODULE" ); -// add tree node attributes only if component data is present in the study -if ( !CORBA::is_nil( comp ) ) { - // get the use case builder - SALOMEDS::UseCaseBuilder_var useCaseBuilder = study->GetUseCaseBuilder(); - // check if tree nodes are already set - if ( !useCaseBuilder->IsUseCaseNode( comp.in() ) ) { - // set the current node of the use case builder to the root - useCaseBuilder->SetRootCurrent(); - // add component item to the top level of the use case tree - useCaseBuilder->Append( comp.in() ); - // iterate through all child items recursively - SALOMEDS::ChildIterator_var iter = study->NewChildIterator( comp.in() ); - for ( iter->InitEx( true ); iter->More(); iter->Next() ) { - SALOMEDS::SObject_var sobj = iter->Value(); - SALOMEDS::SObject_var father = sobj->GetFather(); - // add an object to the corresponding level in the use case tree - useCaseBuilder->AppendTo( father.in(), sobj.in() ); - // clean up (avoid memory leaks) - sobj->UnRegister(); - father->UnRegister(); - } - } - useCaseBuilder->UnRegister(); // clean up -} -\endcode - -\page drag_and_drop Implementing Drag and Drop functionality in SALOME module - -\tableofcontents - -Drag and Drop provides a simple visual mechanism to transfer -information between and within applications. - -In some aspects Drag and drop operates similarly to the clipboard copy/cut/paste -mechanism. - -Since SALOME GUI is implemented on Qt, the drag and drop functionality support -is provided by means of the corresponding Qt mechanisms. - -Currently dragging and dropping of the items can be done within Object browser only, -however this functionality can be extended to other GUI elements as well. - -\section enable_drag_and_drop Enabling drag and drop in SALOME module - -The Drag and drop functionality is enabled by default in the Object browser. However, -to allow dragging of a data object or dropping data on it, it is necessary to redefine -\c isDraggable() and \c isDropAccepted() methods of the corresponding class, a successor -of the \c SUIT_DataObject. These methods are defined in the base class \c SUIT_DataObject -and default implementation of both functions returns \c false, which prevents dragging and -dropping: - -\code -bool SUIT_DataObject::isDraggable() const -{ - return false; -} - -bool SUIT_DataObject::isDropAccepted() const -{ - return false; -} -\endcode - -If your data model is based on the \c SUIT_DataObject and \c SUIT_TreeModel, just -re-implement these functions in your successor data object class and return \c true -when it is needed (for example, depending on the data object type, state, etc). - -Another alternative is available if your module is directly inherited from -\c LightApp_Module or \c SalomeApp_Module class (as the majority of existing SALOME modules). -The class \c LightApp_Module (and thus \c SalomeApp_Module also) already provides -high-level API that can be used for enabling drag and drop functionality. - -To enable dragging, redefine \c isDraggable() method of your module class. In this method -you can analyze the data object subject to the drag operation and decide if -it is necessary to enable or prevent its dragging: - -\code -bool MyModuleGUI::isDraggable( const SUIT_DataObject* what ) const -{ - bool result = false; - const MyDataObject* obj = dynamic_cast( what ); - if ( obj ) { - // check if object can be dragged - result = ; - } - return result; -} -\endcode - -Note, that you should not invoke here method \c isDragEnabled() of your data object class -(in case if it inherits \c LightApp_DataObject or \c SalomeApp_DataObject), unless you -redefine methods \c isDraggable() and \c isDropAccepted() in your data object class. -The reason is that the implementation of these methods in \c LightApp_DataObject class -redirects calls to the \c LightApp_Module - be careful to avoid entering endless -recursion loop. - -To allow data dropping to an object (the object under the mouse cursor in the -Object browser during the drag operation) redefine \c isDropAccepted() method of your -module class: - -\code -bool MyModuleGUI::isDropAccepted( const SUIT_DataObject* where ) const -{ - bool result = false; - const MyDataObject* obj = dynamic_cast( where ); - if ( obj ) { - // check if object supports dropping - result = ; - } - return result; -} -\endcode - -The caution about avoiding recursive loop mentioned above is also valid for -\c isDropAccepted() method. - -\section handle_data_dropping Handling data dropping - -When dragging operation is completed (the data is dropped to an object) the module owning -the item on which the data is dropped is notified by invoking its \c dropObjects() method: - -\code -void LightApp_Module::dropObjects( const DataObjectList& what, - SUIT_DataObject* where, - const int row, - Qt::DropAction action ) -{ -} -\endcode - -The default implementation does nothing. However, this method can be redifined in the -successor class and handle the operation properly. The list of dropped -data objects is passed via \c what parameter. The data object on which -the data is dropped is passed via \c where parameter. The parameter \c row specifies in the children list -the position of object where data is dropped; if this parameter is equal to -1, the -data is dropped to the end of the children list. Performed drop action is passed -via \c action parameter; possible values are \c Qt::CopyAction and \c Qt::MoveAction -(other actions are currently unsupported). - -The method \c dropObjects() should analyze the parameters and apply -the corresponding actions for rearrangement of the data tree, copying or moving the data items depending on the -operation performed. For example: - -\code -void MyModuleGUI::dropObjects( const DataObjectList& what, SUIT_DataObject* where, - const int row, Qt::DropAction action ) -{ - if ( action != Qt::CopyAction && action != Qt::MoveAction ) - return; // unsupported action - - // get parent object - MyDataObject* whereObj = dynamic_cast( where ); - if ( !dataObj ) return; // wrong parent - - // iterate through all objects being dropped - for ( int i = 0; i < what.count(); i++ ) { - MyDataObject* whatObj = dynamic_cast( what[i] ); - if ( !whatObj ) continue; // skip wrong objects - // perform copying or moving - copyOrMove( whatObj, // data object being copied/moved - whereObj, // target data object - row, // index in the target data object - action == Qt::CopyAction ); // true if copying is done - } - // update Object browser - getApp()->updateObjectBrowser( false ); -} -\endcode - -In the above code the function \c copyOrMove() performs actual data tree rearrangement. - -\section drag_drop_light_modules Drag and Drop in "light" modules - -The data model of the \a light (not having CORBA engine) SALOME module is usually -based on the custom tree of data objects. The general approach is to -inherit a custom data -object class from the \c LightApp_DataObject and a custom data model from the -\c LightApp_DataModel class. The data model class is responsible for building the -appropriate presentation of the data tree in the Object browser. - -Thus, the implementation of the drag and drop functionality in a \a light module (more -precisely, the method \a dropObjects() as described above), consists in copying data -entities (by creating new instances of the corresponding data object class) or moving -existing data objects to the new position in a tree. The Object browser will update the -tree representation automatically, as soon as \c updateObjectBrowser() function is called. - -\section drag_drop_full_modules Using UseCaseBuilder for Drag and Drop handling in "full" modules - -Drag and drop operation requires underlying data model to allow flexible re-arrangement of -the data entities inside the data tree. In a \a full (CORBA engine based) SALOME -module, which data model is usually based on the hierarchy of \c SALOMEDS::SObject entities -provided by the data server functionality, re-arrangement of the data -tree is not a trivial task. - -However, SALOME data server (\c SALOMEDS) CORBA module proposes a mechanism that can be used -to customize data tree representation in a simple and flexible way - -\ref use_case_builder "use case builder". - -With use case builder, the \c dropObjects() function can be easily implemented. For example: - -\code -// GUI part: process objects dropping -void MyModuleGUI::dropObjects( const DataObjectList& what, SUIT_DataObject* where, - const int row, Qt::DropAction action ) -{ - if ( action != Qt::CopyAction && action != Qt::MoveAction ) - return; // unsupported action - - // get parent object - SalomeApp_DataObject* dataObj = dynamic_cast( where ); - if ( !dataObj ) return; // wrong parent - _PTR(SObject) parentObj = dataObj->object(); - - // collect objects being dropped - MYMODULE_ORB::object_list_var objects = new MYMODULE_ORB::object_list(); - objects->length( what.count() ); - int count = 0; - for ( int i = 0; i < what.count(); i++ ) { - dataObj = dynamic_cast( what[i] ); - if ( !dataObj ) continue; // skip wrong objects - _PTR(SObject) sobj = dataObj->object(); - objects[i] = _CAST(SObject, sobj)->GetSObject(); - count++; - } - objects->length( count ); - - // call engine function - engine()->copyOrMove( objects.in(), // what - _CAST(SObject, parentObj)->GetSObject(), // where - row, // row - action == Qt::CopyAction ); // isCopy - - // update Object browser - getApp()->updateObjectBrowser( false ); -} - -// Engine part: perform actual data copying / moving -void MyModule::copyOrMove( const MYMODULE_ORB::object_list& what, - SALOMEDS::SObject_ptr where, - CORBA::Long row, CORBA::Boolean isCopy ) -{ - if ( CORBA::is_nil( where ) ) return; // bad parent - - SALOMEDS::Study_var study = where->GetStudy(); // study - SALOMEDS::StudyBuilder_var studyBuilder = study->NewBuilder(); // study builder - SALOMEDS::UseCaseBuilder_var useCaseBuilder = study->GetUseCaseBuilder(); // use case builder - SALOMEDS::SComponent_var father = where->GetFatherComponent(); // father component - std::string dataType = father->ComponentDataType(); - if ( dataType != "MYMODULE" ) return; // not a MYMODULE component - - SALOMEDS::SObject_var objAfter; - if ( row >= 0 && useCaseBuilder->HasChildren( where ) ) { - // insert at a given row -> find insertion position - SALOMEDS::UseCaseIterator_var useCaseIt = useCaseBuilder->GetUseCaseIterator( where ); - int i; - for ( i = 0; i < row && useCaseIt->More(); i++, useCaseIt->Next() ); - if ( i == row && useCaseIt->More() ) { - objAfter = useCaseIt->Value(); - } - } - // process all objects in a given list - for ( int i = 0; i < what.length(); i++ ) { - SALOMEDS::SObject_var sobj = what[i]; - if ( CORBA::is_nil( sobj ) ) continue; // skip bad object - if ( isCopy ) { - // copying is performed - // get the name of the object - CORBA::String_var name = sobj->GetName(); - // create a new object, as a child of the component object - SALOMEDS::SObject_var new_sobj = studyBuilder->NewObject( father ); - new_sobj->SetAttrString( "AttributeName", name.in() ); - sobj = new_sobj; - // ... perform other necessary data copying like - // adding the corresponding attributes or creation - // of servant data entities... - } - // insert the object or its copy to the use case tree - if ( !CORBA::is_nil( objAfter ) ) - useCaseBuilder->InsertBefore( sobj, objAfter ); // insert at a given row - else - useCaseBuilder->AppendTo( where, sobj ); // append to the - end of the list - } -} - -\endcode - -*/ diff --git a/doc/salome/gui/input/index.doc b/doc/salome/gui/input/index.doc deleted file mode 100644 index c306e7609..000000000 --- a/doc/salome/gui/input/index.doc +++ /dev/null @@ -1,82 +0,0 @@ -/*! - -\mainpage Introduction to Salome Platform - -\image html icon_about.png - -
-         -Welcome to SALOME Platform! Modern technological products (cars, -structures, electrical or electronic equipment) are getting more and -more complex every year and must meet increasingly severe requirements -in terms of quality and performance. For example, for structures and -their environment the demands to reduce risks and optimize costs are -extremely high. It requires particularly refined simulations -concerning structural behavior and robustness to ensure high -reliability. -\n The numeric modeling of a physical problem, the development of -solutions and their integration into the design process are often -handled in very specific environments. SALOME represents a generic -CAD-based application for digital simulation with "high reactivity to -market evolutions and customer expectations". - -SALOME is a free software that provides a generic platform for Pre and -Post-Processing for numerical simulation. It is based on an open and -flexible architecture made of reusable components available as free -software. - -SALOME is a CAD/CAE integration platform. It provides reusable -components for: -
    -
  • 3D modeling (bottom-up construction, import, healing); -
  • Visualization; -
  • Computational schemas management; -
  • Post-processing. -
- -SALOME is tailored for integration of custom components: -
    -
  • CAD interfaces; -
  • Mesh generators; -
  • Finite Element solvers with specific pre-processors. -
- -The SALOME platform is available in Open Source. - -Salome Platform: -
    -
  • Supports interoperability between CAD modeling and computation software (CAD-CAE link) -
  • Makes easier the integration of new components on heterogeneous systems for numerical computation -
  • Sets the priority to multi-physics coupling between computation software -
  • Provides a generic user interface, user-friendly and efficient, which helps to reduce the costs and delays of carrying out the studies -
  • Reduces training time to the specific time for learning the software solution which has been based on this platform -
  • All functionalities are accessible through the programmatic -integrated Python console -
- -\image html image65.png - -What can you do in SALOME? (Some of SALOME main functions) -
    -
  • Define geometrical models (create/modify geometrical items), import and export them using the BREP, IGES and STEP formats; -
  • Define meshing of these geometrical items, import and export them; -
  • Handle physical properties and quantities attached to geometrical items, import and export them to a reusable format; -
  • Perform computations using a solver (optionally provided): read input data, configure the solver, and write calculation results); -
  • Visualize result fields in 3D, 2D and export images of their visualization to an appropriate format; -
  • Manage study schemes: definition, save/restore; -
  • Manage computation schemes: definition, execution. -
- -From the point of view of the \subpage salome_architecture_page "Architecture", -Salome is composed of several modules. - -This part of documentation on Salome also covers -\subpage introduction_to_gui_page "general Salome functionalities", -common for all modules, such as study management, Salome viewers, -preferences, etc. - - -And finally, there is an additional chapter, which provides a short -guide about the \subpage tui_page "usage of SALOME GUI Python interface" to access SALOME GUI -functionalities from the Python code. -*/ diff --git a/doc/salome/gui/input/introduction_to_gui.doc b/doc/salome/gui/input/introduction_to_gui.doc deleted file mode 100644 index 75c02ae41..000000000 --- a/doc/salome/gui/input/introduction_to_gui.doc +++ /dev/null @@ -1,68 +0,0 @@ -/*! - -\page introduction_to_gui_page Introduction to GUI - -\image html view2.png - -\b SALOME \b GUI is based on SUIT (Salome User Interface -Toolkit) that proposes very flexible, powerful and safe mechanisms of -interaction with SALOME tool components (both CORBA and standalone), -resource management, viewers and selection handling, -exception and signals processing. - -All Graphical User Interfaces of standard modules have plug-in -structure, i.e. each module is placed in a dynamic library which is -loaded on demand. So, all modules add their own menu items, buttons -in toolbar, windows etc. -\b GUI (Graphical User Interface) provides a common shell for all -components, which can be integrated into the SALOME platform and some -basic GUI functionalities, common for all modules. - -\image html mainmenu.png - -
    -
  • \b File menu corresponds to \subpage study_management_page "Study management" functionalities -(creation, saving, loading, connecting, disconnecting, editing studies, etc.)
    • -
  • \b Edit menu gives access to Copy/Paste allowing to paste the -objects from one study into the other. The availability of this -functionality depends on the module and the nature of an operation or -an object.
    • -
  • \b View and \b Window menus provide functionalities of -\subpage salome_desktop_page "Desktop management". Basically, they -allow to show/hide toolbars, activate and manage study windows, change -the appearance of Salome, etc. Among key parts of study window are: - -
      -
    • Viewer window, used for visualization of objects,
      • -
    • \subpage using_object_browser_page "Object Browser", used for -management of objects created or imported into the SALOME -application, also providing search possibilities with the -\subpage using_find_tool_page "Find Tool", and
      • -
    • \subpage using_notebook "Notebook" - allows to predefine study variables.
      • -
    • \subpage python_interpreter_page "Python interpreter", used for -direct input of python commands and dumping studies into Python -scripts.
      • -
    • Almost all aspects of Salome look and feel can be tuned by the -user in \subpage themes_page "Themes" dialog.
      • -
    -
    • - -
  • \b Tools menu gives access to: \subpage using_catalog_generator_page "Catalogue Generator", -\subpage using_registry_tool_page "Registry tool" and \ref using_pluginsmanager "Python plugins"
    • -
  • \b Help menu gives access to the help on Salome modules. The -appropriate help page can also be called from any operation dialog via -\b Help button.
    • -
- -Help for the GUI module provides information about standard -\subpage viewers_page "Salome Viewers". - -General application preferences are described in the \subpage setting_preferences_page "Preferences" -section of SALOME GUI Help. - - -\subpage using_input_widgets_page "Using input widgets" sub-section -covers specific aspects of behavior of certain kinds of SALOME GUI -input fields. - -*/ diff --git a/doc/salome/gui/input/occ_3d_viewer.doc b/doc/salome/gui/input/occ_3d_viewer.doc deleted file mode 100644 index fcbb14384..000000000 --- a/doc/salome/gui/input/occ_3d_viewer.doc +++ /dev/null @@ -1,379 +0,0 @@ -/*! - -\page occ_3d_viewer_page OCC 3D Viewer - -

Operations

- -The functionalities of OCC 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 html occviewer_toolbar.png -
- -\image html occ_view_camera_dump.png - -Dump View - exports an object from the viewer in bmp, png, -jpeg or another image format. -
- -\image html occ_view_style_switch.png - -Interaction style switch - allows to switch between standard -and "keyboard free" interaction styles. "Keyboard free" style allows -to process all view transformations without using keyboard (only by -mouse). By default, rotation in this mode is performed by left mouse -button, panning - by middle mouse button, zooming - by right mouse -button. Selection in view by pressing "s" key works in both -styles. -
- -\image html occ_view_zooming_style_switch.png - -Zooming style switch - allows to switch between standard -(zooming at the center of the view) and advanced (zooming at the -current cursor position) zooming styles. -
- -\image html occ_view_triedre.png - -Show/Hide Trihedron - shows or hides coordinate axes. -
- -\image html occ_view_preselection.png - -Enable/Disable preselection - enables or disables preselection (highlighting) in the view. -
- -\image html occ_view_selection.png - -Enable/Disable selection - enables or disables selection in the view. -
- -\image html occ_view_fitall.png - -Fit all - represents all displayed objects in the -visible area. -
- -\image html occ_view_fitarea.png - -Fit area - resizes the view to place in the visible area only -the contents of a frame drawn with pressed left mouse button. -
- -\image html occ_view_fitselection.png - -Fit selection - fits view contents to the current selection. -
- -\image html occ_view_zoom.png - -Zoom - allows to zoom in and out. -
- -\image html occ_view_pan.png - -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 html occ_view_glpan.png - -Global panning - allows to select a point to be the center of a scene -representing all displayed objects in the visible area. -
- -\image html occ_view_rotation_point.png - -Change rotation point - allows to choose the point around -which the rotation is performed. - -\image html set_rotation_point_dialog1.png - -By default the rotation point is located in the Center of the bounding -box of represented objects. - -\image html set_rotation_point_dialog2.png - -Unchecking Use Bounding Box Center check-box allows you to -change rotation point: - -- Set to Origin button sets the rotation point to -origin of coordinates: (0, 0, 0). - -- Gravity Center of Selected Object button allows using the -gravity center of the object selected in the viewer as the center of -the rotation point. -When you click this button, you should first choose the type of -selectable object: Point, Edge, Face or Solid and only then proceed -with selection in the viewer. - -- Also you can define the coordinates of the rotation point manually. - -
- -\image html occ_view_rotate.png - -Rotation - allows to rotate the scene using the mouse. -
- -\image html occ_view_front.png -\image html occ_view_back.png -\image html occ_view_top.png -\image html occ_view_bottom.png -\image html occ_view_left.png -\image html occ_view_right.png - -These buttons orientate the scene strictly about coordinate axes: -\b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side. -
- -\image html occ_view_anticlockwise.png - -Rotate counterclockwise - rotates view 90 @htmlonly ° @endhtmlonly counterclockwise. -
- -\image html occ_view_clockwise.png - -Rotate clockwise - rotates view 90 @htmlonly ° @endhtmlonly clockwise. -
- -\image html occ_view_orthographic.png - -Ortographic projection - default OCC viewer projection mode. -
- -\image html occ_view_perspective.png - -Perspective projection - perspective OCC viewer projection mode. -
- -\image html occ_view_stereo.png - -Stereo projection - stereoscopic rendering of the view. -\note Activation of this mode also switches the view to perpective projection -in case if the orthographic one has been active. -\note By default, quad-buffered stereo is activated, if it is supported by the graphic card. -If no stereo capabilities are available, an error message is shown. -\note The stereoscopic view settings can be defined in -\ref occ_preferences "OCC 3D Viewer" preferences. - -
- -\image html occ_view_reset.png - -Reset - restores the default position (isometric) of objects in -the scene. -
- -\image html occ_view_shoot.png - -Memorize view - saves the current position of objects in the -scene. -
- -\image html occ_view_presets.png - -Restore view - restores the saved position of objects in the -scene. -
- -\image html occ_view_clone.png - -Clone view - opens a new duplicate scene. -
- -\anchor clipping_planes - -\b Clipping allows creating cross-section views (clipping planes) -of your mesh. - -To create a clipping plane, click on the \b New button in the dialog and choose how it will be defined by \b Absolute or \b Relative coordinates. - -Absolute Coordinates - -\image html Clipping_Absolute.png - -- Base point - allows defining the coordinates of the base - point for the clipping plane. - - - Reset - returns the base point to coordinate origin. - -- Direction - allows defining the orientation of the - clipping plane. - - - Invert - allows selecting, which part of the object will be - removed and which will remain after clipping. - -Relative mode - -\image html Clipping_Relative.png - -- \b Orientation ( ||X-Y, ||X-Z or ||Y-Z). - -- \b Distance between the opposite extremities of the boundary box of -represented objects, if it is set to 0.5 the boundary box is split in two halves. - -- \b Rotation (in angle degrees) around X (Y to Z) and around -Y (X to Z) (depending on the chosen Orientation) - -The other parameters are available in both modes : -- Active checkbox is used to apply/erase current plane and it's affect to/from view. -- Delete removes the active clipping plane and discards it's view changes. -- Disable all deactivates all created clipping planes and clears Auto Apply checkbox. -- Preview check-box shows the clipping plane in the 3D Viewer. -- Auto Apply check-box allows you to see the result of clipping -in the 3D Viewer immediately. Be careful, it is not a preview -and Close button could not cancel the applied modifications. - -It is also possible to interact with the clipping plane directly in 3D -view using the mouse. - -
- -\image html occ_view_scaling.png - -Scaling - represents objects deformed (stretched or stuffed) -along the axes of coordinates. -
- -\image html occ_view_graduated_axes.png - -Graduated axes - allows to define axes parameters and graduate -them. - -\image html graduatedaxes2.png - -- Axis name - if checked the axis name is displayed in the viewer. - - - Name - allows to redefine the axis name. - - - Font - allows to define the font color of the axis name. - -- Labels - if checked the labels are displayed in the viewer. - - - Number - allows to define the number of labels. - - - Offset - allows to define the distance between axis and labels. - - - Font - allows to define the font color of labels names. - -- Tick marks - if checked the tick marks are displayed in the viewer. - - - Length - allows to define the length of tick marks. - -- Is visible - if checked the graduated axes are displayed in the viewer. - -
- -\image html occ_view_ambient.png - -Toggle ambient light - toggle "keep only ambient light" flag -on/off. -
- -\image html occ_view_minimized.png -\image html occ_view_maximized.png - -Minimize/Maximize - these buttons allow switching the current -view area to the minimized / maximized state. -
- -\image html occ_view_return_3d_view.png - -Return to 3D - this button switches from 2D view projection back to the 3D view mode. -
- -\image html occ_view_sync.png - -Synchronize view - allows to synchronize 3d view -parameters. This button has two states - checked and -unchecked. Clicking on this button opens a drop-down menu listing the -compatible 3d views. As soon as the user selects any view from the -list, the parameters (view point, position, zoom coefficient, etc.) of -the current view are synchronized with the selected view (static -synchronization). - -In addition, when this button is in the "checked" state, the dynamic -synchronization of the views is performed, i.e. any zoom, pan, rotate -or other view operation done in one view is automatically applied to -the other view. -
- -\image html occ_view_ray_tracing.png - -\anchor ray_tracing - -Ray tracing - allows to switch between rendering methods in run-time -in the current OCCT 3D view. It can be used to produce images with photorealistic quality. - -\image html doc_ray_tracing.png - -- Ray tracing - specifies rendering mode: OpenGL rasterization (by default) or GPU ray-tracing. - - - Depth - defines maximum ray-tracing depth. - - - Specular reflections - enables/disables specular reflections. - - - Adaptive anti-aliasing - enables/disables adaptive anti-aliasing. - - - Shadows rendering - enables/disables shadows rendering. - - - Transparent shadow - enables/disables light propagation through transparent media. - -
- -\image html occ_view_env_texture.png - -\anchor env_texture - -Environment texture - allows to set parameters for environment texture. -This is a special mode of texture mapping when specular reflection of environment texture -is simulated by OpenGL using a special texture coordinates generation algorithm (a sphere map). - -\image html doc_env_texture.png - -- Environment texture - enables/disables environment texture in the current OCCT 3D view. - -User can select one of 7 predefined environment texture from the list or define its texture from file by -choosing item "Custom..." in a combo box. - -\note Environment texture file should normally satisfy the following requirements -in order to produce good visual result: -- The image file should have 2:1 width-to-height ratio. -- It should constitute a 360-degrees panoramic image created using a fish-eye lens. - -
- -\image html occ_view_light_source.png - -\anchor light_source - -Light source - allows to set parameters for light source. - -It's possible to choose a type of light source between directional and positional light. - -\image html doc_dir_light_source.png - -Directional light - creates a directional light source in the viewer. -It is defined by direction coordinates, color and headlight parameter. - -\image html doc_pos_light_source.png - -Positional light - creates an isolated light source X,Y,Z in the viewer. -It is also defined by the color and headlight parameter. - -Click: - -- Apply and Close to apply defined light source to the OCC 3D Viewer. - -- Default to restore default values of light source. - -- Close to return parameters of light source on initial values. - -
-*/ diff --git a/doc/salome/gui/input/plot2d_viewer.doc b/doc/salome/gui/input/plot2d_viewer.doc deleted file mode 100644 index 823c8cf49..000000000 --- a/doc/salome/gui/input/plot2d_viewer.doc +++ /dev/null @@ -1,245 +0,0 @@ -/*! - -\page plot2d_viewer_page Plot 2D viewer - -The functionalities of Plot2d 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 html plot2dviewer_toolbar.png -
- -\image html plot2d_camera_dump.png - -Dump View - exports an object from the viewer in -bmp, png or jpeg image format. -
- -\image html plot2d_fitall.png -Fit all - scales the display to show the entire scene. Use this -to resize the scene so that it could fit within the Viewer boundary. -
- -\image html plot2d_fitarea.png - -Fit area - resizes the view to place in the visible area only -the contents of a frame drawn with pressed left mouse button. -
- -\image html plot2d_zoom.png - -Zoom - allows to zoom in and out. -
- -\image html plot2d_pan.png - -\b 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 html plot2d_glpan.png - -Global panning - allows to define the center of the scene -presenting all displayed objects in the visible area. -
- -\image html plot2d_points.png - -Draw Points - switches display mode to \em Points. In -this mode, each curve is displayed as a set of points. -
- -\image html plot2d_lines.png - -Draw Lines - switches display mode to \em Lines. In this -mode, each curve is represented as a set of plain line segments. -
- -\image html plot2d_splines.png - -Draw Splines - switches display mode to \em Splines. In -this mode, each curve is represented as a spline. -
- -\image html plot2d_lmin_normalization.png - -Normalization to global minimum by left Y axis - switches -normalization mode to Left Y Axis: Minimum normalization. -In this mode, all curves are normalized to the global minimum by the left Y axis. - -\image html plot2d_lmax_normalization.png - -Normalization to global maximum by left Y axis - switches -normalization mode to Left Y Axis: Maximum normalization. -In this mode, all curves are normalized to the global maximum by the left Y axis. -
- -\image html plot2d_rmin_normalization.png - -Normalization to global minimum by right Y axis - switches -normalization mode to Right Y Axis: Minimum normalization. -In this mode, all curves are normalized to the global minimum by -the right Y axis. - -\image html plot2d_rmax_normalization.png - -Normalization to global maximum by right Y axis - switch -normalization mode to Right Y Axis: Maximum normalization. -In this mode, all curves are normalized to the global maximum by -the right Y axis. -
- -\image html plot2d_linear.png -\image html plot2d_log.png - -These buttons allow to switch horizontal axis scale to the linear or -logarithmic mode. - -\note The logarithmic mode of the horizontal -axis scale is allowed only if the minimum value of abscissa component -of displayed points is greater than zero. - -
- -\image html plot2d_linear_y.png -\image html plot2d_log_y.png - -These buttons allow to switch vertical axis scale to the linear or -logarithmic mode. - -\note The logarithmic mode of the vertical -axis scale is allowed only if the minimum value of ordinate component -of displayed points is greater than zero. - -
- -\image html plot2d_legend.png - -Show Legend - Shows / hides information about the displayed -objects in a legend. -
- -\image html plot2d_settings.png - -\b Settings - provides an access to the settings dialog box, that -allows to specify advanced parameters for the Plot 2d Viewer. - -\anchor settings -\image html plot2d_view_settings.png - -The following options are available: - -- Main title is the XY plot title. By default, it contains the names of tables, from which the curve - lines are constructed. - -- Curve type allows selecting from \em Points, \em Lines or \em Spline. - -- Marker size - size of the points (markers) forming curve lines. - -- Background color of the XY plot. - -- Selection color - defines the color of selected object in the viewer. - -- Legend specifies the legend properties. - - - Show legend - specifies if the legend is shown by default. - - - Legend Position allows positioning the - description table on XY plot (to the \em Left, to the \em Right, - on \em Top or on \em Bottom). - - - Symbol type allows positioning the legend item symbol: "Marker on line" or "Marker above line". - - - Legend font allows setting font variant, size and style for legend items. - - - Legend font color allows selecting the font color for legend items. - - - Highlighted legend font color allows selecting font color for selected legend items. - -- Deviation marker specifies the properties of the marker, which is used for drawing deviations data. - - - Line width line width of the marker. - - - Tick size size of the upper and lower horizontal lines of the marker. - - - Color color of the marker. - -- Normalization allows selecting the type of - normalization (\em minimum or/and \em maximum) for the displayed - presentations of 2d curves in the view. - -- Scale mode allows selecting the type of scaling (\em Linear - or \em Logarithmic) for X (Horizontal) or Y (Vertical) - axes separately. Note that the \em Logarithmic scale can be used - only if the minimum value of corresponding component (abscissa or - ordinate) of all points displayed in the viewer is greater than - zero. - -- Axis ... options group allows specifying additional settings - for each axis separately: - - - Axis title - an axis title. - - - Grid / Axes marks allows defining the maximum number - of major and minor scale divisions for a given axis. The real - number of intervals fits to {1,2,5}*10^N, where N is a natural - number, and does not exceed the maximum. - -- Save settings as default If this check box is marked, all XY - plots will be displayed with these defined properties. - -
- -\anchor analytical_curve -\image html plot2d_analytical_curve.png - -Analytical curves - provides an access to the analytical curves -dialog box that allows to add, remove and modify analytical curves -for the Plot 2d Viewer. - -\image html analytical_curves_dlg.png - -The options are as follows: - -- Curve parameters: - - - y(x)= allows specifying a python expression, which is used to - calculate the coordinates of the curve points, where x - corresponds to the horizontal range, shown in plot 2D viewer. - - - Nb. itervals allows specifying the number of the curve points. - -- Curve properties: - - - Auto assign if checked, the properties - (Line type, Line width, Marker type and - Color) are assigned to curves automatically. To define - the curve properties manually, uncheck this control. - - - Line type allows to choose curve line type from \em None, - \em Solid, \em Dash, \em Dot, Dash - Dot and - Dash - Dot - Dot. - - - Line width allows to specify line width of the curve. - - - Marker type allows to choose curve marker type from - \em Circle, \em Rectangle, \em Diamond, Rightward Triangle, - Leftward Triangle, Downward Triangle, - Upward Triangle, \em Cross and Diagonal Cross). - - - Color allows specifying the curve color. - -
- -\image html plot2d_clone.png - -Clone view - opens a new duplicate scene. -
- -\image html plot2d_print.png - -Print view - prints the current view scene. - -*/ diff --git a/doc/salome/gui/input/python_viewer.doc b/doc/salome/gui/input/python_viewer.doc deleted file mode 100644 index 2120f037a..000000000 --- a/doc/salome/gui/input/python_viewer.doc +++ /dev/null @@ -1,97 +0,0 @@ -/*! - -\page python_viewer_page Python viewer - -The functionalities of Python viewer are available via its Toolbar. - -\image html pythonviewer_toolbar.png -
- -\image html python_new.png - -New - clears the viewer to create a new script. If viewer was modified, you will be asked to close it before removing. -
- -\image html python_open.png -Open - allows opening an existing script by browsing for it in a standard Open File dialog box, choosing the required .py file and clicking \b Open button. If there is an already opened script, you will be asked to close it before opening new one. -
- -\image html python_save.png - -Save - saves the current script. - -\note If the script has not been previously saved, Save calls the standard Save File dialog, where you can enter the script name and save it. - -
- -\image html python_saveas.png - -Save As... - allows saving the current script with a new name. Input a new name for the script in the standard Save file as dialog box and click \b Save button. -
- -\image html python_undo.png - -Undo - undoes the last action in Python viewer. -
- -\image html python_redo.png - -Redo - redoes the previously undone action in Python viewer. -
- -\image html python_cut.png - -Cut - saves the selected text into the clipboard and removes it from the viewer. -
- -\image html python_copy.png - -Copy - saves the selected text into the clipboard. -
- -\image html python_paste.png - -Paste - restores the saved text from the clipboard. -
- -\image html python_delete.png - -Delete - removes the selected text. -
- -\image html python_selectall.png - -Select All - selects the whole text. -
- -\image html python_preferences.png - -Preferences - provides access to the preferences dialog box, that allows specifying advanced parameters for the Python Viewer. - -\anchor custom_python_preferences -\image html python_view_preferences.png - -The following options are available: - -- Font settings allows setting font variant and its size. - -- Display settings specifies the script representation in the viewer: - - - Enable current line highlight switches on background coloring of the current line. - - Enable text wrapping wraps lines at the view border of the editor. - - Center cursor on scroll scrolls the script vertically to make the cursor visible at the center of the viewer. - - Display line numbers area shows a panel with line numbers of the script at the left border of the editor. - -- Tab settings allows displaying tab indentation as a certain number of white-spaces. - -- Vertical edge settings manages drawing of a vertical line at the specified column of the viewer. - -- Save settings as default button stores the applied Python viewer settings in the SALOME preferences .xml file. The settings will be restored in the current and next SALOME sessions. - -The buttons in in the bottom part of dialog box peform the following actions: -- \b OK button applies preferences to the editor; -- \b Cancel button rejects changes; -- \b Defaults button restores preferences from applicaion's defaults; -- \b Help button opens Help browser. - -*/ diff --git a/doc/salome/gui/input/qxscene_2d_viewer.doc b/doc/salome/gui/input/qxscene_2d_viewer.doc deleted file mode 100644 index 08cc74db9..000000000 --- a/doc/salome/gui/input/qxscene_2d_viewer.doc +++ /dev/null @@ -1,54 +0,0 @@ -/*! - -\page qxscene_2d_viewer_page QxScene 2D Viewer - -

Operations

- -The functionalities of QxScene 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 html qxviewer_toolbar.png -
- -\image html qx_view_fitall.png - -Fit all - scales the presentation so that it could fit within -the Viewer boundaries. -
- -\image html qx_view_fitarea.png - -Fit area - resizes the view to place in the visible area only -the contents of a frame drawn with pressed left mouse button. -
- -\image html qx_view_zoom.png - -Zoom - allows to zoom in and out. -
- -\image html qx_view_pan.png - -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 html qx_view_glpan.png - -Global panning - allows to select a point to be the center of -the presentation showing all displayed objects in the visible ares. -
- -\image html qx_view_reset.png - -Reset - restores the default position the scene. -
- -For more details about QxScene viewer, refer to the SALOME YACS module -User's guide. - -*/ diff --git a/doc/salome/gui/input/salome_architecture.doc b/doc/salome/gui/input/salome_architecture.doc deleted file mode 100644 index c91983ef4..000000000 --- a/doc/salome/gui/input/salome_architecture.doc +++ /dev/null @@ -1,110 +0,0 @@ -/*! - -\page salome_architecture_page SALOME architecture - -         - -\b SALOME architecture is based on \b CORBA technology using -distributed system model of applications. -\b SALOME combines several software components, which are built in such a way that it allows to -integrate solvers and existing meshing algorithms along with the -specification of physical properties for a given domain. The -originality of this approach is that the various components must -cooperate dynamically and be configurable. - -\image html image54.png - -
SALOME platform integrates a number of modules each having its own function: -
    -
  • \b KERNEL : provides a common shell for all components, which can be integrated into the SALOME platform. -
  • \b GUI : provides visual representation: basic widgets, viewers -etc. Third party modules optionally can have GUI, but in any case they always connected with KERNEL. -
  • \b Geometry : facilitates construction and optimization of geometrical models using a wide range of CAD functions. -
  • \b Mesh : generates meshes on geometrical models previously created or imported by the Geometry component. -
  • \b ParaVis : performs data visualization and post-processing. -
  • \b MED : allows to work with MED files. -
- -Salome architecture takes the concept of multitier client/server to its natural conclusion. The -distributed system model exposes all functionality of the application -as objects, each of which can use any of the services provided by -other objects in the system, or even objects in other systems. The -architecture can also blur the distinction between "client" and -"server" because the client components can also create objects that -behave in server-like roles. This architecture provides the ultimate -in flexibility. - - -         -The distributed system architecture achieves its flexibility by -encouraging (or enforcing) the definition of specific component -interfaces. The interface of a component specifies to other components -what services are offered by that component and how they are used. As -long as the interface of a component remains constant, that -component's implementation can change dramatically without affecting -other components. - - -         -All software components (Geometry, Mesh...) integrated into -\b SALOME platform implement predefined interfaces. Each component -provides data for the \b SALOME study in a form of links (stored in -the Study) to the specific data created and stored in the -component. All components represent \b CORBA servers and it allows to -run them on different host stations. - -\image html image67.png - -         -It is equally possible to create engine-independent modules. These -modules may not use CORBA at all, and can have internal data structure -which can be written in pure C++ (or python). Such modules are located -inside SALOME GUI process and from the point of view of the end user -have no difference with standard components. Such modules not using -the standard tools of SALOME platform are defined on a special -separated level named CAM. CAM component is the basis for new SALOME -GUI and contains all basic functionality for working with modules -(loading; saving, closing, customization of toolbar and menu). - - -         -Another fundamental piece of the \b SALOME architecture is the use of -the Interface Definition Language (IDL). IDL, which specifies -interfaces between CORBA components, is instrumental in ensuring -CORBA's language independence. Because interfaces described in IDL can -be mapped to any programming language, CORBA applications and -components are thus independent of the language(s) used to implement -them. - -         -Additional information about CORBA technology -is available at http://www.omg.org - -         -The architecture of this all-inclusive -platform for numerical components responds to the following -objectives: -
    -
  1. \b Flexibility : the creation and modification of computation -schemes must be easy. The developer must have easy access to all -modeling parameters to create domain-specific tools adapted to new -situations or to test new numerical algorithms. SALOME allows -integration and implementation of numerical and physical components -derived from existing code.
    2. -
  2. \b Productivity : the implementation of code is simple for the -user and the reuse of components (within other environments for -macro-components) is noticeably facilitated.
    3. -
  3. \b Performance :\b SALOME is able to more finely simulate -phenomena that is more complex in scale and in physical coupling -requirements. \b SALOME economically exploits the performance of used -machines (massively parallel processors, PC clusters, etc).
    4. -
  4. \b Expandability: on the one hand, software technologies and -physical architectures evolve rapidly compared to the development -time, validation and use of a scientific application while on the -other hand, the development of a database model adapted to the -totality of exchanges between components can be achieved -incrementally. \b SALOME is able to easily follow these -developments.
    5. -
- -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/salome_desktop.doc b/doc/salome/gui/input/salome_desktop.doc deleted file mode 100644 index 2eb5ffd46..000000000 --- a/doc/salome/gui/input/salome_desktop.doc +++ /dev/null @@ -1,89 +0,0 @@ -/*! - -\page salome_desktop_page SALOME desktop - -SALOME applies Single Document Interface (SDI) approach. Only one -\ref study_management_page "study (document)" can be opened at any given moment. - -The front-end of the application is a single Desktop top-level window -that embeds all GUI operations. The desktop window provides access to standard GUI elements, -such as viewers, main menu, toolbars, dockable windows, dialog boxes, etc. - -The main elements of the SALOME Desktop are represented on the picture below: - -\image html desktop.png - -The main parts of the SALOME Desktop are: -- Main menu - This is a set of context-sensitive menus -updated according to the functionality of the currently active component. In -general, these menus contain all functional options of SALOME platform. -- Standard toolbar - contains standard actions -that allow creating new or opening existing study, saving study, deleting -objects, etc. -- Components toolbar - allows activating -components in SALOME platform. -- Module toolbars - contain actions specific to the -currently active module. -- Viewer toolbar - provides a set of tools destined for visualization -of the presentations in the viewer. - -All toolbars in the \b SALOME Platform are context-sensitive. Loading of a definite component -(Geometry, Mesh etc.) will automatically add some additional -toolbars specific to this component. To display/hide a toolbar, in the main menu choose View > Toolbars, and from this submenu check or uncheck the toolbar that you would like to display/hide. - -By default all toolbars are located on top of the SALOME desktop, but you can relocate a toolbar by dragging it with the mouse and dropping in any place of the window. - -Parts of the study window: -- Object browser - Management of objects created or imported into -SALOME application. -- \b Viewer - This window is destined for visualization of -presentations. -- Python console - Window for Python interpreter. This window -functions like a standard document: the pop-up menu invoked by -right-click in this window gives access to -Copy/Paste/SelectAll/ClearAll options. - -Object Browser, Python Console, MenuBar, etc are, in fact, separate dockable windows. -Dockable windows can be placed in special areas, on the borders of -desktop like toolbars. You can change the size and the position of -dockable windows, hide them or even place outside desktop. SALOME -saves in the same file all positions and sizes of dockable windows. It -means that the difference in settings of the same windows (for example -Python console) is possible between different modules (the same window -can have different size and position when other module is -activated). Also each module can indicate which common windows are -necessary for working, and only they will be displayed when this -module is active. - -All parts of Salome desktop and study window can be managed through \b View menu. - -\image html viewmenu.png - -- \b Toolbars - allows to show and hide toolbars. -- \b Windows - allows to show and hide dockable windows, such as -Object Browser and Python Console. -- Status Bar allows showing and hiding the Status Bar. -- \ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for Salome session. - -If there are several viewer windows in your current study and you want to display more then one at the same time, you can use the functionalities provided by the \b Window menu. - -\image html windowmenu.png - -- New window - allows to open a new instance of any viewer. -- Close - closes the currently active viewer window. -- Close all - closes all viewer windows. -- Group all - arranges all created viewer windows on the same desktop. -- Arrange Views - allows choosing the necessary views and their layout (see image below). - - The radio-buttons in Views Layout section allow choosing the number of views to be arranged (2, 3 or 4). The buttons with images allow choosing the view layout (depending on the chosen number of views). - - Views List contains the list of opened view windows, where it is possible to check in the necessary views. - - Close the remaining views check-box allows closing all non-selected views. - - Stack the remaining views check-box allows stacking all non-selected views in the last tab area. - -\image html arrange_views_dlg.png - -- Split Vertically and Split Horizontally allow splitting -the representation area into two parts, in horizontal or vertical direction. -- List of all opened viewer windows provides fast access to them. -- \b Rename - allows renaming the currently selected viewer window. - -*/ diff --git a/doc/salome/gui/input/select_color_and_font.doc b/doc/salome/gui/input/select_color_and_font.doc deleted file mode 100644 index 4e6e6258e..000000000 --- a/doc/salome/gui/input/select_color_and_font.doc +++ /dev/null @@ -1,32 +0,0 @@ -/*! - -\page select_color_and_font_page Select Color and Font - -\anchor select_color_dlg -Select Color and Select Font menus are used in many -Preferences. - -

Select color

- -\image html selectcolor.png - -This menu allows to choose from either predefined Basic Colors -grouped in the upper left corner of the window or Custom Colors, which -you can define yourselves. To define a Custom Color, click on one of -the Custom Color cells, select the color you need in the field of -colors or by typing in its numeric parameters in the lower right -corner of the window, then click Add to Custom Colors button. The -chosen color will be added to Custom Colors table. - -\anchor font_color_dlg -

Select font

- -\image html selectfont.png - -This menu provides a wide choice of \b Fonts, Font Styles and -\b Sizes. Characters can be underlined or struck out. It is possible to -preview them in the \b Sample window. \b Script dialog-box gives the -possibility to use not only Latin and Latin Extended but also -Cyrillic, Greek, Arabic, Runic and many other subsets. - -*/ diff --git a/doc/salome/gui/input/setting_preferences.doc b/doc/salome/gui/input/setting_preferences.doc deleted file mode 100644 index 9fc1772b2..000000000 --- a/doc/salome/gui/input/setting_preferences.doc +++ /dev/null @@ -1,425 +0,0 @@ -/*! - -\page setting_preferences_page Setting Preferences - -All user preferences of \b SALOME application can be customized using the -common \b Preferences dialog box. This dialog can be open using the -File > Preferences... menu item. - -The \b Preferences dialog box consists of two parts: -- Available preferences sections are listed in the left part of the dialog -box; usually this list contains "SALOME" item that specifies general -application preferences and a separate section for each SALOME module -available in the current session. -- The tabbed widget at the right side of the dialog box provides -controls that can be used to customize the preferences. - -\note The preferences for modules become accessible only after -explicit loading of these modules. Until then the dialog box will -show the corresponding warning message. - -More detailed information about preferences for certain modules can be found in the User's guide of the corresponding module. - -General application preferences are specified in the \b SALOME section -of the \b Preferences dialog box. These preferences affect on the -application look-n-feel and common functionality. - -If the study has just been started and other -modules have not been loaded yet, it will be possible to change only the settings which refer to -the whole GUI SALOME session. - -

General Preferences

- -\image html pref_salome_general.png - -- Language - - Current language - the language used by the application - GUI. The language change will come in force only after the application is restarted. - - Use C locale - when checked, the C locale will be set for the application, - otherwise a system locale will be used. The locale change will come in force only after - the application is restarted. -- Look and feel - - Show splash screen at start-up - allows showing or hiding the splash screen at start-up. - - Opaque resize - force opaque resize mode for viewers area (tabbed workspace). - Clear this checkbox for less perfomant workstations. - - Drop-down buttons in toolbars for action groups - when - checked, the action groups are represented in the viewer toolbars as - a single drop-down button, switchable by the user. Otherwise, all - the buttons from the action groups are displayed in the toolbar. -- Study Properties - - Multi file save - if checked in, your study will be saved in - several HDF files (one basic HDF file which will store the main - information about the saved study and several other files for the - data created by each component used during the study - session). Opening of this study requires that \b ALL saved files - should be stored in the \b SAME directory. If you would like to - copy your saved study in another directory or machine, you should - copy all stored files. Otherwise, if you try to open this study, - some data will be lost and it will lead to invalid functioning of - the SALOME platform. - - ASCII save - if checked in, your study will be saved in - ASCII format file (or files). - - Automatic loading of light modules when opening study - if checked in, - Light Modules of the current study will be automatically loaded at the next study - opening, allowing completion of object browser. - - Store positions of windows - if checked in, positions of windows - will be saved in a special file at the end of the current session and - then restored for a new session. - - Store positions of toolbars - if checked in, positions of toolbars - will be saved in a special file at the end of the current session and - then restored for a new session. - - Auto-save interval (min) - allows to specify the time interval (in - minutes) for automatic study saving operation. If the time interval is - equal to 0 ("Disabled" value is shown) the automatic saving is not performed. - - Store/restore last GUI state - if checked in, all GUI settings are - saved with the rest of the data whenever you save the study. When the - study is reopened, the GUI state is restored. - - Publish in study in python dump - if this option is switched on, - the Python script resulting from Dump Python operation will - include commands related to the publication of the data in the - study (if this option is supported by specific module). - - Multi file python dump - allows to generate multiple files - (separately for each component) for dumping of a study to a python script. - If the option is disabled, the study is dumped to a single python script. - - Save GUI state in python dump - if this option is switched on, - the Python script resulting from Dump Python operation will - include commands related to the GUI state. -- External browser - allows to define what browser will - be used to show SALOME reference manuals: internal (built-in - SALOME browser) or external (IE, Netscape, Mozilla, ...). In - addition, it is possible to specify - - \b Application - this option allows you to set an external browser (IE, - Netscape) which will be used for viewing SALOME reference manuals. By - default, Mozilla is used. - - \b Parameters - additional parameters required for launching of - the external browser (if applicable). -- Python console - - \b Font - allows quickly setting the parameters (style, size, face) of the - \ref font_color_dlg "font" used in embedded Python console. - - Show banner - this option allows to show/hide the Python banner - on top of the console window. -- Show MRU items - allows to define the maximum \b Number of -items in Most Recently Used list and the Link type: - - \b Long - shows the full path to the file. - - \b Short - shows the file name only. - - \b Auto - shows full paths to the files only if some files from -different locations have the same name. -- Full-screen - - Hide object browser and viewers toolbars - switches automatic hiding of - Object Browser and OCC viewer toolbar in full-screen mode. - -

3D Viewer Preferences

- -\image html pref_salome_3dviewer.png - -- Navigation style - this option allows to choose one of the - modes of work with mouse in OCC and VTK 3D viewers. - - Salome Standard Controls - allows to manipulate objects in the - viewer with the mouse and locked Ctrl button: increase or decrease the - zoom ratio with the left mouse button, translate object in any - direction with the central mouse button or rotate it with the right - mouse button. - - Keyboard Free - allows to manipulate objects in the viewer - with the mouse without locking Ctrl button. In this case the - operations are assigned to the buttons differently: rotation is made - with the left button, translation with the right and zoom with both - pressed in the same time. -- Zooming style - this option allows to choose a zooming mode. - - Relative to the view's center - allows to zoom the view - relatively to its center. - - Relative to the cursor - allows to zoom the view - relatively to the current cursor position. -- Trihedron - viewer trihedron settings: - - Size - size of the coordinate axes (global trihedron) - displayed in the viewer. - - Relative - if this option is switched on, trihedron - axes scale to fit the size of the scene displayed in 3D viewer. - - Show static trihedron - allows to show/hide the static - mini-trihedron located in the bottom-left corner of the viewer. - -\anchor occ_preferences -

OCC 3D Viewer Preferences

- -\image html pref_salome_occviewer.png - -- Projection mode - sets the default projection mode for the viewers: Orthogonal or Perpective. -- Stereo render - stereoscopic view settings: - - Stereo type - specifies a stereo pair type: - - Shutter glasses (OpenGL quad-buffer) - - Anaglyph - - Row-interlaced - - Column-interlaced - - Chess-board stereo for DLP TVs - - Horizontal-anamorphic (side-by-side) - - Vertical-anamorphic (Half OverUnder) - \note The stereo pair type selected in this combobox is applied - for all existing OCC 3D views with stereo rendering already turned on - within the same SALOME GUI session. It is not possible to use - different stereo modes in several OCC 3D views at the same time - within the same SALOME GUI session. - - Anaglyph filter - specifies the format of anaglyph stereo pair: - - Red-Cyan (default) - - Yellow-Blue - - Green-Magenta - - Convergence distance type: Absolute or Relative (default). - - Stereographic focus value - 1 by default. - - IOD type - Absolute or Relative (default). - - Interocular distance (IOD) value - 0.05 by default. - - Reverse stereo - option to swap left and right frames. - - Enable V-Sync - activates vertical synchronization. - - Enable quad-buffer support - allows quad-buffered rendering. - \note It is neccessary to enable quad-buffered stereoscopic rendering - manually in graphic driver settings. SALOME does not do it automatically. - \note All existing OCC 3D views should be re-created for quad-buffer support. - -- Background - specifies the default background for the viewers, - separately for (for more details, refer to the \ref viewer_background - "this page"): - - 3D View - - XZ View - - YZ View - - XY View -- Selection - - Enable preselection - switches preselection on/off. - - Enable selection - switches selection on/off. -- Clipping parameters - specifies the default clipping plane parameters. - - Color - allows to change the color of the clipped region. - - Use default texture - if this option is switched on, the default texture - will be used for clipping texture, otherwise - the texture specified in "Texture" field. - - Texture - allows to change the texture of the clipped region (enable if "Use default texture" is switched off). - - Modulate - controls if "Texture" should be mixed with "Color" parameter or not. - - Scale factor - sets the scale factor for default and custom textures. -- Ray tracing - specifies the default GPU ray-tracing parameters. - - Depth - defines maximum ray-tracing depth. - - Specular reflections - enables/disables specular reflections. - - Adaptive anti-aliasing - enables/disables adaptive anti-aliasing. - - Shadows rendering - enables/disables shadows rendering. - - Transparent shadow - enables/disables light propagation through transparent media. -- Light source - allows to set default parameters for directional light source. - - Color - allows to change the color of light source. - - Dx, Dy, Dz - sets direction coordinates. - -\anchor vtk_preferences -

VTK 3D Viewer Preferences

- -\image html pref_salome_vtkviewer.png - -- Projection mode - allows choosing between \b Orthogonal and -\b Perspective projection mode. -- Background - specifies the default background for the viewer; - for more details, refer to the \ref viewer_background "this page". -- Speed Increment - defines the number of units by - which the speed increases or respectively decreases after pressing [+] - or [-] keyboard buttons. -- Modification Mode - allows choosing between \b Arithmetic - and \b Geometrical progression used for zooming. -- Stereo render - stereoscopic view settings: - - Stereo type - specifies a stereo pair type: - - Crystal Eyes - - Red-Blue - - Interlaced - - Left - - Right - - Dresden - - Anaglyph - - Checkerboard - - Split View Port Horizontal - \note The stereo pair type selected in this combobox is applied - for all existing VTK 3D views with stereo rendering already turned on - within the same SALOME GUI session. It is not possible to use - different stereo modes in several VTK 3D views at the same time - within the same SALOME GUI session. - - Anaglyph filter - specifies the format of anaglyph stereo pair: - - Red-Cyan (default) - - Yellow-Blue - - Green-Magenta - - Enable quad-buffer support - allows quad-buffered rendering. - \note It is neccessary to enable quad-buffered stereoscopic rendering - manually in graphic driver settings. SALOME does not do it automatically. - \note All existing VTK 3D views should be re-created for quad-buffer support. -- Selection - - Preselection - allows to choose among three possible preselection modes: - - Standard - this mode works quickly, by checking only - bounding boxes of objects. It does not deal with the order of actors in the view - or with their data (points/ cells). - - Dynamic - works directly with cells of actors, which provides the - exact area of preselection. This mode is much more slower. - - Disabled - switches off the preselection. - - Enable selection - switches selection on/off. -- Spacemouse - a mouse-like manipulator device specially designed - for working with 3D presentations, objects, etc. You can reassign the - actions listed below to any of its buttons. - - Decrease Speed Increment - decreases by 1 the speed - increment used for the keyboard (same as [-] key). - - Increase Speed Increment - increase by 1 the speed - increment used for the keyboard (same as [+] key). - - Dominant / combined switch - toggles button to switch to - dominant or combined movements. -- AVI Recording - - Mode - allows to choose from two recording regimes: - - Recording all displayed frames - records exactly at the - FPS rate specified by the user. - - Recording at a given FPS - records only when the contents - of the viewer change (some activity is performed). In the AVI file - non-recorded images are substituted with the copies of the latest - recorded image, which produces files with lower quality but requires - less system resources. - - FPS - allows to define the FPS (frames per second) rate for - the clip. Set greater value for better quality. - - Quality - allows to set the quality of the clip in the - interval between 0 and 100. - - Progressive - allows to record a progressive API file. -- Names of groups - allows to specify parameters of the -titles displayed in the viewer: - - Text color - allows selecting the text color; - - Transparency - allows selecting the text transparency. - -\anchor plot2d_preferences -

Plot 2D Viewer Preferences

- -\image html pref_salome_plot2dviewer.png - -- Background color - this submenu allows to select the background -color. Click on the colored line to access to the -\ref select_color_and_font_page "Select Color" dialog box. -- Selection color - this submenu allows to select the color of -selected object in the viewer. -- Viewer - allows specifying the properties of the Plot 2D Viewer. - - Curve Type - this allows to set the representation of graphs in - your presentations. You can see only Points, points connected with - Lines or points connected with smooth Splines. - - Marker Size - this submenu allows you to set the size of - markers in your graphs. - - Horizontal and Vertical axis scale - this submenus allow you to set - the scale for vertical and horizontal axes. It can be either Linear or - Logarithmic. Note that the Logarithmic scale can be used only - if the minimum value of corresponding component (abscissa or ordinate) - of all points displayed in the viewer is greater than zero. - If this condition is not met, the scale is switched to Linear - automatically, even if it is set to Logarithmic. - - Deviation marker color - this submenu allows to select the - color of the deviation marker. - - Deviation marker line width allows to define line width of - the deviation marker. - - Deviation marker tick size allows to define size of the upper - and lower horizontal lines of the deviation marker. -- Legend - allows specifying the properties of the legend. - - Show legend - this options specifies if it's necessary to - show legend by default. - - Legend Position - this submenu allows to set the default position - of the legend, it can be located to the left, to the right, on top or - on bottom of the graph. - - Symbol type you can select the type of legend item symbol from "Marker on line" - or "Marker above line" - - Legend font - this allows to set type and face for the font of Legend item. - - Legend font color - this allows to select the color of the - font of the legend item. - - Highlighted legend font color - this submenu allows to select - the color of the font of the selected legend item. - -\anchor default_python_preferences -

Python Viewer Preferences

- -\image html pref_salome_pythonviewer.png - -\note The following settings are default and will be applied only for newly created Python viewers. Customization of already opened viewers can be done using local \ref custom_python_preferences "Preferences dialog box" called by clicking on the corresponding icon of \ref python_viewer_page "Python viewer toolbar". - -- Font settings allows setting font variant, size and style. - -- Display settings specifies the script representation in the viewer: - - - Enable current line highlight switches on background coloring of the current line. - - Enable text wrapping wraps lines at the view border of the editor. - - - Center cursor on scroll scrolls the script vertically to make the cursor visible at the center of the viewer. - - - Display line numbers area shows a panel with line numbers of the script at the left border of the editor. - -- Tab settings allows displaying tab indentation as a certain number of white-spaces. - -- Vertical edge settings manages drawing of a vertical line at the specified column of the viewer. - -

Directories Preferences

- -\image html pref_salome_directories.png - -- Quick Directory List - this section allows to create and manage -a custom quick directory list. To add a directory in the list, press -the "Add directory" button: -\image html image70.png -then the "..." button and browse the data tree for the -directory you need. -The "Up" and "Down" buttons(see the picture below) help you to sort -the directories in the list: -\image html image73.png -\image html image75.png -To remove the selected directory from the list, press the "Delete" -button: -\image html image72.png - -

Object Browser Preferences

- -\image html pref_salome_objbrowser.png - -- Search Tool - specifies behavior of the -\ref using_find_tool_page "Search tool". - - Enable auto-hiding checkbox - hides the search tool - automatically after short perioud of time when it is not used. -- Look and feel - - Auto size for “Name” column - this checkbox enables automatic - resizing for the “Name” column. - - Auto size for other columns - this checkbox enables - automatic resizing for the other columns. - - Resize columns on expand item - this checkbox enables - resizing columns on expanding an object browser item. - - Browse to the published object - this combobox allows to enable - automatic browsing to the objects just published to the study (using GUI - dialogs only). It means that the object browser will be scrolled to the - published objects, make them visible if they are collapsed and select the - first of them. Three modes are allowed for activating this feature: - - Never - automatic browsing is disabled. - - After Apply & Close only - browsing is activated when the - dialog is accepted by Apply & Close or Ok buttons (or if - the objects are published without using a dialog, for example, by - clicking a context menu button) and not activated when the - Apply button is pressed and therefore the dialog remains visible. - - Always - automatic browsing is always enabled. -- Default columns - these checkboxes allow to display or hide Value, -Entry, IOR and Reference entry columns in the Object Browser. - -

Shortcuts Preferences

- -\image html pref_salome_shortcuts.png - -- Shortcuts settings widget allows to define custom shortcuts for -various operations. To change keyboard sequence for a certain action - select the -action and press the custom keys combination. - - -\subpage select_color_and_font_page "Font and color preferences" -are most oftenly used types of user settings. - -When you change settings (click \b OK or \b Apply button) each module -receives the notification about what preferences are changed. You can -also click \b Defaults button to restore default preferences or \b Close -button to quit the dialog box without any changes. - -\b Import button allows loading specific user file containing -preferences from any location at the computer through a standard -Import dialog box. - -\image html import.png - -The preferences files usually have *.xml extension. Also, -preferences files automatically saved by the application (stored in the -~/.config/salome directory) have no extension and by default start with -.SalomeApprc. followed by SALOME version number. Usually there is a -separate preferences file for each SALOME version in use. Preferences -are saved to the file in the end of the working session and restored -at the application start-up. - -\note The preferences you set will be default preferences for all \b new -objects, but they are not retroactive and do not automatically apply -to the existing objects. - -*/ diff --git a/doc/salome/gui/input/study_management_chapter.doc b/doc/salome/gui/input/study_management_chapter.doc deleted file mode 100644 index 68b3774ab..000000000 --- a/doc/salome/gui/input/study_management_chapter.doc +++ /dev/null @@ -1,143 +0,0 @@ -/*! - -\page study_management_page Study management - -Study is a document within the application, where you can carry out all -operations provided by the SALOME functionality. -This is a certain abstraction layer between actual -document data (probably, remote data available through CORBA) and data -presentation (in the Object Browser). The study is composed of Data -Object instances, combined into a tree-like structure. - -All operations with study are available from the \b File menu. - -\note SALOME is a single-study application. It means that only one study -can be opened at the moment. - -Immediately after the application is launched there is (normally) no active study. -However, you have access to the embedded Python console, that can be used to initialize -a study by means of Python API (see documentation on SALOME KERNEL module for more details). - -The following operations are available from the \b File menu: - -\image html menu_file.png - -As soon as a study is created or loaded from a file or a data server, -additional operations become available from the \b File menu: - -\image html studymanagement.png - -\b New - creates a new study. The study will be created -with default name \b Study1. If there is an already opened study, -you will be asked to close it before creating new one. - -\b Open - allows to open an existing study by browsing for it in a -standard Open File dialog box, choosing the required -*.hdf file and clicking \a Open button. -If there is already opened study, you will be asked to close it -before opening new one. - -\b Reopen - reloads the current study from the associated *.hdf file. -This menu command can be used to reverse the study to the latest saved state. - -\b Save - saves the current study. Saving a study you also save its layout, i.e. all positions and sizes -of dockable windows. It means that the difference in settings of the -same windows (for example Python console) is possible between -different modules (the same window can have different size and -position when other module is activated). Also each module can -indicate which common windows are necessary for working, and only they -will be displayed when this module is active. - -\note If the study hasn't been previously saved, \b Save will -call the standard Save File dialog box where you can enter the name -for your study and save it. - -\b Save \b as - allows to save the current study with a new name. -Input a new name for the study in the standard -Search File dialog box and click \a Save button. - -\b Close - closes the current study; alternatively closing of the study -can be done by clicking on the cross in the upper right corner of the desktop window. - -\note If the study has not been previously saved, you will be prompted -by the following dialog box with several options: - -\image html closestudy.png - -\b Connect - allows to open an unloaded or created outside GUI study. - -\note Connect is available only if there is an opened study on the data server. - -\b Disconnect - unloads the current study from the desktop. The study stays opened -in the data server; it can be then reloaded in the same working session -(using \b Connect operation), but if you quit SALOME application, all changes in the -unloaded study can be lost. - -\note If the study has not been previously saved, you will be prompted -by the following dialog box with several options: - -\image html disconnect_study.png - -Dump study - allows to Dump a SALOME Study in one or several -Python scripts. The following dialog box allows to browse for the location and -define the name for a Python file. - -\image html dumpstudy.png - -
    -
  • -Publish in study - if checked in, the component objects created by -Python commands will be published in the created Study when the script -is played, otherwise the objects will not be published in the Study. -
    • -
  • -Save GUI state - if checked in, the current application layout will be -saved in the Python file. -
    • -
-To confirm your choice click \a Save. - -Load Script - allows to load a saved Python Script. - -\image html loadscript.png - -To confirm your choice click \a Open. - -Properties - allows to show/edit the properties of the current study. - -\image html studyproperties.png - -
    -
  • \b Author - allows to change the name of the study author.
    • -
  • Creation date - gives the date and time of Study creation.
    • -
  • \b Locked - allows to lock the study for modifications. -In case if \b Locked checkbox is checked your study will be locked for any modifications -for all users. Next time you try to edit it, you will see the -following warning message: -\image html lockedstudy.png
    • -
  • Modified/Not Modified - allows to see if any modifications have been -introduced into study since its last save.
    • -
  • Length units - allows to change the units of the study.
    • -
  • \b Comment - allows to add arbitrary comment for the study.
    • -
  • \b Modifications - allows to view the list of changes made in the study. -Each record contains the date and time of the -modification and the name of the user, who has introduced it.
    • -
  • Stored data - Shows the versions of data currently stored -in the study. Note, that this information does not concern the current -versions of SALOME modules, it shows the version in which the data has been -initially created. If the study is re-saved in the version of SALOME, -different from the initial one, the version information is -highlighted by the red-colored font, which means that the version information -is not actually valid.
    • -
- -\b Preferences - allows \ref setting_preferences_page "setting preferences" - applicable to Salome in general and its modules. - -Most recently used - contains a list of recently opened -studies, giving the possibility to fast load the required study. - -\b Exit - unlike \b Close, closes not only the current, but all opened -Salome studies. - -*/ diff --git a/doc/salome/gui/input/text_user_interface.doc b/doc/salome/gui/input/text_user_interface.doc deleted file mode 100644 index 5501c21ce..000000000 --- a/doc/salome/gui/input/text_user_interface.doc +++ /dev/null @@ -1,78 +0,0 @@ -/*! - -\page tui_page Using SALOME GUI python interface - - -The extended salome.py Python module provides \b sg variable, which gives access to some GUI functions. - -\b Note, that this variable is not available if you use salome.py -Python module outside of the GUI desktop, i.e. without the embedded Python -console (since SWIG library is linked directly to the GUI library). - -The example of usage: -\code -# update Object browser contents -salome.sg.updateObjBrowser(True) - -# get the active study ID -studyId = salome.sg.getActiveStudyId() - -# get the active study name -studyName = salome.sg.getActiveStudyName() - -# get the selected objects -selCount = salome.sg.SelectedCount() # the number of selected items -for i in range(selCount): - print salome.sg.getSelected(i) # print the entry ID of i-th selected item -\endcode - -\code -# get the list of IDs of all selected objects -selected = salome.sg.getAllSelected() - -# add an object to the selection -salome.sg.AddIObject("0:1:1:1") # "0:1:1:1" is an object ID - -# remove an object from the selection (make it unselected) -salome.sg.RemoveIObject("0:1:1:1") # "0:1:1:1" is an object ID - -# clear the selection (set all objects unselected) -salome.sg.ClearIObjects() - -# display an object in the current view (if possible) -salome.sg.Display("0:1:1:1") # "0:1:1:1" is an object ID -salome.sg.UpdateView() # update view - -# erase an object from the current view -salome.sg.Erase("0:1:1:1") # "0:1:1:1" is an object ID -salome.sg.UpdateView() # update view - -# display all objects in the current view (if possible) -salome.sg.DisplayAll() -salome.sg.UpdateView() # update view - -# erase all objects from the current view -salome.sg.EraseAll() -salome.sg.UpdateView() # update view - -# set top, bottom, front, rear, left, right view -salome.sg.ViewTop() # top view -salome.sg.ViewBottom() # bottom view -salome.sg.ViewFront() # front view -salome.sg.ViewTop() # back view -salome.sg.ViewLeft() # left view -salome.sg.ViewRight() # right view - -# reset the current view -salome.sg.ResetView() - -# get the component symbolic name by its user name -compName = salome.sg.getComponentName("Geometry") # compoName = "GEOM" - -# get the component user name by its symbolic name -compName = salome.sg.getComponentUserName("SMESH") # compoName = "Mesh" - -# ... -\endcode - -*/ diff --git a/doc/salome/gui/input/themes.doc b/doc/salome/gui/input/themes.doc deleted file mode 100755 index d5f459f73..000000000 --- a/doc/salome/gui/input/themes.doc +++ /dev/null @@ -1,42 +0,0 @@ -/*! - -\page themes_page Theme - -The look and feel of the SALOME desktop can be customized by the user -via SALOME style preferences. - -SALOME style prefereces dialog box is used for customization of -the look and feel of SALOME style. To open it, select in the Main menu -View -> Theme item. - -\image html theme1.png - -It is possible to choose a predefined scheme in the list to the left -or to create a custom scheme using the controls to the right. - -The dialog box contains two pages. - -The first page allows specifying the color palette. -- \b Quick button allows automatic color palette definition basing on -the main color specified by the user. - -\image html theme2.png - -The second page allows specifying different properties of the theme: - -- \b Font group allows to edit the font used in menus, dialog boxes, etc. -- \b Lines group allows to apply dashing to Salome elements. -- Widgets rounding allows to round corners of Salome dialog -boxes and define their parameters. -- \b Handle allows to define parameters of the handle. -- Widget effect allows to apply special effects to Salome -dialog boxes. - -If SALOME Theme is not used (Use SALOME Style checkbox is -switched off), the global system settings are applied (for -example, KDE settings). So, the look and feel of the application (for -example, palette and/or font) can be customized by using the Qt utility -qtconfig. - - -*/ diff --git a/doc/salome/gui/input/using_catalog_generator.doc b/doc/salome/gui/input/using_catalog_generator.doc deleted file mode 100644 index d2208a7d2..000000000 --- a/doc/salome/gui/input/using_catalog_generator.doc +++ /dev/null @@ -1,65 +0,0 @@ -/*! - -\page using_catalog_generator_page Using Catalog Generator - -SALOME platform is an open platform for -integration of your custom components, which can used in the same way -as typical modules provided in the standard installed package. The -Catalog Generator tool serves for implementation of the interface of -your custom component. It allows to generate from IDL description of -your component interface its xml description. The component xml -description allows SALOME application to know about the component and -its services and provides the possibility to call the component -services, for example, inside Supervisor module. - -If you have a look at runSalome, -runSalomeWithPort scripts running SALOME application, which are stored -in build/bin directory you will see that SALOME_ModuleCatalog_Server -is started with two xml files as its input parameters: -\b CatalogModuleGeneral.xml and \b CatalogModulePersonnel.xml. These two -files store the descriptions of interfaces and services of all -components, provided with typical SALOME package. To add a new -component into SALOME platform you should either update one of these -existing xml files with generated xml description of your component or -create a new one. - -To open the Catalog Generator: -\par -From the main menu choose Tools > Catalog Generator, the following -dialog box will appear: - -\image html cataloggenerator.png - -
In this dialog box you can specify: -
    -
  • Name and location of the IDL file describing the interface of your -component (Click the \b Browse button to find it using the data tree).
    • -
  • Name and location of an existing XML file, which will be updated -with the interface of you component or name and desired location of a -new XML file, which will be generated (Click the \b Browse button to find -it using the data tree).
    • -
  • Name of the author.
    • -
  • Name of the component.
    • -
  • Name of the user.
    • -
  • Version.
    • -
  • Capability of multi study support.
    • -
  • Type of the component.
    • -
  • Icon of your component (Click the \b Browse button to find it using -the data tree).
    • -
- -\note If you have chosen to create a new xml file containing the -description of your component, don't forget to specify it as -input parameter for SALOME_ModuleCatalog_Server in the file, you are -using as a running script of SALOME platform (in runSalomeWithPort, -for example). - -When launching SALOME next time you will see your module alongside other components. - -\b Tip: You can use the Catalog Generator tool, if you would like to \b -test the functionality of your new component. After implementation of -your component interface, launch SUPERVISION module where you can try -using the services of your new component. (see also: Adding factory -nodes) - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/using_find_tool.doc b/doc/salome/gui/input/using_find_tool.doc deleted file mode 100644 index add541a3b..000000000 --- a/doc/salome/gui/input/using_find_tool.doc +++ /dev/null @@ -1,76 +0,0 @@ -/*! - -\page using_find_tool_page Using Find Tool - -The Object Browser is supplied with the \b Find toolbox. This tool -allows performing context search of the items in the Object Browser: - -\image html findtool1.png - -The \b Find toolbox can be invoked in several ways: -- Pressing \a <Ctrl>-<F> key combination starts a new -search; the text previously input by the user in the edit control of -the \b Find toolbox is automatically selected. -- Pressing \a </> (slash) key starts a new search; the text -previously input by the user is cleared. -- Pressing \a <F3> key repeats the previous search in the forward -direction (from top to bottom). -- Pressing \a <Shift>-<F3> key repeats the previous search in -the backward direction (from bottom to top). -- Activating \a Find command from the Object Browser context popup -menu starts a new search (the same as \a <Ctrl>-<F>). - -Pressing \a <Escape> key closes the \b Find toolbox. - -The search is always started from the first selected item in -the Object Browser. If there are no selected items, the search is -started from the top of the Object Browser contents. If there is an -item which satisfies the search conditions, it is selected and the -Object Browser is expanded to show this item (if it is collapsed). - -The \b Find toolbox provides a set of widgets which are used to -perform the search operations or change the search conditions: -- \a "Close" button closes the \b Find toolbox. -- Line edit box is used to input the searched text. Note that the -search is always done by the object name, i.e. by the data displayed -in the "Name" column of the Object Browser. -- \a "Find first item" button searches the very first item -which satisfies the search conditions. -- \a "Find previous item" button searches the previous item -which satisfies the search conditions. -- \a "Find next item" button searches the next item -which satisfies the search conditions. -- \a "Find last item" button searches the very last item -which satisfies the search conditions. -- \a "Case sensitive" check box allows performing case sensitive -search. -- \a "Regular Expression" check box allows performing the search of the -items by the regular expression, for example: - - Face - matches all faces - - Face_[\\d] - matches Face_1, Face_2, etc.. (all faces) - - Face_[\\d]$ - matches Face_1, Face_2, but does not match Face_11, Face_12. - - ^Face_[\\d]$ - the same as above - - ^ Face_[\\d]$ - matches nothing - -- \a "Wrap search" check box: if checked and the search -reaches the last item, satisfying the search conditions, pressing \a "Find -Next" button moves the selection to the very first item which matches -the search conditions (i.e. a cyclic search is performed). - -If there are no items satisfying the search -conditions in the Object Browser, the edit control of the \b Find toolbox becomes -red-colored: - -\image html findtool2.png - -The \b Find toolbox also has an auto-hiding feature. This works as -follows: -- If the input focus is inside the \b Find toolbox, auto-hiding is -automatically deactivated. -- If the input focus moves outside the \b Find toolbox, it hides -automatically in 10 seconds after the last search operation (which can -be done by clicking \a "Find Next", \a "Find Previous" button, or typing -something in the edit field); each new search operation -restarts the auto-hide timer. - -*/ diff --git a/doc/salome/gui/input/using_input_widgets.doc b/doc/salome/gui/input/using_input_widgets.doc deleted file mode 100755 index bf0d0d8e4..000000000 --- a/doc/salome/gui/input/using_input_widgets.doc +++ /dev/null @@ -1,64 +0,0 @@ -/*! - -\page using_input_widgets_page Using input widgets - -This section contains some hints that might be useful when working -with SALOME GUI input widgets. - -

Spin boxes

- -This type of widgets is used for numeric (integer or floating-point) -data input. Spin boxes are used in standard \b SALOME modules if the -input value has a clearly defined input range (and precision in -case of a floating-point value). - -Input precision has a specific semantics in \b SALOME floating-point -spin boxes: -- Positive precision value means that a number in the fixed-point format -(corresponding to the "f" format specifier for C printf function) is -expected. Positive precision value is the maximum allowed number of -digits after the decimal separator. -- Negative precision value means that a number either in the fixed-point -or the scientific (exponetial) format is expected. This is similar to the -behavior of the "g" format specifier for C printf function. Negative -precision value is the maximum allowed number of significant digits in -mantissa (note that one digit is always before the decimal separator). - -To make the user aware of an input value constraints applied by some -\b SALOME operations, the following basic capabilties are provided by -spin boxes: -- The text input manually in a spin box by the user is checked to be a -number of valid type (integer or floating-point). -- The text is converted to a number and checked to be within the valid -range. -- Additionally, for floating-point data the input text is checked -against the precision rules described above. - -If the input text in a spin box does not meet the -constraints, the user is shown a message in a -tooltip near the spin box just as he types in it. The tooltip contains -information about the valid data range. For a floating-point input, the -tooltip also contains information about the expected precision. - -In standard \b SALOME modules the precision value can be adjusted through -\ref setting_preferences_page "user preferences" of the correspodning modules, and the tooltip contains a -reference to the corresponding parameter in the preferences. - -On-line documentation for each standard SALOME module contains the -list of user preferences that can be used for tuning floating-point -precision for different types of input quantities. - -

Spin boxes and SALOME Notebook

- -Apart from the numeric input, spin boxes in some \b SALOME modules accept -the names of \b Notebook variables (see \ref using_notebook "Using Notebook" -page for more details about \b Notebook). - -If a spin box accepts variable names, then it is -additionally checked whether the manually input text represents a variable name. Variable -names should comply with the common naming rules for \b Python variables. -If the input is neither a valid number nor a variable name, -the tooltip informs the user that variable names are also acceptable in this spin box. - - -*/ diff --git a/doc/salome/gui/input/using_notebook.doc b/doc/salome/gui/input/using_notebook.doc deleted file mode 100644 index ea7e81eeb..000000000 --- a/doc/salome/gui/input/using_notebook.doc +++ /dev/null @@ -1,40 +0,0 @@ -/*! - -\page using_notebook Using NoteBook - -SALOME NoteBook allows to predefine numerical and boolean -parameters (variables). - -By default, the NoteBook is located in a tabbed widget to the left (shared with the Object Browser). - -\image html notebook1.png - -To hide/show this tab choose View > Windows > Notebook. - -Here you can add new variables, remove and rename existing variables and -change their values. - -If you have modified some variables, which are already used in the current -study, you should click Update Study button to apply your changes -to the study. - -\note The study can not be updated until at least one of the variables in -the table has an invalid name or value (marked by red color). The names of -variables should be unique and their values should be numerical (integer or -double) or boolean ("True" / "False"). - -Here is an example of setting variables in python scripts: -\code -import salome_notebook - -notebook = salome_notebook.notebook - -notebook.set("Length", 100) -notebook.set("Radius", 37.5) -notebook.set("Flag", True) -\endcode - -Later these values can be used as parameters for any operations in -various components. - -*/ diff --git a/doc/salome/gui/input/using_object_browser.doc b/doc/salome/gui/input/using_object_browser.doc deleted file mode 100644 index d147ad329..000000000 --- a/doc/salome/gui/input/using_object_browser.doc +++ /dev/null @@ -1,52 +0,0 @@ -/*! - -\page using_object_browser_page Using Object Browser - -The Object Browser in SALOME is destined for displaying the -structure of the current study in a tree-like form. It contains: - -
    -
  • components, loaded during the current session
    • -
  • objects created with the help of different components (The objects -created with the help of a definite component are located in the -folder having the name of this component) -
    • -
  • references to different objects (they are highlighted in red)
    • -
- -\image html objectbrowser1.png - -\note The Object Browser is destined to getting quick access to -different objects created during SALOME session. All pop-up menus -associated with the objects displayed in the Object Browser are -context-sensitive. So it depends on a definite currently loaded SALOME -component what options you will see in the pop-up menu, if you -right-click on a definite object in the Object Browser. - -The Object Browser may contain supplementary attributes of the objects -displayed in additional columns. By default, these columns are not -displayed - displaying/hiding these columns is possible through -\ref setting_preferences_page "setting study preferences" or -right-clicking on the attributes bar and toggling the necessary -attributes. - -\image html objectbrowser2.png - -- \b Name; -- \b Entry - Identification index of the object in the structure of the study; -- \b IOR - Interoperable Object Reference; -- Reference entry - Identification index of the references to the objects; -- \b Value - Displays the value of the first object attribute. - -\note Entry, IOR and Reference entry attributes are displayed for debugging purposes only. - -

Sorting

- -By default the objects in the object browser are sorted in the creation order. -\n -However, it is possible to enable sorting in the alphabetical order (or the reverse alphabetical order) by right clicking in the header of the tree (near the \b Name field) and checking "enable sorting" in the context menu. -\n -It is possible to use the arrow near "Name" to reverse the order. -If "enable sorting" is unchecked, the objects are sorted in the default order again. - -*/ diff --git a/doc/salome/gui/input/using_pluginsmanager.doc b/doc/salome/gui/input/using_pluginsmanager.doc deleted file mode 100644 index bff116f05..000000000 --- a/doc/salome/gui/input/using_pluginsmanager.doc +++ /dev/null @@ -1,208 +0,0 @@ -/*! - -\page using_pluginsmanager Extend SALOME gui functions using python plugins - --# \ref S1_SALOMEPLUGINS --# \ref S2_SALOMEPLUGINS --# \ref S3_SALOMEPLUGINS --# \ref S4_SALOMEPLUGINS --# \ref S5_SALOMEPLUGINS - -\section S1_SALOMEPLUGINS Objectives - -The SALOME python plugin manager allows the end user to extend the -graphic interface of SALOME with custom functions written as python -modules. The screenshots below show the example of a tool that creates -a mesh from a set of geometrical parameters with the support of -simple graphical interface: - -The default menu for plugins is "Tool->Extensions": -\image html SALOME_pythonplugins_menu.png - -In this example, the plugin provides a small interface to input the -parameters (not provided by the plugin manager): -\image html SALOME_pythonplugins_dialog.png - -Then creates the mesh model: -\image html SALOME_pythonplugins_result.png - -In this example, the end user has to write: - --# the python script that creates the mesh from the parameters, using - the GEOM and SMESH python interface, as in a classic use case, --# the dialog box in PyQt to input the parameters, --# the file salome_plugins.py that declares the plugins. - -This page explains only the last point. - -\section S2_SALOMEPLUGINS Principles - -The general form of the file salome_plugins.py is: - -\code -import salome_pluginsmanager - -# Creation of the plugin -def myplugin1(context): - ... - # Here is the code of the plugin myplugin1 - ... - -def myplugin2(context): - ... - # Here is the code of the plugin myplugin2 - ... - -# Declaration of the plugins to the pluginsmanager -salome_pluginsmanager.AddFunction('My plugin n°1', 'This action runs the plugin n°1', myplugin1) -salome_pluginsmanager.AddFunction('My plugin n°2', 'This action runs the plugin n°2', myplugin2) -... -\endcode - -The procedure is to define a function that implements the plugin, and -to declare this function to the plugins manager. The implementation -can be very variable. It is advisable to consider this function as a -proxy to your code that you can manage in a python package -installed in the standard SALOME python directories. - -In this code, the variable "context" is automatically transmitted by -the pluginmanager when you request the plugin. This context provides -you with at least the following attributes: - -\code -activeStudy = context.study -salomegui = context.sg -\endcode - -Once written, this script salome_plugin.py has to be moved to a -specific place on your filesystem where SALOME is programmed to search -for plugins. The possible directories are (in search order): - --# The directory <*_ROOT_DIR>/share/salome/plugins/, when - this plugin is developped in the framework of a SALOME module - (<*_ROOT_DIR> is the root installation directory of the module, and - is the name of the module in low letters). --# The directory ~/.config/salome/Plugins for personnal end user - plugins. --# Any path in the shell variable SALOME_PLUGINS_PATH (each path must be - separated by a comma ":" for unix and ";" for windows). This - variable should be set and exported before running the SALOME application. - -\section S3_SALOMEPLUGINS A complete example - -Suppose that you write a SALOME script that creates a trihedron for each of -your studies (a simple and standard SALOME script, that every end user -is capable to write if he reads the documentation and follows the -training course): - -\code -# Intialize the geompy factory with the active study -import salome -import GEOM -from salome.geom import geomBuilder -geompy = geomBuilder.New(salome.myStudy) - -# Create the objects -Vx = geompy.MakeVectorDXDYDZ(10, 0, 0) -Vy = geompy.MakeVectorDXDYDZ(0, 10, 0) -Vz = geompy.MakeVectorDXDYDZ(0, 0, 10) -origin = geompy.MakeVertex(0, 0, 0) - -# Register the objects in the active study -geompy.addToStudy( Vx, "Vx" ) -geompy.addToStudy( Vy, "Vy" ) -geompy.addToStudy( Vz, "Vz" ) -geompy.addToStudy( origin, "origin" ) -\endcode - -The job consists in creating the file salome_plugins.py as follows: - -\code -import salome_pluginsmanager -def trihedron(context): - import GEOM - from salome.geom import geomBuilder - geompy = geomBuilder.New(salome.myStudy) - # Intialize the geompy factory with the active study - activeStudy = context.study - geompy.init_geom(activeStudy) - # Create the objects - Vx = geompy.MakeVectorDXDYDZ(10, 0, 0) - Vy = geompy.MakeVectorDXDYDZ(0, 10, 0) - Vz = geompy.MakeVectorDXDYDZ(0, 0, 10) - origin = geompy.MakeVertex(0, 0, 0) - # Register the objects in the active study - geompy.addToStudy( Vx, "Vx" ) - geompy.addToStudy( Vy, "Vy" ) - geompy.addToStudy( Vz, "Vz" ) - geompy.addToStudy( origin, "origin" ) - -# Register the function in the plugin manager -salome_pluginsmanager.AddFunction('O,Vx,Vy,Vz', - 'Creates the trihedron', - trihedron) - -\endcode - -Move this script in the directory -~/.config/salome/Plugins, run SALOME and enjoy your new function. - -\section S4_SALOMEPLUGINS How to select an object of the object browser - -Sometimes it can be useful to retrieve an object of the object browser to perform -an action on it, for example, to select a mesh and display some information related to it. - -Some important methods and objects to use are as follows: --# context.sg.getObjectBrowser(): to connect the signal event - `selectionChanged()` to a custom slot --# context.salome.sg.getAllSelected(): to get the list of selected object - in the object browser --# objId = context.salome.sg.getSelected(0): - to get the first selected object in the object browser --# salomeObj = context.salome.study.FindObjectID(objId).GetObject(): - to retrieve the salome object from selection. It can be a GEOM, SMESH, or any - other module object. - - If it is a mesh, then it is possible to call methods of the SMESH::SMESH_Mesh interface - on the object, for example GetShapeToMesh(). - If it is not a mesh, this call will raise an exception. - So it is possible to write the code retrieving the shape a mesh is built on in the following way: -\code -mesh = None -try: - shape = salomeObj.GetShapeToMesh() -except: - print "The selection is not a mesh" -\endcode - -An example of those methods is available with the demo examples. -See the next chapter \ref S5_SALOMEPLUGINS. - -\section S5_SALOMEPLUGINS Other examples - -The GUI module provides you with some basic demo examples located in -the directory src/SalomeApp/pluginsdemo of the source space and -installed in the directory $GUI_ROOT_DIR/share/salome/plugins/gui/demo. - -\note These examples are automatically installed when you install the GUI -but are not activated. To activate the plugins, edit the file -$GUI_ROOT_DIR/share/salome/plugins/gui/demo/salome_plugins.py and turn the -variable DEMO_IS_ACTIVATED to True. - -The demo examples are: --# \b trihedron: create a trihedron and display it with fit on the size --# \b tube_shapewithgui: create a geom object from parameters given by a - dialog box. --# \b tube_meshwithgui: create a mesh object from parameters given by a - dialog box. This illustrates that a plugin can work with more than - one SALOME module. --# \b tube_shapewithguiAndPreview: same than tube_shapewithgui but with - an additionnal preview function (button apply in the dialog box). --# \b runSalomeShellSession: run a SALOME prepared shell session in a - xterm. --# \b minmax: computes the min and max values of a control on a selected mesh. - \note This plugin is available in the SMESH module only. To activate it, edit - the file $GUI_ROOT_DIR/share/salome/plugins/gui/demo/smesh_plugins.py and turn the variable - DEMO_IS_ACTIVATED to True. - -*/ diff --git a/doc/salome/gui/input/using_registry_tool.doc b/doc/salome/gui/input/using_registry_tool.doc deleted file mode 100644 index a652a78ea..000000000 --- a/doc/salome/gui/input/using_registry_tool.doc +++ /dev/null @@ -1,49 +0,0 @@ -/*! - -\page using_registry_tool_page Using Registry tool - -\b Registry tool is in the SALOME platform is destined for providing -information about the processes (components), which have ever been -launched in the current study session. - -To view the Registry: -\par -From the main menu choose Tools > Registry display, the -following dialog box will appear: - -\image html registry1.png - -\b Running tab of this dialog box displays a list of the currently -started processes (components) with supplementary information on each -of them divided into columns: - -
    -
  • \b Component: name of the started component -
  • \b PID: process identification number -
  • \b User \b Name: name of the user launching the component -
  • \b Machine: name of the machine, on which the process has been started -
  • \b begins: date and time of the starting of the component -
  • \b hello: date and time of the last call to the component -
- -\b History tab displays a list of all processes, which have ever been -launched within this study session. It contains the same supplementary -information on each of the processes (components). - -\b Refresh button allows to refresh the current list of processes -(components). - -\b Interval button allows to set an interval for refreshment of the -current list of processes (components). - -\image html registry3.png - -To display complete information on a definite process -(component): -\par -Double-click on this process (component). The following window will -appear: - -\image html registry4.png - -*/ \ No newline at end of file diff --git a/doc/salome/gui/input/viewers_chapter.doc b/doc/salome/gui/input/viewers_chapter.doc deleted file mode 100644 index 8b07f1cdf..000000000 --- a/doc/salome/gui/input/viewers_chapter.doc +++ /dev/null @@ -1,38 +0,0 @@ -/*! - -\page viewers_page Viewers - - - -SALOME GUI module includes several 2D and 3D viewers, that are used for -different purposes within the platform: - -- \subpage occ_3d_viewer_page has been developed on -the basis of Open CASCADE Technology (http://www.opencascade.org). -This is the default viewer for SALOME Geometry module, it provides good -representation of construction and transformation of geometrical objects. - -- \subpage vtk_3d_viewer_page has been developed -basing on Kitware Visualization ToolKit library (http://www.vtk.org). -This is the default viewer for SALOME Mesh module, where it is used -for visualization of meshes. - -OCC and VTK 3d viewers share some \subpage common_functionality_page "common functionality". - -- \subpage plot2d_viewer_page has been developed -basing on the open-source Qwt library (http://qwt.sourceforge.net). -It can be used, for example, for the representation of 2D plots and graphs. - -- \subpage gl_2d_viewer_page is a general purpose -OpenGL-based viewer, which can be used for visualization of 2D -scenes. This type of viewer is not currently used in SALOME platform -directly, but can be used in custom modules for 2D visualization purposes. - -- \subpage qxscene_2d_viewer_page has been -developed on the basis of Qt QGraphicsView scene. This viewer is used -in SALOME YACS module for visualization of computation schemes. - -- \subpage python_viewer_page is an editor for Python scripts. - - -*/ diff --git a/doc/salome/gui/input/vtk_3d_viewer.doc b/doc/salome/gui/input/vtk_3d_viewer.doc deleted file mode 100644 index 0905cb397..000000000 --- a/doc/salome/gui/input/vtk_3d_viewer.doc +++ /dev/null @@ -1,279 +0,0 @@ -/*! - -\page vtk_3d_viewer_page VTK 3D Viewer - -

Operations

- -The functionalities of VTK 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 html vtkviewer_toolbar.png -
- -\image html vtk_view_camera_dump.png - -Dump View - exports an object snap-shot from the viewer in bmp, png or jpeg image format. -
- -\image html vtk_view_style_switch.png - -Interaction style switch - allows to switch between "Salome -standard controls" and "Keyboard free" \ref viewer_navigation_modes "interaction styles". - -
- -\image html vtk_view_zooming_style_switch.png - -Zooming style switch - allows to switch between standard -(zooming at the center of the view) and advanced (zooming at the -current cursor position) zooming styles. The second mode is available -only for parallel (non-perspective) view's mode. -
- -\image html vtk_view_highlight.png - -These buttons allow switching between three pre-selection (highlighting) modes: -- Static pre-selection mode - pre-selection is done in terms of bounding boxes; -- Dynamic pre-selection mode - pre-selection is done in terms of cells, i.e. an object can be selected by clicking the point/cell belonging to this object. This mode causes some performance loss. It is advisable to switch dynamic pre-selection off to have a good performance on big objects (for example, huge meshes); -- Disable pre-selection - pre-selection is disabled. - -
- -\image html vtk_view_selection.png - -Enable/Disable selection - enables or disables selection in the view. -
- -\image html vtk_view_triedre.png - -Show/Hide Trihedron - shows or hides coordinate axes. -
- -\image html vtk_view_fitall.png - -Fit all - scales the presentation so that it could fit within -the Viewer boundaries. -
- -\image html vtk_view_fitarea.png - -Fit area - resizes the view to place in the visible area only -the contents of a frame drawn with pressed left mouse button. -
- -\image html vtk_view_fitselection.png - -Fit selection - fits view contents to the current selection. -
- -\image html vtk_view_zoom.png - -Zoom - allows to zoom in and out. -
- -\image html vtk_view_pan.png - -Panning - if the represented objects are greater that the -visible area and you do not wish to use Fit all functionality, -click on this button to drag the scene to see its remote parts. -
- -\image html vtk_view_glpan.png - -Global panning - allows to select a point to be the center of -the presentation showing all displayed objects in the visible area. -
- -\image html vtk_view_rotation_point.png - -Change rotation point - allows to to choose the point around -which the rotation is performed. - -\image html set_rotation_point_dialog1.png - -By default the rotation point is located in the Center of the bounding -box of an object. - -\image html set_rotation_point_dialog3.png - -Unchecking Use Bounding Box Center check-box allows you to -define the coordinates of the rotation point manually. - -- Set to Origin button restores the default rotation point - coordinates. - -- Gravity Center of Selected Object button allows using the gravity center of the object selected in the viewer as the center of the rotation point. -When you click this button, you should first choose the type of selectable object: Point, Edge, Face or Solid and only then proceed with selection in the viewer. - -
- -\image html vtk_view_rotate.png - -Rotation - allows to rotate the selected object using the -mouse. -
- -\image html vtk_view_front.png -\image html vtk_view_back.png -\image html vtk_view_top.png -\image html vtk_view_bottom.png -\image html vtk_view_left.png -\image html vtk_view_right.png - -These buttons orientate the scene strictly about coordinate axes: -\b Front, \b Back, \b Top, \b Bottom, \b Left or \b Right side. -
- -\image html vtk_view_anticlockwise.png - -Rotate counter-clockwise - rotates view 90 @htmlonly ° @endhtmlonly counter-clockwise. -
- -\image html vtk_view_clockwise.png - -Rotate clockwise - rotates view 90 @htmlonly ° @endhtmlonly clockwise. -
- -\image html vtk_view_reset.png - -Reset - restores the default position (isometric) of objects in -the scene. -
- -\image html vtk_view_update_rate.png - -Update Rate - allows to define the Update Rate for the -presentations displayed in the viewer. - -\image html updaterate.png - -- Desired Update Rate, FPS - allows to set the target Update - Rate - -- Still Update Rate, FPS - allows to set the Update Rate for - the periods when both the user and the application do not perform - any actions in the viewer - -- Current Update Rate, FPS - shows the Update Rate currently - available on your configuration - -- Number of Cells - shows the number of cells currently in - display - -
- -\image html vtk_view_scaling.png - -Scaling - represents objects deformed (stretched or stuffed) -along the axes of coordinates. -
- -\image html vtk_view_graduated_axes.png - -Graduated axes - allows to define parameters of axes and -graduate them. - -\image html graduatedaxes1.png - -- Axis name - if checked the axis name is displayed in the viewer. - - - Name - allows to redefine the name of the axis. - - - Font - allows to define color and properties of the font of axis name. - -- Labels - if checked the labels are displayed in the viewer.< - - - Number - allows to define the number of labels. - - - Offset - allows to define the distance between labels. - - - Font - allows to define color and properties of the font of labels names. - -- Tick marks - if checked the tick marks are displayed in the viewer. - - - Length - allows to define the length of tick marks. - -- Is visible - if checked the axis is displayed in the viewer. - -
- -\image html vtk_view_parameters.png - -Change View Parameters - this button gives access to the -dialog for customization of various view parameters. - -\image html vtk_view_parameters_dlg.png - -- Projection Mode - switches between the \b Orthogonal and \b Perspective projection modes. - -- Focal Point - allows to specify the focal point of the view - - - Set to Bounding Box Center - chooses the center of the - bounding box of the current scene as the focal point; - - Set to Origin - chooses the global coordinates system origin as - the focal point; - - Select Point from View - allows to specify the focal point by the - direct selection of a point in the view window; - - X, Y, Z - allows to input the coordinates of the focal - point directly. - -- Camera Position - allows to specify the position of the view camera: - - Absolute Coordinates - in absolute coordinates; - - Relative to Focal Point - as a offset to the focal point; - - Projection Direction - allows specify the direction of the - projection vector; - - Focal Distance - the focal distance value. - -- View Up Direction - direction of the "view up" vector. - -- Zooming - - - \b Scale - the current zoom factor (available in the Orthogonal - mode only); - - View Angle - the current view angle (available in the Perspective - mode only). - -
- -\image html vtk_view_sync.png - -Synchronize view - allows to synchronize 3d view -parameters. This button has two states - checked and -unchecked. Clicking on this button opens a drop-down menu listing -compatible 3d views. When a view is selected in the list , the parameters (view point, position, zoom coefficient, etc.) of the current view are synchronized with the selected view (static -synchronization). - -In addition, when this button is "checked", the -views are synchronized dynamically, i.e. any zoom, pan, rotate -or other view operation done in one view is automatically applied to the other view. -
- -\image html vtk_view_parallel.png - -Orthogonal mode - Switches the view to the orthogonal mode. -
- -\image html vtk_view_perspective.png - -Perspective mode - Switches the view to the perspective mode. -
- -\image html vtk_view_recording_start.png -\image html vtk_view_recording_play.png -\image html vtk_view_recording_pause.png -\image html vtk_view_recording_stop.png - -These buttons allow recording viewing operations as a video file in -the AVI format using external software (jpeg2yuv): - -- Start recording - specify parameters and start recording; - -- Pause recording - suspend recording; - -- Continue recording - resume recording; - -- Stop recording - stop recording. - -*/ diff --git a/doc/salome/gui/input/working_with_python_scripts.doc b/doc/salome/gui/input/working_with_python_scripts.doc deleted file mode 100644 index 1b54bc87e..000000000 --- a/doc/salome/gui/input/working_with_python_scripts.doc +++ /dev/null @@ -1,28 +0,0 @@ -/*! - -\page python_interpreter_page Python Interpreter - -\b SALOME Platform can be launched in the batch mode, without Graphical -User Interface, and operated with the use of Python scripts, which can -fulfill most of the necessary tasks, however, the process of scripting -is quite time consuming and rather error-prone. -\n This problem has been resolved by the possibility to automatically -generate a set of Python scripts from data created with SALOME GUI, -which greatly increases the productivity of using SALOME platform in -the batch mode. This mechanism can convert a SALOME Study in one or -several Python scripts, which can be stored and imported later to -re-create the content of the original study. The first script is a -SALOME document, which re-creates the SALOME Study, adds the -stored Salome components to the SALOME and automatically calls -Python scripts of the second type containing component specific Python -function calls. This architecture gives great flexibility in manual -modification of the generated scripts because you can modify only one -of the component specific Python scripts without touching others, thus -avoiding expert knowledge of Python API of unused components. - -To Dump a SALOME Study in one or several scripts, in the main menu -select \b File --> Dump study. -Reversibly, it is possible to load a saved Python Script selecting in -the main menu \b File -> Load Script. - -*/ diff --git a/doc/salome/gui/static/footer.html b/doc/salome/gui/static/footer.html deleted file mode 100755 index 7cf11feba..000000000 --- a/doc/salome/gui/static/footer.html +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - diff --git a/doc/salome/gui/static/header.html.in b/doc/salome/gui/static/header.html.in deleted file mode 100755 index 3603a0545..000000000 --- a/doc/salome/gui/static/header.html.in +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - -$projectname: $title -$title - - - -$treeview -$search -$mathjax - -$extrastylesheet - - -
- -
Version: @SALOMEGUI_VERSION@
- diff --git a/doc/salome/gui/static/salome_extra.css b/doc/salome/gui/static/salome_extra.css deleted file mode 100644 index 3e8b838a6..000000000 --- a/doc/salome/gui/static/salome_extra.css +++ /dev/null @@ -1,29 +0,0 @@ -/* The extra CSS for doxygen 1.8.3.1 */ - -#titlearea { - background-image:url('head.png'); - background-color: #175783; - border: 1px solid; - height: 80px; - background-repeat: no-repeat; - padding: 0px; - margin: 0px; - width: 99.9%; - border-bottom: 1px solid #5373B4; -} - -div.version { - border:1px solid #0000FF; - color: #CCCCCC; - font-family: Arial, Helvetica, sans-serif; - font-size: 9pt; - text-align: center; - width:100px; - -moz-border-radius: 8px; - margin: 5px; -} - -.navpath li.footer { - line-height:15px; - text-align: right; -} \ No newline at end of file diff --git a/doc/salome/gui/static/switchers.js b/doc/salome/gui/static/switchers.js index c27115a9b..30246d021 100644 --- a/doc/salome/gui/static/switchers.js +++ b/doc/salome/gui/static/switchers.js @@ -43,7 +43,7 @@ var new_url = url.replace('/gui/GUI' + current_suffix + current_language, '/gui/GUI' + selected_suffix + selected_language); if (new_url != url) { - window.open(new_url); + window.location.href = new_url; } } diff --git a/src/LightApp/CMakeLists.txt b/src/LightApp/CMakeLists.txt index de54a1970..d5fbf93cb 100755 --- a/src/LightApp/CMakeLists.txt +++ b/src/LightApp/CMakeLists.txt @@ -227,6 +227,8 @@ SET(_other_RESOURCES resources/icon_module.png resources/icon_module_big.png resources/icon_select.png + resources/icon_earth.png + resources/icon_life_ring.png resources/LightApp.ini resources/LightApp.xml ) diff --git a/src/LightApp/LightApp_Application.cxx b/src/LightApp/LightApp_Application.cxx index 529725ad4..7e0661fb6 100644 --- a/src/LightApp/LightApp_Application.cxx +++ b/src/LightApp/LightApp_Application.cxx @@ -603,13 +603,47 @@ void LightApp_Application::createActions() int helpMenu = createMenu( tr( "MEN_DESK_HELP" ), -1, -1, 1000 ); createMenu( separator(), helpMenu, -1, 10 ); + + // Site && forum + int id = LightApp_Application::UserID + FIRST_HELP_ID; + + QString site = tr ( "SALOME_SITE" ); + QAction* as = createAction( id, site, + resMgr->loadPixmap( "LightApp", tr( "ICON_WWW" ), false ), + site, site, + 0, desk, false, this, SLOT( onHelpOnline() ) ); + as->setData( "salome-platform.org" ); + createMenu( as, helpMenu, -1, 0 ); + id++; + + QString forum = tr ( "SALOME_FORUM" ); + + QAction* af = createAction( helpMenu, forum, + resMgr->loadPixmap( "LightApp", tr( "ICON_WWW" ), false ), + forum, forum, + 0, desk, false, this, SLOT( onHelpOnline() ) ); + af->setData( "salome-platform.org/forum" ); + createMenu( af, helpMenu, -1, 0 ); + id++; + + createMenu( separator(), helpMenu, -1, 0 ); + + // YouTube channel + QString video = tr ( "SALOME_VIDEO_TUTORIALS" ); + QAction* av = createAction( helpMenu, video, + resMgr->loadPixmap( "LightApp", tr( "ICON_LIFE_RIGN" ), false ), + video, video, + 0, desk, false, this, SLOT( onHelpOnline() ) ); + av->setData( "not-created-yet.com" ); + createMenu( av, helpMenu, -1, 0 ); + id++; + + QStringList aModuleList; modules( aModuleList, false ); aModuleList.prepend( "GUI" ); aModuleList.prepend( "KERNEL" ); - int id = LightApp_Application::UserID + FIRST_HELP_ID; - QString aModule; foreach( aModule, aModuleList ) { if ( aModule.isEmpty() ) // module title (user name) @@ -1097,16 +1131,23 @@ public: const QString& theApp, const QString& theParams, const QString& theHelpFile, - const QString& theContext = QString() ) + const QString& theContext = QString(), + //For the external browser always specify 'file://' protocol, + //because some WEB browsers (for example Mozilla Firefox) can't open local file without protocol. + const QString& theProtocol = QString("file://"), + const bool isFile = true) : myApp( theApp ), myParams( theParams ), myContext( theContext ), myStatus(0), myLApp( app ) { - //For the external browser always specify 'file://' protocol, - //because some WEB browsers (for example Mozilla Firefox) can't open local file without protocol. - myHelpFile = QString("file://%1").arg( QFileInfo( theHelpFile ).canonicalFilePath() ); + QString path_begin = theProtocol+"%1"; + QString path_end = theHelpFile; + if( isFile ) { + path_end = QFileInfo( theHelpFile ).canonicalFilePath(); + } + myHelpFile = path_begin.arg( path_end ); } virtual void run() @@ -1261,6 +1302,57 @@ void LightApp_Application::onHelpContextModule( const QString& theComponentName, } } +/*! + SLOT: Displays help contents for choosen module +*/ +void LightApp_Application::onHelpOnline() +{ + const QAction* a = (QAction*) sender(); + QString url = a->data().toString(); + if ( url.isEmpty() ) return; + + SUIT_ResourceMgr* resMgr = resourceMgr(); + QString platform; +#ifdef WIN32 + platform = "winapplication"; +#else + platform = "application"; +#endif + QString anApp = resMgr->stringValue("ExternalBrowser", platform); +#ifdef WIN32 + QString quote("\""); + anApp.prepend( quote ); + anApp.append( quote ); +#endif + QString aParams = resMgr->stringValue("ExternalBrowser", "parameters"); +#if DISABLE_QTXWEBBROWSER + bool useExtBrowser = true; +#else + bool useExtBrowser = resMgr->booleanValue("ExternalBrowser", "use_external_browser", false ); +#endif + + if( useExtBrowser ) { + if ( !anApp.isEmpty() ) { + RunBrowser* rs = new RunBrowser( this, anApp, aParams, url, "", "http://", false ); + rs->start(); + } + else { + if ( SUIT_MessageBox::question( desktop(), tr( "WRN_WARNING" ), tr( "DEFINE_EXTERNAL_BROWSER" ), + SUIT_MessageBox::Yes | SUIT_MessageBox::No, + SUIT_MessageBox::Yes ) == SUIT_MessageBox::Yes ) + + showPreferences( tr( "PREF_APP" ) ); + } + } + else { + QStringList parameters; + parameters << QString( "--language=%1" ).arg( resMgr->stringValue( "language", "language" ) ); + parameters << QString( "--add=%1" ).arg( QApplication::instance()->applicationPid() ); + parameters << "http://" + url; + QProcess::startDetached( "HelpBrowser", parameters ); + } +} + /*! Sets enable or disable some actions on selection changed. */ diff --git a/src/LightApp/LightApp_Application.h b/src/LightApp/LightApp_Application.h index cd9ce2e15..3b41aeceb 100644 --- a/src/LightApp/LightApp_Application.h +++ b/src/LightApp/LightApp_Application.h @@ -198,6 +198,7 @@ signals: public slots: virtual void onHelpContentsModule(); + virtual void onHelpOnline(); virtual void onHelpContextModule( const QString&, const QString&, const QString& = QString() ); virtual void onNewDoc(); virtual void onOpenDoc(); diff --git a/src/LightApp/resources/LightApp.xml b/src/LightApp/resources/LightApp.xml index 7b75d6c7c..5e9e844ab 100644 --- a/src/LightApp/resources/LightApp.xml +++ b/src/LightApp/resources/LightApp.xml @@ -250,7 +250,6 @@
-
diff --git a/src/LightApp/resources/LightApp_images.ts b/src/LightApp/resources/LightApp_images.ts index 98d12bcfc..d8a16f562 100644 --- a/src/LightApp/resources/LightApp_images.ts +++ b/src/LightApp/resources/LightApp_images.ts @@ -31,5 +31,13 @@ APP_MODULE_ICO icon_module.png + + ICON_WWW + icon_earth.png + + + ICON_LIFE_RIGN + icon_life_ring.png + diff --git a/src/LightApp/resources/LightApp_msg_en.ts b/src/LightApp/resources/LightApp_msg_en.ts index fd899055d..9efc62202 100644 --- a/src/LightApp/resources/LightApp_msg_en.ts +++ b/src/LightApp/resources/LightApp_msg_en.ts @@ -46,6 +46,18 @@ CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITASABOUT_VERSION Version %1 + + SALOME_SITE + SALOME Website + + + SALOME_FORUM + SALOME Forum + + + SALOME_VIDEO_TUTORIALS + Video Tutorials + ENTRY_COLUMN Entry diff --git a/src/LightApp/resources/icon_earth.png b/src/LightApp/resources/icon_earth.png new file mode 100755 index 0000000000000000000000000000000000000000..76d691411b5d2cc8f08b8388f1fa441bd7feb257 GIT binary patch literal 1670 zcmV;126_33P)?`i zQldpHN~&mTLFylhq7V!eOo>9Nu?=fuGcidMxBJL$_Pz7GbLT$J@i&{bw$-W~_;QE2 z_ny!B{$6JU-o)qNqfaE4Hri_H;rqP*_Z{)yZtnT%Q=>trd(UvyIXGS|+#Ccl{+BBY zSZww@U85JrbLrm=WmCs~{h?b|-V|WRBfm;FGsX{%vEfg>d!&G>QmCJw#qDn&M>-yp zk3V;j@+kw&et>-w6|5|7Jf;H={PM%M1^*LZf9dF+j%A)Q#>)BF;+mSAtf5x4)#c?) z>~``96vT|@t76g+jUZGh0pay}V#GA&+pXSvPu#U{<_!UvPdvQ4P1+f;vlcIoIwIZb zV()>yvIIe=&%O+y>&T>ZnNH}W$22JwsHDfRwAq&9PL|I7eWBT1Y3@G##Y1!d2FTrY zIL(%4WX>vx@gZ5fp+;lX5{ikqw1@~nh)p*@F=fcK5vMo*V_QhmESHHhJkNSlf3YS)oY#zPu>#qRpj~%Wx+MPMDXIN<%V^ul&wj0Rg zXh3>CbN*x#!1QfcR$~nF>Px7BreNQ7HrMj?i*>mEsUtLq$<3SgMju zZ2_!=E=(h);v@uTS$V+#;ERQZt9I4$m|AX%=gwXf?Ta%f+{f-ebUg=Oc(jlC#W+?s zgkG?q;<}7E4kaoMG8J~<*i^C8TYzlRUiGkJC$&&ft!&}xOAGSs)OqS$ znZN2k`A|*ZT^~%~J^OoDTUS`yP`YD7M4THvq4aVIsY+249b1+1SrplYl`=$1k10(I z2vYU@5RGnM$RJRoB^!UNzbr04Uxz!l7)HmxqYHY+orWB_$-{U};ld?>ZV$TS$YeQB zzS3Zni!xobslb3d7eLlb$fQ1SKx{yg$KAZ?_GPQpp_|z8=@+la^m{_AtO2?q$uvo`vWVqvY2<7&^BH8aCNd02=sIcImI3N9pw;ck=4OjV zxIpITmSt;tmi)EV+3@7iu`Pf&_?2f>&bk$?CUETaoSC6yoW_W*o_2%`tp=_kJXnpvd1@5`|$m3j#kX9q@x6nw5B zo^i=!Qp9-n34J#*}q|2VGc_RqaV z=AFN?3kx@n0Nkab?@OI`ELt5zTw&qbhEzd7BzSTOz6f4o(A1oD;rFk?ZSPTk{`tlm z9XJ{?&II;<@+nO090TV7T<;uP!g>?5w89RWaiYt%R)qQ=euL>V-{bds ztikR#Sw1To0ElI<5?c!c&MOkwg^9hliJkAPx#24YJ`L;(K){{a7>y{D4^000SaNLh0L01m_e01m_fl`9S#00007bV*G`2jT%1 z4loP@BxVQz00oUnL_t(Y$CcG@Y#VnS$MN_5vClp`v3))}$>RJ^)5fAnLkH0aumYV% zCp1kU!Fa$V{tA^!h(19ZLfQjVRcO+NCWI&g@n_ODwDMqLB@v>ctkc?U&AO(`X!B<* zP2>3H_-vo=?7OplJeU}(Pzrn={hoYZ`u%?T{k~rz2m*GC=Xuz+eb_LJKYN~!mQIq^ zQ-XkiB#4M&2vL%DtrvE~cTDr-n^&)Xzqq}Ps;Wd{aoSsJm z1LI@{_6q+Ke)-%Vf|b=9q{j}>+mj`xs)V8{&h;zY{Pq$2x{oV@Jo8Zok3C8wA|X0u zCg<)Kl!*GiBYqIAnMV2S>7NBxPdto%<{9$iqoj2mS(a&e9zilgGMzy0f;+loVwYdx z?T79obnY+c6SFM8^nB21x8L{Ve=Xc*g9{7KrtH(tFuL^*)Rc*1Y~gk3*tH72-@+Fq zR8b}>gVYrznpKIGEwF|K3N^@Ru7T)PqsPRt0m;4jbrCh-4shMu)I&=1TYZ!Tl} z@<)`v^f2yDk!G`rABjOTLe>PWWs%6p==+9==oVY2eoD)0vNJc!;KaUnIV<>`FU#1 zFoo?x03f%0kDXc-_w;Yc4Uf^K#b~_t4wegR#TNe3MUH&q7~{i3NU}`(f%{oMdV#Z# ze22G|myyB->i#(rPn;y%GsLxxO;%P`No#3j$F7vk*Iy-CEs~u2B%)QIS#Pja1L@9b zjy?7yAADmWStdVsi2S)X`T2Lh$>P2bGmziUSmqAYu5S8zeU_G%s8lLt(P_G==JFz{ z55P4Q1#$bCr%--dp`ZWA5yE^c;$DgSIV?J7gbe>$Kx1=k&<2CrBf=P=sgID z1a+m0Lf;_jJ$KVTbtkvWaDN|KDv9Gb_`Z+dYN14;MAR6b=OH_`N8OXT$Ci@nvU(aapfp}0D)1UW!xZbb10ZzyEV;K{WGJVj=JxQ;`~u~K#=*mXL=*)9*Rk;$4zeT?Q50ga7)8UN zRH@!}=e3PhqNkr^&)Q`)yNFOW@JrhWN&UT(>AH?(Su`3=LW)AHJBgC+C6-L{(yt!B zExz>Far6)<-4GX=L zkQloadPixmap( "STD", tr( "ICON_DESK_ABOUT" ) ), tr( "MEN_DESK_HELP_ABOUT" ), tr( "PRP_DESK_HELP_ABOUT" ), Qt::ALT+Qt::SHIFT+Qt::Key_A, desk, false, this, SLOT( onHelpAbout() ) ); diff --git a/src/STD/resources/STD_images.ts b/src/STD/resources/STD_images.ts index e26af0264..ccc6ba2c5 100644 --- a/src/STD/resources/STD_images.ts +++ b/src/STD/resources/STD_images.ts @@ -79,5 +79,9 @@ ICON_FILE_CLOSE close.png + + ICON_DESK_ABOUT + about.png + diff --git a/src/STD/resources/about.png b/src/STD/resources/about.png new file mode 100755 index 0000000000000000000000000000000000000000..25dbd81dff729833d78e808db31aa325196805d0 GIT binary patch literal 459 zcmeAS@N?(olHy`uVBq!ia0vp^5+KaM1|%Pp+x`GjjKx9jP7LeL$-D$|*pj^6T^Rm@ z;DWu&Cj&(|3p^r=85sDEfH31!Z9ZwBAbW|YuPgf_Mln7!?GGg-Pl2X*d%8G=cpN`E zZSSgP2Z7dfSHXkFlsdLf@Y=u`@rz@lr>2wKK`qwsR@yCLG z%Z0C$@~(UR=z*z((*5uEZxzZM&R|$7qBs3?bl(2^|7*qfZn>NH{N^(KrI}ozp@!TN zZH$fr9~f=UH$VS;lEq`vk@pJci+9AWKf~00lL60^l7<5mr{q)Z=Jfg>7}=}*`BXHu-HG?QnEq7sHRJK