--- /dev/null
+
+ .. _tui_export_part:
+
+Export File
+===========
+
+.. literalinclude:: examples/export_part.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/export_part.py>`
+
--- /dev/null
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Cylinder_1 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "PartSet/Origin"), model.selection("EDGE", "PartSet/OZ"), 5, 10)
+Box_1 = model.addBox(Part_1_doc, 10, 10, 10)
+Export_1 = model.exportPart(Part_1_doc, "~/box.shaperpart", [model.selection("SOLID", "Box_1_1")])
+model.end()
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.icon| **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/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.
+
+
+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/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
+ :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:
: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.
:param string: The file name
:param list: A list of exporting objects
+
+.. py:function:: model.exportToXAO(Part_doc, FileNameString, [ObjectsList, 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
+
Result
""""""
The Import feature allows importing an external file into a current study.
-It is possible to import files in the following formats: BREP, STEP, IGES, XAO. To import a file into active part:
+Import PartSet
+--------------
-#. select in the Main Menu *Part - > Import* item or
-#. click |import.icon| **Import** button in the toolbar.
+To open a study previously saved in SHAPER native format, select in the Main Menu *File -> Import -> Part Set...* item.
+The current study will be closed, so the action dialog will be opened to choose whether the changes should be saved.
+After that the following open file dialog will be opened:
+
+.. image:: images/ImportPartFileDlg.png
+ :align: center
+
+.. centered::
+ **Dialog box to open SHAPER native file**
+
+Select file and press **Open** button to load the file. **Cancel** button cancels the operation.
+
+
+Import Part
+-----------
+
+To import the previously stored file in the current part, select in the Main Menu *File -> Import -> Part...* item.
+
+The following property panel will be opened:
+
+.. image:: images/ImportPart_panel.png
+ :align: center
+
+.. centered::
+ **Import Part property panel**
+
+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:
+
+.. image:: images/ImportPartFileDlg.png
+ :align: center
+
+.. centered::
+ **Dialog box to import Part**
+
+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.
+
+**Apply** button imports the file.
+
+**Cancel** button cancels the operation.
+
+**TUI Command**:
+
+.. py:function:: model.importPart(Doc, FileNameString, [PrevFeature])
+
+ :param part: The current part object
+ :param string: A file name string
+ :param reference: The feature after which the imported entities should be inserted
+
+
+Import from CAD formats
+-----------------------
+
+It is possible to import files in the following CAD-neutral formats: BREP, STEP, IGES, XAO.
+To import a file into active part select in the Main Menu *File -> Import -> From CAD format...* item.
The following property panel will be opened:
.. centered::
**Import property panel**
+The **Import to** combobox provides the list of destinations (PartSet, existing Part or a new Part).
+
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:
.. image:: images/OpenFileDlg.png
:align: center
.. centered::
- **Import file dialog box**
+ **Dialog box to import CAD-neutral format**
**Apply** button imports the file.
</feature>
<feature id="ImportPart" title="Import part" tooltip="Import features from file" icon="icons/Exchange/import_part.png"
- helpfile="importPart.html"
+ helpfile="importFeature.html"
internal="1">
<file_selector id="file_path" title="Import file" path="">
<validator id="ExchangePlugin_ImportFormat" parameters="shaperpart:Part" />
tooltip="Select the part to import the document" />
</feature>
<feature id="ExportPart" title="Export part" tooltip="Export structure of the Part to file" icon="icons/Exchange/export_part.png"
- helpfile="exportPart.html"
+ helpfile="exportFeature.html"
internal="1">
<export_file_selector id="file_path"
type="save"
