Salome HOME
Merge branch 'master' of https://codev-tuleap.cea.fr/plugins/git/salome/shaper
[modules/shaper.git] / src / ExchangePlugin / doc / exportFeature.rst
index be697bd006cdcb01d1074e83f8af5069acfd4adf..e11ede6ada3a7b4d7603b69ef04584ee70161572 100644 (file)
@@ -1,35 +1,90 @@
+.. |export.icon|    image:: images/export.png
 
 Export
 ======
 
-The  export feature allows exporting objects from the current study to an external file.
+The export feature allows exporting objects from the current study to an external file. The following sections show the different ways to export objects.
 
-It is possible to export objects to files in the following formats: BREP, STEP, IGES, XAO. To export objects to a file:
+Export PartSet
+--------------
 
-#. select in the Main Menu *Part - > Export* item  or
-#. click **Export** button in the toolbar.
+To export the full study in SHAPER native format (``*.shaper``) select in the Main Menu *File -> Export -> Part Set...* item.
+The **Export file** dialog will be opened:
 
-.. image:: images/export.png
+.. figure:: images/ExportNativeFileDlg.png
    :align: center
 
-.. centered::
-   **Export**  button
+   **Dialog box for export to SHAPER native format**
+
+Specify file name and press **Save** button to export the file. **Cancel** button cancels the operation.
+
+
+Export Part
+-----------
+
+It allows to export the specified results including the sequence of all operations which affect the selected objects.
+To export results in binary format (``*.shaperpart``) select in the Main Menu *File -> Export -> Part...* item.
 
 The following property panel will be opened:
 
-.. image:: images/Export_panel.png
+.. figure:: images/ExportPart_panel.png
+   :align: center
+
+   **Export Part property panel**
+
+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:
+
+.. figure:: images/ExportPartFileDlg.png
    :align: center
-       
-.. centered::
+
+   **Dialog box to export part of the model**
+
+Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
+In case of the list is empty, all active results in the current Part will be exported.
+If the PartSet is active, only results (construction elements) of this PartSet may be selected for the export, but not results of Parts.
+
+*Note:* It is forbidden to export features that include references to external elements other than default elements (origin or main axes and planes).
+
+
+**Apply** button exports the file.
+  
+**Cancel** button cancels the operation.
+
+**TUI Command**:
+
+.. py:function:: model.exportPart(Part_doc, FileNameString, ObjectsList)
+
+    :param part: The current part object
+    :param string: The file name
+    :param list: A list of exporting objects, if necessary
+
+Result
+""""""
+
+The Result of operation is an exported file.
+
+**See Also** a sample TUI Script of :ref:`tui_export_part` operation.
+
+
+Export to CAD format
+--------------------
+
+It is possible to export objects to files in the following CAD-neutral formats: BREP, STEP, IGES, XAO.
+To export objects to a file select in the Main Menu *File -> Export -> To CAD  formats...* item.
+
+The following property panel will be opened:
+
+.. figure:: images/Export_panel.png
+   :align: center
+
    **Export property panel**
 
 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:
 
-.. image:: images/ExportFileDlg.png
+.. figure:: images/ExportFileDlg.png
    :align: center
-       
-.. centered::
-   **Export file dialog box**
+
+   **Dialog box tp export in CAD-neutral format**
 
 Selection list in the property panel contains a list of exported objects which can be selected in a viewer or object browser.
 
@@ -37,9 +92,22 @@ Selection list in the property panel contains a list of exported objects which c
   
 **Cancel** button cancels the operation.
 
-**TUI Command**: *model.exportToFile(Part_doc, FileNameString, ObjectsList)*
+**TUI Command**:
+
+.. py:function:: model.exportToFile(Part_doc, FileNameString, ObjectsList)
+
+    :param part: The current part object
+    :param string: The file name
+    :param list: A list of exporting objects
+
+
+.. py:function:: model.exportToXAO(Part_doc, FileNameString, [ObjectsList, Author, GeometryName])
 
-**Arguments**: Part + file name string + list of objects.
+    :param part: The current part object
+    :param string: The file name
+    :param list: A list of exporting objects, if necessary
+    :param string: The name of the author 
+    :param string: The name for the shape processed in GEOMETRY module
 
 Result
 """"""