Salome HOME
rnc: EDF 2050 -> documentation added to explain the way to work with objects fecthed...
authorgdd <gdd>
Thu, 15 Dec 2011 17:01:55 +0000 (17:01 +0000)
committergdd <gdd>
Thu, 15 Dec 2011 17:01:55 +0000 (17:01 +0000)
doc/salome/gui/SMESH/input/smeshpy_interface.doc
doc/salome/gui/SMESH/input/tui_work_on_objects_from_gui.doc [new file with mode: 0644]

index 84663c93d5f9f7654011d4ffe99b460cc4ea316a..6669892c019c2a40c05ede1f98834fc2084ceed3 100644 (file)
@@ -140,6 +140,7 @@ the following links:
 - \subpage tui_transforming_meshes_page
 - \subpage tui_notebook_smesh_page
 - \subpage tui_measurements_page
 - \subpage tui_transforming_meshes_page
 - \subpage tui_notebook_smesh_page
 - \subpage tui_measurements_page
-- \subpage tui_generate_flat_elements_page 
+- \subpage tui_generate_flat_elements_page
+- \subpage tui_work_on_objects_from_gui
 
 */
 
 */
diff --git a/doc/salome/gui/SMESH/input/tui_work_on_objects_from_gui.doc b/doc/salome/gui/SMESH/input/tui_work_on_objects_from_gui.doc
new file mode 100644 (file)
index 0000000..96927ee
--- /dev/null
@@ -0,0 +1,27 @@
+/*!
+
+\page tui_work_on_objects_from_gui How to work with objects from the GUI ?
+
+It is sometimes useful to work alternatively in the GUI of SALOME and in the Python Console. To fetch an object from the TUI simply type:
+
+\code
+myMesh_ref = salome.IdToObject("ID")  
+// were ID is the number that appears in the object browser in the Entry column 
+// ( If hidden show it by right clicking and checking the checknbox Entry)
+myMesh = smesh.Mesh(myMesh_ref)
+\endcode
+or 
+\code
+myMesh_ref = salome.myStudy.FindObjectByPath("/Mesh/myMesh").GetObject() 
+// "/Mesh/myMesh" is the path to the desired object in the object browser
+myMesh = smesh.Mesh(myMesh_ref)
+\endcode
+
+All the methods documented in these pages can then be used on myMesh
+
+\note The first statement only gives you access to a reference to the object created via the GUI. 
+\n But the methods available on this reference are not exactly the same as those documented in these help pages. 
+This Python API is meant to be used on smesh.Mesh instances. 
+\n That's why you'll have to create such an instance with the second statement. 
+
+*/
\ No newline at end of file