src/ExchangePlugin/doc/importFeature.rst

   1 .. |import.icon|    image:: images/import.png
   2
   3 Import
   4 ======
   5
   6 The Import feature allows importing an external file into the current study.
   7
   8 Import PartSet
   9 --------------
  10
  11 To open a study previously saved in SHAPER native format, select in the Main Menu *File -> Import -> Part Set...* item.
  12 The current study will be closed, so the action dialog will be opened to choose whether the changes should be saved.
  13 After that the following open file dialog will be opened:
  14
  15 .. figure:: images/ImportPartFileDlg.png
  16    :align: center
  17
  18    **Dialog box to open SHAPER native file**
  19
  20 Select file and press **Open** button to load the file. **Cancel** button cancels the operation.
  21
  22
  23 Import Part
  24 -----------
  25
  26 To import the previously stored file in the current part, select in the Main Menu *File -> Import -> Part...* item.
  27
  28 The following property panel will be opened:
  29
  30 .. figure:: images/ImportPart_panel.png
  31    :align: center
  32
  33    **Import Part property panel**
  34
  35 In this panel it is possible to enter a file name directly or press **'...'** button and browse it with help of import file dialog box:
  36
  37 .. figure:: images/ImportPartFileDlg.png
  38    :align: center
  39
  40    **Dialog box to import Part**
  41
  42 The import will be performed within the active part. If no part is active, the possible targets to import will be proposed in **Import to** combobox, which contains the list of existing parts, PartSet or a new part creation option.
  43
  44 **Apply** button imports the file.
  45
  46 **Cancel** button cancels the operation.
  47
  48 **TUI Command**:
  49
  50 .. py:function:: model.importPart(Doc, FileNameString, [PrevFeature])
  51
  52     :param part: The current part object
  53     :param string: A file name string
  54     :param reference: The feature after which the imported entities should be inserted
  55
  56
  57 Import from CAD formats
  58 -----------------------
  59
  60 It is possible to import files in the following CAD-neutral formats: BREP, STEP, IGES, XAO.
  61 To import a file into active part select in the Main Menu *File -> Import -> From CAD format...* item.
  62
  63 The following property panel will be opened:
  64
  65 .. figure:: images/Import_panel.png
  66    :align: center
  67
  68    **Import property panel**
  69
  70 The **Import to** combobox provides the list of destinations (one of existing Parts or a new Part).
  71
  72 In this panel it is possible to enter a file name directly or press **'...'** button and browse it with help of import file dialog box:
  73
  74 .. figure:: images/OpenFileDlg.png
  75    :align: center
  76
  77    **Dialog box to import CAD-neutral format**
  78
  79 **Apply** button imports the file.
  80
  81 **Cancel** button cancels the operation.
  82
  83 **TUI Command**:
  84
  85 .. py:function:: model.addImport(Part_doc, FileNameString)
  86
  87     :param part: The current part object
  88     :param string: A file name string.
  89
  90 Result
  91 """"""
  92
  93 The Result of the operation depends on the imported file content.
  94
  95 .. figure:: images/FileImported.png
  96    :align: center
  97
  98    Import of BREP file.
  99
 100 **See Also** a sample TUI Script of :ref:`tui_import_file` operation.