doc/salome/gui/HYDRO/input/import_obstacle.doc

   1
   2 /**
   3   @file
   4   \brief Help for Import obstacle from file operation
   5 */
   6
   7 /**
   8   \page import_obstacle Import obstacle from file
   9
  10
  11  <a href="index.html"><b>Back to Main page.</b></a>
  12
  13   An obstacle can be imported into the HYDROGUI module from external file.
  14
  15
  16   The <b>Import obstacle</b> operation can be started via:<ol>
  17
  18 <li>The main menu <b> HYDRO => Obstacle => Import obstacle </b>;
  19 <li>Context menu of OBSTACLES in Object browser - <b>Import obstacle</b>;
  20 <li><b>Import obstacle from file</b> toolbar button
  21  </ol>
  22
  23 \image html  import_obstacle_toolbar_button.png "Import obstacle from file toolbar button"
  24
  25
  26  <b>Import obstacle</b> input panel appears.
  27
  28
  29   \image html import_obstacle_create_input_panel.png " Import obstacle input panel - Create mode"
  30
  31    \image html import_obstacle_input_panel.png " Import obstacle input panel - Modify mode"
  32
  33 Arguments of the input panel:
  34
  35 <b>File name</b> - field for defining file to import.
  36
  37
  38 The user clicks <b>Open File</b> button.
  39
  40
  41 \image html  open_file_icon.png  "Open File button"
  42
  43
  44 <b>Open File</b> dialog box appears.
  45
  46
  47 \image html  open_file_dialog.png  "Open File dialog"
  48
  49
  50 The user selects type of file to be imported. Supported formats are BREP, IGES, STEP.
  51
  52
  53 The user selects folder in <b>Look in</b> filed and desired file in this folder.
  54
  55 The user clicks <b>Open</b> button.
  56
  57 <b>Open File</b> dialog box is closed. Selected file appears in <b>File name</b>.
  58
  59
  60 <b>Name</b> - field to define the obstacle name. By default name is the same as file name without extension;<br>
  61 <b>Mode</b> - allows to generate a new obstacle (radio-button <b>Create new</b>) or replace existing obstacle (radio-button <b>Modify</b>) ;<br>
  62 <b>Apply</b> - button to import obstacle;<br>
  63 <b>Apply and Close</b> - button to import obstacle and close input panel;<br>
  64 <b>Close</b> - button to close input panel.
  65
  66    The obstacle is presented as the face and 3D object.
  67    \image html obstacle_presentation.png  "Obstacle example"
  68
  69  <a href="index.html"><b>Back to Main page.</b></a>
  70
  71 */