ForkMaster/smesh
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/smesh.git synced 2024-11-15 10:08:34 +05:00
Code Issues Packages Projects Releases Wiki Activity

rnc: EDF 2050 -> documentation added to explain the way to work with objects fecthed from GUI in the Python console

Browse Source
This commit is contained in:
gdd 2011-12-15 17:01:55 +00:00
parent 44a302322a
commit 352e0ac1ff
2 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/salome/gui/SMESH/input/smeshpy_interface.doc
View File

@ -141,5 +141,6 @@ the following links:
- \subpage tui_notebook_smesh_page
- \subpage tui_measurements_page
- \subpage tui_generate_flat_elements_page
- \subpage tui_work_on_objects_from_gui
*/

27
doc/salome/gui/SMESH/input/tui_work_on_objects_from_gui.doc Normal file
View File

@ -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.
*/