Salome HOME
Merge from V6_main_20120808 08Aug12
[modules/visu.git] / doc / salome / gui / VISU / input / tui_def_shape.doc
diff --git a/doc/salome/gui/VISU/input/tui_def_shape.doc b/doc/salome/gui/VISU/input/tui_def_shape.doc
new file mode 100644 (file)
index 0000000..d8eb682
--- /dev/null
@@ -0,0 +1,51 @@
+/*!
+
+\page tui_def_shape_page Deformed Shape
+
+Create <b>Deformed Shape</b> presentation on a field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# The directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import a MED file
+medFile = os.path.join(datadir,"MedFiles","fra.med")
+myResult = myVisu.ImportFile(medFile)
+
+# Create a deformed shape for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myDefShape = myVisu.DeformedShapeOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set the scale factor
+myDefShape.SetScale(0.25)
+
+# Set magnitude coloring
+myDefShape.ShowColored(True)
+
+# Update the object browser
+salome.sg.updateObjBrowser(1)
+
+# Display the newly created deformed shape
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myDefShape)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.DeformedShape "DeformedShape interface reference documentation" 
+for more details.
+
+*/