src/ExchangePlugin/doc/exportFeature.rst

   1 .. |export.icon|    image:: images/export.png
   2
   3 Export
   4 ======
   5
   6 The export feature allows exporting objects from the current study to an external file. The following sections show the different ways to export objects.
   7
   8 Export PartSet
   9 --------------
  10
  11 To export the full study in SHAPER native format (``*.shaper``) select in the Main Menu *File -> Export -> Part Set...* item.
  12 The **Export file** dialog will be opened:
  13
  14 .. figure:: images/ExportNativeFileDlg.png
  15    :align: center
  16
  17    **Dialog box for export to SHAPER native format**
  18
  19 Specify file name and press **Save** button to export the file. **Cancel** button cancels the operation.
  20
  21
  22 Export Part
  23 -----------
  24
  25 It allows to export the specified results including the sequence of all operations which affect the selected objects.
  26 To export results in binary format (``*.shaperpart``) select in the Main Menu *File -> Export -> Part...* item.
  27
  28 The following property panel will be opened:
  29
  30 .. figure:: images/ExportPart_panel.png
  31    :align: center
  32
  33    **Export Part property panel**
  34
  35 The file name and path can be defined in **Export file** field by direct input or browsing with **'...'** button, which opens **Export file** dialog box:
  36
  37 .. figure:: images/ExportPartFileDlg.png
  38    :align: center
  39
  40    **Dialog box to export part of the model**
  41
  42 Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
  43 In case of the list is empty, all active results in the current Part will be exported.
  44 If the PartSet is active, only results (construction elements) of this PartSet may be selected for the export, but not results of Parts.
  45
  46 *Note:* It is forbidden to export features that include references to external elements other than default elements (origin or main axes and planes).
  47
  48
  49 **Apply** button exports the file.
  50
  51 **Cancel** button cancels the operation.
  52
  53 **TUI Command**:
  54
  55 .. py:function:: model.exportPart(Part_doc, FileNameString, ObjectsList)
  56
  57     :param part: The current part object
  58     :param string: The file name
  59     :param list: A list of exporting objects, if necessary
  60
  61 Result
  62 """"""
  63
  64 The Result of operation is an exported file.
  65
  66 **See Also** a sample TUI Script of :ref:`tui_export_part` operation.
  67
  68
  69 Export to CAD format
  70 --------------------
  71
  72 It is possible to export objects to files in the following CAD-neutral formats: BREP, STEP, IGES, XAO.
  73 To export objects to a file select in the Main Menu *File -> Export -> To CAD  formats...* item.
  74
  75 The following property panel will be opened:
  76
  77 .. figure:: images/Export_panel.png
  78    :align: center
  79
  80    **Export property panel**
  81
  82 In this panel, it is necessary to select desirable format of export file. It can be **'BREP, STEP, IGES'** or **'XAO'**. In case of first choice the format of exported file will be defined according to file extension. The file name and path can be defined in **Export file** field by direct input or browsing with **'...'** button, which opens **Export file** dialog box:
  83
  84 .. figure:: images/ExportFileDlg.png
  85    :align: center
  86
  87    **Dialog box tp export in CAD-neutral format**
  88
  89 Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
  90
  91 **Apply** button exports the file.
  92
  93 **Cancel** button cancels the operation.
  94
  95 **TUI Command**:
  96
  97 .. py:function:: model.exportToFile(Part_doc, FileNameString, ObjectsList)
  98
  99     :param part: The current part object
 100     :param string: The file name
 101     :param list: A list of exporting objects
 102
 103
 104 .. py:function:: model.exportToXAO(Part_doc, FileNameString, [ObjectsList, Author, GeometryName])
 105
 106     :param part: The current part object
 107     :param string: The file name
 108     :param list: A list of exporting objects, if necessary
 109     :param string: The name of the author
 110     :param string: The name for the shape processed in GEOMETRY module
 111
 112 Result
 113 """"""
 114
 115 The Result of operation is an exported file.
 116
 117 **See Also** a sample TUI Script of :ref:`tui_export_file` operation.