Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / ExchangePlugin / doc / importFeature.rst
index c1c604d7ea1129ea6268c84e58833284d96e3dba..4692ec6690d7e14f34ec1133dd4559b28a62f482 100644 (file)
+.. |import.icon|    image:: images/import.png
 
 Import
 ======
 
-The feature Import allows to import an external file into a current study.
+The Import feature allows importing an external file into the current study.
 
-It is possible to import files in 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** 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/import.png
+.. figure:: images/ImportPartFileDlg.png
    :align: center
 
-.. centered::
-   **Import**  button 
+   **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/Import_panel.png
+.. figure:: images/ImportPart_panel.png
+   :align: center
+
+   **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:
+
+.. figure:: 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:
+
+.. figure:: images/Import_panel.png
+   :align: center
+
    **Import property panel**
 
-In this panel it is possible to enter a file name directly into input field or press **'...'** button and browse it with help of import file dialog box:
+The **Import to** combobox provides the list of destinations (one of existing Parts or a new Part).
 
-.. image:: images/OpenFileDlg.png
+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:
+
+.. figure:: images/OpenFileDlg.png
    :align: center
-       
-.. centered::
-   **Import file dialog box**
+
+   **Dialog box to import CAD-neutral format**
   
 **Apply** button imports the file.
   
-**Cancel** button cancels operation.
+**Cancel** button cancels the operation.
 
-**TUI Command**: *model.addImport(Part_doc, FileNameString)*
+**TUI Command**:
 
-**Arguments**: Part + file name string.
+.. py:function:: model.addImport(Part_doc, FileNameString)
+
+    :param part: The current part object
+    :param string: A file name string.
 
 Result
 """"""
 
-The Result of the operation depends on content of imported file.
+The Result of the operation depends on the imported file content.
+
+.. figure:: images/FileImported.png
+   :align: center
 
-.. image:: images/FileImported.png
-          :align: center
-                  
-.. centered::
    Import of BREP file.
 
-**See Also** a sample TUI Script of :ref:`tui_import_file` operation.
+**See Also** a sample TUI Script of :ref:`tui_import_file` operation.