doc/salome/gui/GEOM/input/import_export.doc

   1 /*!
   2
   3 \page import_export_geom_obj_page Importing/exporting geometrical objects
   4
   5 \tableofcontents
   6
   7 \section io_general General information
   8
   9 In Geometry module you can import and export geometrical objects
  10 from/into \b BREP, \b IGES, \b STEP, \b STL, \b XAO, \b VTK (only export)
  11 and others files.
  12 The mechanisms of import and export are implemented via plugins,
  13 which gives the opportunity to expand the range of available formats
  14 by adding more plugins (for example, CATIA 5 or ACIS).
  15
  16 \note If a plugin supports import of materials associated with shapes, these
  17 shapes are grouped corresponding to the imported materials. For the moment STEP
  18 import is the only plugin that supports this feature.
  19
  20 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  21 \ref tui_import_export_page
  22
  23 \section io_import Import file
  24
  25 <em>To import geometrical objects from a BREP, IGES, STEP or STL file:</em>
  26
  27 \par
  28 From the \b File menu choose <b>Import/\<FormatName\></b>, where <b>\<FormatName\></b> is a name
  29 of desirable format. In the <b>Import \<FormatName\></b> dialog box select the file to import
  30 and press \b Open. The file will be imported in the module and its contents (geometrical object)
  31 will be displayed in the <b>Object Browser</b>.
  32
  33 The dialog box to import the file can provide additional parameters.
  34
  35 For example, dialog box for importing files in STL format:
  36
  37 \image html geomimport.png
  38
  39 \par
  40
  41 \note If the selected file is in IGES or STEP format and the model size
  42 is not expressed in meters, the user will be asked whether to take or not the
  43 units into account (see the picture below). This feature can be
  44 helpful if some wrong units have been written to the IGES or STEP file by a
  45 3rd-party software.
  46
  47 \image html iges_unit.png
  48
  49 \par
  50
  51 \note It is possible to re-open from the initial file a previously imported shape if
  52 the file has been changed on disk. For this, select
  53 <b>Reload From Disk</b> in the context menu of the imported
  54 shape. The reloaded shape will have the same representation parameters
  55 as before this operation.
  56
  57 \image html geomimport_reopen.png
  58
  59 \section io_export Export file
  60
  61 \n <em>To export geometrical objects into a BREP, IGES, STEP, STL or VTK
  62 file:</em>
  63
  64 \par
  65 Select the object you wish to export, then from the \b File menu choose
  66 <b>Export/\<FormatName\></b>, where <b>\<FormatName\></b> is a name of desirable format.
  67 In the <b>Export \<FormatName\></b> dialog box define the name and the location
  68 of the file to export and press \b Save.
  69
  70 The dialog box to export the file can provide additional advanced parameters.
  71
  72 For example, dialog box for exporting files in STL format:
  73
  74 \image html geomexport.png
  75
  76 \par
  77
  78 \section io_xao Import and export of shapes in XAO format
  79
  80 XAO is a file format which describes a shape with its topology, groups and fields.
  81
  82 <em>To import a shape in the \b XAO format:</em>
  83
  84 \par
  85 In the \b File menu select <b>Import/XAO</b>.
  86
  87 \image html importxao_dlg.png
  88
  89 \par
  90
  91 <em>To export a shape in the \b XAO format:</em>
  92
  93 \par
  94 In the \b File menu select <b>Export/XAO</b>.
  95
  96 \image html exportxao_dlg.png
  97
  98 In this dialog:
  99 - Click the arrow button and select in the Object Browser or in the Viewer the <b>Shape</b> to be exported.
 100 - Input the <b>File name</b> to create a new file or click browse button to save in an existing file.
 101 - Input the <b>Author</b> if needed.
 102 - Tick <b>Export shape in a separate file</b> to write the shape in a separate BREP file, referenced in the XAO file. It will have the same name as the XAO file with the .brep extension appended.
 103 - Select the \b Groups of the chosen shape to be exported.
 104 - Select the \b Fields of the chosen shape to be exported.
 105 - Press "Apply" or "Apply & Close" button to get the result.
 106
 107 It is also possible to export a shape using the TUI Command: <em>geompy.ExportXAO(Shape, Groups, Fields, Author, FileName, ShapeFileName)</em>
 108
 109 */