From: vsv Date: Fri, 30 Jan 2015 10:26:16 +0000 (+0300) Subject: Update documentation X-Git-Tag: V_1.0.0~1^2~10 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=483bfbf23de070b1b22af99199511a0b9dbef791;p=modules%2Fshaper.git Update documentation --- diff --git a/doc/general_architecture.doc b/doc/general_architecture.doc index b7eaec9d6..73efaa2d7 100644 --- a/doc/general_architecture.doc +++ b/doc/general_architecture.doc @@ -1,83 +1,61 @@ /*! \page general_architecture General Architecture -New GEOM is used either as a stand-alone application or as a Module integrated to the SALOME environment in order to, ultimately, replace the old GEOM. - -

Stand-alone New GEOM

- -When used outside SALOME, New GEOM must be hosted by an application window implementing the general ergonomics of New GEOM (the GUI), including the layout of the user interface, organization of menus, runtime help, etc. -\n -It is proposed that this application window can host several so-called Modules. Below, this main application window is named the Workshop. -\n\n -Each Module hosted by the Workshop deals with one type of document (ModelAPI_Document) only, saved in a format supported by the Module. One document type per Module. Also, in a Workshop window, only one document of a given type can be newed. So, when launching the Workshop, the user selects a type of document to be created. Then, from the application session, creating a new document will launch a new instance of the Workshop. -\n\n -The geometric model (i.e. the whole geometry produce by New GEOM) is created through operations, or features (ModelAPI_Feature), which define a meaningful piece of design (e.g. PartSetPlugin_Part, FeaturesPlugin_Extrusion, FeaturesPlugin_Placement, etc.). In order to easily create dedicated variants of the modeler, also to gradually develop New GEOM, each feature is implemented in a Plug-in (ModelAPI_Plugin, a piece of application including its own GUI, built separately from the application. It is loaded dynamically to the application). In other words, a Module is made of a collection of Plug-ins. -\n\n -The Workshop structures the features by related functionality presented in a tabbed interface. Each tab displays a set of available actions. These sets of features are called below Workbenches. -\n\n -Additionally, a Module can either reference or include other Modules: - - - - -

Application to New GEOM

- -New GEOM is made of one Module, Set of Parts (a Set of Parts is a flat list of Parts, on the contrary of an Assembly in which the Parts are structured), including two other Modules, Part and Properties. The Set of Parts Module produces a PartSet document which references a list of Parts (one document per Part), the PartSet document being referenced by a Properties document (one document per PartSet). -\n\n -The Set of Parts, its Properties and the Parts it references are all edited from the same Workshop window. The Properties and Part documents cannot be open independently of PartSet (the corresponding Modules being available only as included in Set of Parts). +NewGeom is made of Workshop (see XGUI_Workshop) which loads a Module, connecting its features with GUI, providing it with services for launching of operations, tools for user inputs and visualisation of results. The Module can consist of a one or several plug-ins which provide implementation of Module features. Each plug-in can implement one or several features. These features can be structured by Workbenches within Workshop. Workshop provides introducing of these Workbenches within main window in form of menus or/and tool bars. \n -When creating a new PartSet, a Property document is automatically created. The Workbench of the Set of Parts Module includes a feature for creating a new Part. Once the first Part is created, the Workbenches of Part Module are activated. One Part of the ParSet being always active, the features of Part Module apply to this Part. +Workshop interacts with a Module with help of specific interface defined in ModuleBase package. Each module for NewGeom application has to implement ModuleBase_IModile interface. \n -When the user saves its session, all documents are saved: the PartSet, its Properties and each Part. -\n\n -\image html general_architecture_1.png +A Module manages a one document (ModelAPI_Document). This document consists of a one root document and several, loaded by request, sub-documents. Each sub-document can be stored in a single file. \n -Summary of the general architecture of New GEOM: +Main features of the general architecture of New GEOM: +\n\n +\image html general_architecture_1.png +\n\n +For today there is a one implementation of NewGeom module which implements Part Set functionality (PartSet_Module). +The geometric model (i.e. the whole geometry produce by New GEOM) is created through operations, or features (ModelAPI_Feature), which define a meaningful piece of design (see \ref Plugins group). In order to easily create dedicated variants of the modeler, also to gradually develop New GEOM, each feature is implemented in a Plug-in (ModelAPI_Plugin, a piece of application including its own GUI, built separately from the application. It is loaded dynamically to the application). In other words, a Module is made of a collection of Plug-ins. +Each sub-document contains a data of a one Part. When the user saves its session, all documents are saved: the PartSet and each Part. +\n +New GEOM is used either as a stand-alone application or as a Module integrated to the SALOME environment in order to, ultimately, replace the old GEOM. +

Stand-alone New GEOM

+In case of using as a standalone application, Workshop uses an application main window implementing the general ergonomics of New GEOM (see \ref Desktop group), including the layout of the user interface, organization of menus, runtime help, etc. +\n +The Workshop structures the features by related functionality presented in a tabbed panels Workbenches. Each tab displays a set of available actions. These sets of features are called below Workbenches. +\n\n -

New GEOM as SALOME module

-The NewGeom package allows to launch the application as one of the module of SALOME platform. In that case all user interface elements are integrated into SALOME platform: the \b NewGeom package is used for this connection. +

New GEOM as SALOME module

-Initially the New GEOM application is defined as a Light SALOME module, later it may be changed in order to manage the communication with other SALOME modules correctly. +The NewGeom package allows to launch the application as one of the module of SALOME platform. In that case all user interface elements are integrated into SALOME platform: the \ref Salome package is used for this connection. \n To integrate New GEOM into SALOME the next steps are done:
    -
  1. LightApp_Module class from SALOME GUI LightApp package is redefined. This redefined class provides a connection between LightApp_Module interface and Workshop object of the application.
    2. -
  2. Provide Workshop with a module mode of launching in SALOME environment. In this case it is launched without its own main window, 3d viewer and main menu.
    3. -
  3. In module mode workshop uses: +
  4. LightApp_Module class from SALOME GUI LightApp package is redefined (see NewGeom_Module). This redefined class provides a connection between LightApp_Module interface and Workshop object of the application.
    5. +
  5. Provide Workshop with a SALOME mode of launching in SALOME environment. In this case it is launched without its own main window, 3d viewer and main menu.
    6. +
  6. In SALOME mode workshop uses:
    1. SALOME desktop as a main window.
    2. OCC viewer from SALOME platform instead of its own 3d viewer.
      3. -
    3. SALOME main menu and toolbars for creation of workbenches commands.
      4. +
    4. SALOME main menu and tool bars for creation of workbenches commands.
    5. Object Browser of New GEOM application is used instead of SALOME Object Browser.
    6. Creation of a New GEOM property panel as a docking window of SALOME desktop.
      7. -
    7. Use SALOME Python console instead of console in main window. Since 3 packages from SALOME GUI module become shared between this project and SALOME mod-ules and they are independed from other SALOME parts, it is proposed in the future to detach it from SALOME platform into separated prerequisite product to avoid code duplication.
      8. +
    8. Use SALOME Python console instead of console in main window. Since 3 packages from SALOME GUI module become shared between this project and SALOME modules and they are independent from other SALOME parts, it is proposed in the future to detach it from SALOME platform into separated prerequisite product to avoid code duplication.
    7. -
  7. Each workbench will be defined as a menu in main menu bar of SALOME desktop and as a toolbar with corresponded title.
    8. -
  8. Each feature in the workbench will be defined as a menu item in the corresponded menu and a button in the corresponded toolbar.
    9. +
  9. Each workbench is defined as a menu in main menu bar of SALOME desktop and as a tool bar with corresponded title.
    10. +
  10. Each feature in the workbench is defined as a menu item in the corresponded menu and a button in the corresponded tool bar.
  11. Object Browser of SALOME is hidden on activation of NewGEOM and restored on its deactivation.
  12. Object Browser and Property panel of NewGEOM is shown on activation of the module and hidden on its deactivation.
  13. Persistent of NewGEOM is compatible with persistent of SALOME. On saving of SALOME study the content of NewGEOM data structure is saved into study also and restored on restoring of study.
    14. diff --git a/doc/general_architecture_1.png b/doc/general_architecture_1.png index 3465128f9..cde820224 100644 Binary files a/doc/general_architecture_1.png and b/doc/general_architecture_1.png differ