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, STL.
  73 To export objects to a file select in the Main Menu *File -> Export -> To CAD  formats...* item.
  74
  75
  76 The following property panel will be opened:
  77
  78 .. figure:: images/Export_panel.png
  79    :align: center
  80
  81    **Export property panel**
  82
  83 In this panel, it is necessary to select desirable format of export file. It can be **'BREP, STEP, IGES'** , **'XAO'** or **'STL'** .
  84
  85
  86 Export to BREP, STEP, IGES
  87 """"""""""""""""""""""""""
  88
  89 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:
  90
  91 .. figure:: images/ExportFileDlg.png
  92    :align: center
  93
  94    **Dialog box to export in CAD-neutral format**
  95
  96 Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
  97
  98 *Note*: For XAO format, selection list is not available, the whole part is exported.
  99
 100 **Apply** button exports the file.
 101
 102 **Cancel** button cancels the operation.
 103
 104 **TUI Command**:
 105
 106 .. py:function:: model.exportToFile(Part_doc, FileNameString, ObjectsList)
 107
 108     :param part: The current part object
 109     :param string: The file name
 110     :param list: A list of exporting objects
 111
 112
 113 .. py:function:: model.exportToXAO(Part_doc, FileNameString, Author="", GeometryName="")
 114 .. py:function:: model.exportToXAO(Part_doc, FileNameString, Object, Author="", GeometryName="")
 115
 116     :param part: The current part object
 117     :param string: The file name
 118     :param object: An exporting object, if necessary
 119     :param string: The name of the author, empty by default
 120     :param string: The name for the shape processed in GEOMETRY module, empty by default
 121
 122 .. py:function:: aBuffer = model.exportToXAOMem(Part_doc, Object, Author="", GeometryName="")
 123
 124     This function enables passing data in XAO format from SHAPER to GEOM through a memory buffer (bytes array), without creation of real file on disk.
 125
 126     :param object: The object to export
 127     :param string: The name of the author, empty by default
 128     :param string: The name for the shape processed in GEOMETRY module, empty by default
 129
 130 Result
 131 """"""
 132
 133 The Result of operation is an exported file.
 134
 135 **See Also** a sample TUI Script of :ref:`tui_export_file` operation.
 136
 137 Export to STL
 138 """""""""""""
 139 In this case, the following property panel will be opened:
 140
 141 .. figure:: images/ExportSTL.png
 142    :align: center
 143
 144    **Dialog box to export in STL format**
 145
 146
 147 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.
 148
 149 **Object** field contains an exported object which can be selected in a viewer or object browser.
 150
 151 **Deflection** (**Relative** or **Absolute**) has to be chosen and defined in the corresponding field as well as the **File type** which can defined as **Binary** or as **ASCII**.
 152
 153
 154 **Apply** button exports the file.
 155
 156 **Cancel** button cancels the operation.
 157
 158 **TUI Command**:
 159
 160 .. py:function:: model.exportToSTL(Part_doc, FileNameString, selectedShape, relative, absolute, isRelative, isASCII)
 161
 162     :param part: The current part object
 163     :param string: The file name
 164     :param object: An exporting object
 165     :param real: value of the relative deflection
 166     :param real: value of the absolute deflection
 167     :param boolean: indicate if use deflection relative
 168     :param boolean: indicate if the file is in ASCII type
 169
 170 Result
 171 """"""
 172
 173 The Result of operation is an exported STL file.
 174
 175 **See Also** a sample TUI Script of :ref:`tui_export_file_STL` operation.