Salome HOME
Merge branch 'jfa/26449_1'
[modules/shaper.git] / src / ExchangePlugin / doc / exportFeature.rst
index d7e456412942784d0309557ef00b33add55c8eab..e4deafb4f346a9d5e566f97ee7771bcf64e1e314 100644 (file)
@@ -11,10 +11,9 @@ Export PartSet
 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/ExportNativeFileDlg.png
+.. figure:: images/ExportNativeFileDlg.png
    :align: center
-       
-.. centered::
+
    **Dialog box for export to SHAPER native format**
 
 Specify file name and press **Save** button to export the file. **Cancel** button cancels the operation.
@@ -28,18 +27,16 @@ To export results in binary format (``*.shaperpart``) select in the Main Menu *F
 
 The following property panel will be opened:
 
-.. image:: images/ExportPart_panel.png
+.. figure:: images/ExportPart_panel.png
    :align: center
-       
-.. centered::
+
    **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:
 
-.. image:: images/ExportPartFileDlg.png
+.. 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.
@@ -72,27 +69,34 @@ The Result of operation is an exported file.
 Export to CAD format
 --------------------
 
-It is possible to export objects to files in the following CAD-neutral formats: BREP, STEP, IGES, XAO.
+It is possible to export objects to files in the following CAD-neutral formats: BREP, STEP, IGES, XAO, STL.
 To export objects to a file select in the Main Menu *File -> Export -> To CAD  formats...* item.
 
+
 The following property panel will be opened:
 
-.. image:: images/Export_panel.png
+.. figure:: images/Export_panel.png
    :align: center
-       
-.. centered::
+
    **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:
+In this panel, it is necessary to select desirable format of export file. It can be **'BREP, STEP, IGES'** , **'XAO'** or **'STL'** . 
 
-.. image:: images/ExportFileDlg.png
+
+Export to BREP, STEP, IGES
+""""""""""""""""""""""""""
+
+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:
+
+.. figure:: images/ExportFileDlg.png
    :align: center
-       
-.. centered::
-   **Dialog box tp export in CAD-neutral format**
+
+   **Dialog box to 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.
 
+*Note*: For XAO format, selection list is not available, the whole part is exported.
+
 **Apply** button exports the file.
   
 **Cancel** button cancels the operation.
@@ -106,13 +110,14 @@ Selection list in the property panel contains a list of exported objects which c
     :param list: A list of exporting objects
 
 
-.. py:function:: model.exportToXAO(Part_doc, FileNameString, [ObjectsList, Author, GeometryName])
+.. py:function:: model.exportToXAO(Part_doc, FileNameString, Author="", GeometryName="")
+.. py:function:: model.exportToXAO(Part_doc, FileNameString, Object, Author="", GeometryName="")
 
     :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
+    :param object: An exporting object, if necessary
+    :param string: The name of the author, empty by default
+    :param string: The name for the shape processed in GEOMETRY module, empty by default
 
 Result
 """"""
@@ -120,3 +125,43 @@ Result
 The Result of operation is an exported file.
 
 **See Also** a sample TUI Script of :ref:`tui_export_file` operation.
+
+Export to STL
+"""""""""""""
+In this case, the following property panel will be opened:
+
+.. figure:: images/ExportSTL.png
+   :align: center
+
+   **Dialog box to export in STL format**
+
+
+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.
+
+**Object** field contains an exported object which can be selected in a viewer or object browser.
+
+**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**. 
+
+
+**Apply** button exports the file.
+  
+**Cancel** button cancels the operation.
+
+**TUI Command**:
+
+.. py:function:: model.exportToSTL(Part_doc, FileNameString, selectedShape, relative, absolute, isRelative, isASCII)
+
+    :param part: The current part object
+    :param string: The file name
+    :param object: An exporting object
+    :param real: value of the relative deflection
+    :param real: value of the absolute deflection
+    :param boolean: indicate if use deflection relative
+    :param boolean: indicate if the file is in ASCII type 
+
+Result
+""""""
+
+The Result of operation is an exported STL file.
+
+**See Also** a sample TUI Script of :ref:`tui_export_file_STL` operation.