]> SALOME platform Git repositories - modules/visu.git/commitdiff
Salome HOME
Fix for bug 0020922: [CEA 417] VISU TUI documentation. V5_1_main_20100913 V5_1_main_20100920
authormzn <mzn@opencascade.com>
Thu, 9 Sep 2010 10:55:43 +0000 (10:55 +0000)
committermzn <mzn@opencascade.com>
Thu, 9 Sep 2010 10:55:43 +0000 (10:55 +0000)
47 files changed:
doc/salome/gui/VISU/input/3d_management.doc
doc/salome/gui/VISU/input/animating.doc
doc/salome/gui/VISU/input/creating_curves.doc
doc/salome/gui/VISU/input/creating_plot2d.doc
doc/salome/gui/VISU/input/cut_lines.doc
doc/salome/gui/VISU/input/cut_planes.doc
doc/salome/gui/VISU/input/cut_segment.doc
doc/salome/gui/VISU/input/deformed_shape.doc
doc/salome/gui/VISU/input/evolution.doc
doc/salome/gui/VISU/input/gauss_points_presentations.doc
doc/salome/gui/VISU/input/importing_exporting_tables_page.doc
doc/salome/gui/VISU/input/importing_med_objects.doc
doc/salome/gui/VISU/input/index.doc
doc/salome/gui/VISU/input/iso_surfaces.doc
doc/salome/gui/VISU/input/plot_3d.doc
doc/salome/gui/VISU/input/point_marker.doc
doc/salome/gui/VISU/input/presentation_of_submesh.doc
doc/salome/gui/VISU/input/python_examples.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/scalar_map.doc
doc/salome/gui/VISU/input/scalar_map_on_deformed_shape.doc
doc/salome/gui/VISU/input/stream_lines.doc
doc/salome/gui/VISU/input/table_3d.doc
doc/salome/gui/VISU/input/tui_animation.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_creating_3d_prs.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_cut_lines.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_cut_planes.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_cut_segment.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_datatable.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_def_shape.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_def_shape_and_scalar_map.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_evolution.doc
doc/salome/gui/VISU/input/tui_gauss_points.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_import_export.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_iso_surf.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_manage_3d_prs.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_plot_3d.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_point_marker.doc
doc/salome/gui/VISU/input/tui_scalar_map.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_stream_lines.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_submesh.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_table_3d.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_table_curves.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_table_import.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_vectors.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/tui_view_3d.doc [new file with mode: 0644]
doc/salome/gui/VISU/input/vectors.doc
doc/salome/gui/VISU/input/viewing_3d_presentations.doc

index 2b54a0cdc06cd8df5731d55fd5abaf5c179f6f26..49e1776ac9f6aa76363c14fee44fa5192fc030f9 100755 (executable)
@@ -52,6 +52,5 @@ viewing the presentation.</li>
 </ul>
 
 
-
 */
 
index 02ad4ba3dcdd0ddd9769d6faddf7d5cf3e9be399..d1298a9044620b315fcc5999fcd433c93bd04e75 100644 (file)
@@ -139,4 +139,7 @@ to study</b> again you get another animation in the Object Browser.
 <b>Publish to Study</b> - saves your animation in the study and
 presents it in the Object Browser.
 
+<br><b>See Also</b> a sample TUI Script of an
+\ref tui_animation_page "Animation" creation.
+
 */
index 71c6d5d0d7e93cdcddf391a40b770de9f217f17c..61a20de727bdd49dff2345be4330a32068ddfa40 100644 (file)
@@ -72,7 +72,7 @@ be created automatically.</li>
 </li>
 </ol>
 
-
-
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_table_curves_page "Curves creation and displaying" operation.
 
 */
index 1b2d275b493c3afa335001eb17a923c2acd9f6d8..c5f98fc03371ebb0a9758f4ca2f638f217063652 100755 (executable)
@@ -57,4 +57,8 @@ selected curve lines, will be displayed in the viewer:
 </li>
 </ol>
 
+<b>See Also</b> a sample TUI Script of a 
+\ref tui_table_curves_page "Curves creation and displaying" operation.
+
+
 */
index c5d156f53104c807a6cbd850611d62f4a3265e99..1544970c96e3b7dfb9e8239490d29302f8d40bb1 100644 (file)
@@ -83,4 +83,7 @@ construction of a 2d plot of curves based on the scalar values from
 the table (see also: \ref creating_curves_page "Creating curves" and 
 \ref creating_plot2d_page "Creating Plot 2D presentation").
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_cut_lines_page "Cut Lines creation" operation.
+
 */
index 8d5f9ccfdad0c86b7a49d501f3ee3691e91c3848..66df53656ab08e9a6bc2983f2f9de73584be68d6 100644 (file)
@@ -52,4 +52,7 @@ After you have finished with setting these parameters, click \b
 OK. Your presentation with scalar bar will be immediately displayed in
 the viewer.
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_cut_planes_page "Cut Planes creation" operation.
+
 */
index c9d290308f14a56d8be2bd7ad076cb7c9946ed9d..7e1cf9f5a75c3630bc3747a390357ebb7d155e47 100644 (file)
@@ -63,4 +63,7 @@ based on the scalar values from the table (see also:
 \ref creating_curves_page "Creating curves" and 
 \ref creating_plot2d_page "Creating Plot 2D presentation").
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_cut_segment_page "Cut Segment creation" operation.
+
 */
index 028397c13deac65bc436310efbf1b268b42c7c13..5774a57a2246a2321c06d7918d1d141866d3cd15 100644 (file)
@@ -43,4 +43,7 @@ After you have finished with setting these parameters, click \b OK. Your
 presentation with scalar bar will be immediately displayed in the
 viewer.
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_def_shape_page "Deformed Shape creation" operation.
+
 */
\ No newline at end of file
index 345d82037776d3e205dd535c460350a2cd5b75eb..94a0c44b9e3d7b1b4a0a58550a5e6b7ef88269eb 100644 (file)
@@ -41,7 +41,7 @@ menu on the published object:
 
 \image html evolution_restore.png
 
-
-Our TUI Scripts provide you with \subpage tui_evolution_page script.
+<b>See Also</b> a sample TUI Script of an 
+\ref tui_evolution_page "Evolution on Point" operation.
 
 */
index fe28655feb0344eb2861815829721e0a2bb0d5b2..c27cb48fe65cbd237014283925a32a4f21ce5564 100644 (file)
@@ -29,6 +29,7 @@ Now it is possible to choose the \subpage types_of_gauss_points_presentations_pa
 To exit the dialog and apply choices press \b OK button, or press \b
 CANCEL button to quit.
 
-
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_gauss_points_page "Gauss Points creation" operation.
 
 */
\ No newline at end of file
index b66a117635882061f961ecb7452be831f3ddcc23..33ed005bd7b5454e18ad607f2f997f2ffaf8e95d 100644 (file)
@@ -46,4 +46,7 @@ Or you can export table to *.csv file
 </li>
 </ul>
 
+<b>See Also</b> a sample TUI Script of an
+\ref tui_table_import_page "Import/Export table" operation.
+
 */
index 5aa758cf1431d8b9bb24a4e1301b704817a4cf9c..aaf1e008e37b7b5e8d4a04af7d24b3dcd7e65bb7 100644 (file)
@@ -88,4 +88,7 @@ path and change the name of the exported MED file:
 
 To complete file export click <b>Save</b>.
 
+<br><b>See Also</b> a sample TUI Script of an 
+\ref tui_import_export_page "Import/Export" operation.
+
 */
index f6da3fe9d0c8b55cb81a9c73a586010a8dddba24..4190c9831aef76392b12641bd859175dcebaf043 100644 (file)
@@ -15,5 +15,6 @@ A MED file contains the description of a  \subpage med_object_page "MED object",
 
 \n The Python interface of \b Post-Pro module is described in \subpage
 idl_interface_page "Access to Post-Pro module functionality" page.
+\n Sample Python scripts can be found in \subpage python_examples_page chapter.
 
 */
index 2810f218ddeb711530b1b422267d4d2046986491..5cb8ba03a1046e46a6fd1ae8228fd9ba3e6a220c 100644 (file)
@@ -45,4 +45,7 @@ After you have finished with setting these parameters, click \b OK. Your
 presentation with scalar bar will be immediately displayed in the
 viewer.
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_iso_surf_page "Iso Surfaces creation" operation.
+
 */
\ No newline at end of file
index 1380992474c6f5f455842419df3743ed35a3485c..1b7183e720bf919c45f01ff7f185be2143749da7 100644 (file)
@@ -59,4 +59,7 @@ bar displayed with this presentation (\ref scalar_map_page "see also").
 After you have finished with setting these parameters, click \b
 OK. Your presentation  will be immediately displayed in the viewer.
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_plot_3d_page "Plot 3D creation" operation.
+
 */
\ No newline at end of file
index c7654438c08a27f2433875efa0bfdc624967b627..fbe6c9b04e4cc27567d6f7ee12513a15c52e31f7 100644 (file)
@@ -49,8 +49,8 @@ Here is a texture file sample:
 
 \image html custom_point_marker.png "Presentation with custom point markers"
 
-
-Our TUI Scripts provide you with \subpage tui_point_marker_page script.
+<b>See Also</b> a sample TUI Script of a 
+\ref tui_point_marker_page "Point Marker" functionality using.
 
 */
 
index e515cab2929d2fd1f55d5b4b82b1956ee15f42e4..ae93a6231bc9d2c19f4eab18f466cb3f6de93a56 100644 (file)
@@ -14,4 +14,7 @@ object and from the pop-up menu choose <b>Create Presentation</b>.
 <br><br>
 This presentation will be displayed in the viewer.
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_submesh_page "Submesh presentation creation" operation.
+
 */
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/python_examples.doc b/doc/salome/gui/VISU/input/python_examples.doc
new file mode 100644 (file)
index 0000000..e583799
--- /dev/null
@@ -0,0 +1,42 @@
+python_examples_page
+
+/*!
+
+\page python_examples_page Examples of Python scripts
+
+By the links below you can find sample scripts for operations
+provided by Post-Pro module.
+
+<ul>
+  <li>\subpage tui_import_export_page</li>
+  <li>\subpage tui_creating_3d_prs_page</li>
+  <ul>
+    <li>\ref tui_submesh_page</li>
+    <li>\ref tui_scalar_map_page</li>
+    <li>\ref tui_iso_surf_page</li>
+    <li>\ref tui_cut_planes_page</li>
+    <li>\ref tui_cut_lines_page</li>
+    <li>\ref tui_cut_segment_page</li>
+    <li>\ref tui_def_shape_page</li>
+    <li>\ref tui_def_shape_and_scalar_map_page</li>    
+    <li>\ref tui_vectors_page</li>
+    <li>\ref tui_stream_lines_page</li>
+    <li>\ref tui_plot_3d_page</li>
+    <li>\ref tui_gauss_points_page</li>
+  </ul>
+  <li>\subpage tui_datatable_page</li>
+  <ul>
+    <li>\ref tui_table_import_page</li>
+    <li>\ref tui_table_3d_page</li>
+    <li>\ref tui_table_curves_page</li>        
+  </ul>
+  <li>\subpage tui_manage_3d_prs_page</li>
+  <ul>
+    <li>\ref tui_view_3d_page</li>
+    <li>\ref tui_animation_page</li>
+    <li>\ref tui_evolution_page</li>
+    <li>\ref tui_point_marker_page</li>
+  </ul>
+</ul>
+
+*/
\ No newline at end of file
index 510585cae98bc7847a4274f73d9be2c6bf217fa9..71a03471a13743f648b9795404057ac3ae8ab289 100644 (file)
@@ -177,4 +177,7 @@ OK. The presentation will be immediately displayed in the viewer:
 
 \image html scalar_map_on_cells.png "Scalar map on Cell Mesh"
 
+<b>See Also</b> a sample TUI Script of a 
+\ref tui_scalar_map_page "Scalar Map creation" operation.
+
 */
index f5fac0df1df692284000ee0db96284e5ff582b30..dd5eb89f4da2160e91f637687cba00d100f0a563 100755 (executable)
@@ -45,4 +45,7 @@ You can compire result presentation with \ref scalar_map_page "Scalar Map" prese
 
 \image html scalar_map_on_cells.png "Example of Scalar Map presentation"
 
+<b>See Also</b> a sample TUI Script of a 
+\ref tui_def_shape_and_scalar_map_page "Deformed Shape and Scalar Map creation" operation.
+
 */
\ No newline at end of file
index b040a28727af9d7aa93fe7541283c073cd0a0a1b..82979ffd99a1f8b69982cd3e36580ec1f6eb87c2 100644 (file)
@@ -79,6 +79,9 @@ displayed with this presentation (\ref scalar_map_page "see also").
 
 After you have finished with setting these parameters, click \b
 OK. Your presentation with scalar bar will be immediately displayed in
-the viewer:
+the viewer.
+
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_stream_lines_page "Stream Lines creation" operation.
 
 */
\ No newline at end of file
index eb6798f2275665c96a72c53d42f712f4fc38e766..7fd97b9ce2e2c2d11cc2b9f3c2566d2b55bce2b0 100644 (file)
@@ -45,6 +45,7 @@ bar displayed with this presentation (\ref scalar_map_page "see also").</li>
 It is also possible to choose \b Wireframe or \b Shading \b Representation type, change
 such properties as \b Opacity and <b> Line Width </b> and <b> Translate </b> the presentation using the context menu.  
 
-
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_table_3d_page "Table 3D presentation creation" operation.
 
 */
diff --git a/doc/salome/gui/VISU/input/tui_animation.doc b/doc/salome/gui/VISU/input/tui_animation.doc
new file mode 100644 (file)
index 0000000..44166ef
--- /dev/null
@@ -0,0 +1,173 @@
+/*!
+
+\page tui_animation_page Animation
+
+Successive Animation example:
+
+\code
+import os
+from time import sleep
+
+import salome
+
+import VISU
+from visu_gui import *
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Import MED file 
+medFile = datadir + "/TimeStamps.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create 3D view
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+myView.SetTitle("Animation view")
+
+# Create animation instance
+fieldName = "vitesse"
+
+myAnimation = myVisu.CreateAnimation(myView);
+
+# Set successive animation mode
+myAnimation.setAnimationMode(VISU.Animation.SUCCESSIVE)
+
+# Set animation properties:
+
+# Add one field on which timestamps the animation will be performed
+fieldName = "vitesse, m/s"
+fieldSO = salome.myStudy.FindObject(fieldName)
+myAnimation.addField(fieldSO)
+
+# Set presentation type for the first and sole field
+myAnimation.setPresentationType(0, VISU.TDEFORMEDSHAPEANDSCALARMAP)
+
+# Generate presentations
+myAnimation.generatePresentations(0)
+
+# Create the pattern of Deformed Shape and Scalar Map presentation
+meshName = "dom"
+fieldName = "vitesse"
+fieldEntity = VISU.NODE
+timestampId = 1
+myDefShapeScalarMap = myVisu.DeformedShapeAndScalarMapOnField(myResult, meshName, fieldEntity, fieldName, timestampId)
+myDefShapeScalarMap.SetScale(0.75)
+
+# Apply the pattern properties to all generated presentations
+myAnimation.ApplyProperties(0, myDefShapeScalarMap)
+
+# Generate frames
+myAnimation.generateFrames()
+
+# Publisj animation object in study
+myAnimation.publishInStudy()
+
+# Set speed
+myAnimation.setSpeed(80)
+
+# Save animation after changing the speed
+myAnimation.saveAnimation()
+
+# Fit All
+myView.FitAll()
+
+# Start animation
+myAnimation.startAnimation()
+
+# Rewind to the first frame
+sleep(10)
+myAnimation.firstFrame()
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+<br>Parallel Animation example:
+
+\code
+import os
+from time import sleep
+
+import salome
+
+import VISU
+from visu_gui import *
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Import MED file 
+medFile = datadir + "/TimeStamps.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create 3D view
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+myView.SetTitle("Animation view")
+
+# Create animation instance
+fieldName = "vitesse"
+
+myAnimation = myVisu.CreateAnimation(myView);
+
+# Set successive animation mode
+myAnimation.setAnimationMode(VISU.Animation.PARALLEL)
+
+# Set animation properties:
+
+# Add two fields on which timestamps the animation will be performed
+fieldName1 = "vitesse, m/s"
+fieldSO1 = salome.myStudy.FindObject(fieldName1)
+fieldName2 = "temperature, K"
+fieldSO2 = salome.myStudy.FindObject(fieldName2)
+
+myAnimation.addField(fieldSO1)
+myAnimation.addField(fieldSO2)
+
+# Set presentation type for the first field
+myAnimation.setPresentationType(0, VISU.TVECTORS)
+
+# Set presentation type for the second field
+myAnimation.setPresentationType(1, VISU.TSCALARMAP)
+
+# Generate presentations for all fields
+nbFileds = myAnimation.getNbFields()
+for i in range(0, nbFileds):
+    myAnimation.generatePresentations(i)
+
+# Create the pattern of Vectors presentation
+meshName = "dom"
+fieldName = "vitesse"
+fieldEntity = VISU.NODE
+timestampId = 1
+myVectors = myVisu.VectorsOnField(myResult, meshName, fieldEntity, fieldName, timestampId)
+myVectors.SetScale(1)
+myVectors.ShowColored(True)
+
+# Apply the vectors pattern properties to all presentations generated for 'vitesse' field
+myAnimation.ApplyProperties(0, myVectors)
+
+# Generate frames
+myAnimation.generateFrames()
+
+# Publisj animation object in study
+myAnimation.publishInStudy()
+
+# Set speed
+myAnimation.setSpeed(95)
+
+# Fit All
+myView.FitAll()
+
+# Start animation
+myAnimation.startAnimation()
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+<br>Please, see \ref VISU.Animation "Animation interface reference documentation" 
+for more details.
+
+*/
diff --git a/doc/salome/gui/VISU/input/tui_creating_3d_prs.doc b/doc/salome/gui/VISU/input/tui_creating_3d_prs.doc
new file mode 100644 (file)
index 0000000..c5fb94a
--- /dev/null
@@ -0,0 +1,20 @@
+/*!
+
+\page tui_creating_3d_prs_page Creating 3D presentations
+
+<ul>
+<li>\subpage tui_submesh_page</li>
+<li>\subpage tui_scalar_map_page</li>
+<li>\subpage tui_iso_surf_page</li>
+<li>\subpage tui_cut_planes_page</li>
+<li>\subpage tui_cut_lines_page</li>
+<li>\subpage tui_cut_segment_page</li>
+<li>\subpage tui_def_shape_page</li>
+<li>\subpage tui_def_shape_and_scalar_map_page</li>
+<li>\subpage tui_vectors_page</li>
+<li>\subpage tui_stream_lines_page</li>
+<li>\subpage tui_plot_3d_page</li>
+<li>\subpage tui_gauss_points_page</li>
+</ul>
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_cut_lines.doc b/doc/salome/gui/VISU/input/tui_cut_lines.doc
new file mode 100644 (file)
index 0000000..45f5feb
--- /dev/null
@@ -0,0 +1,61 @@
+/*!
+
+\page tui_cut_lines_page Cut Lines
+
+Create Cut Lines on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create cut lines for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myCutLines = myVisu.CutLinesOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set orientation of the base plane (parallel to ZX)
+myCutLines.SetOrientation(VISU.CutPlanes.ZX, 0, 0)
+
+# Set orientation of the cutting planes (parallel to ZX)
+myCutLines.SetOrientation2(VISU.CutPlanes.XY, 0, 0)
+
+# Set number of lines
+myCutLines.SetNbLines(12)
+
+# Set displacement of the base plane
+myCutLines.SetDisplacement(0)
+
+# Set custom position for the first line
+newPos = (myCutLines.GetLinePosition(1) - myCutLines.GetLinePosition(0))/2
+myCutLines.SetLinePosition(0, newPos)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created cut lines
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myCutLines)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.CutLines "CutLines interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_cut_planes.doc b/doc/salome/gui/VISU/input/tui_cut_planes.doc
new file mode 100644 (file)
index 0000000..1057c5d
--- /dev/null
@@ -0,0 +1,59 @@
+/*!
+
+\page tui_cut_planes_page Cut Planes
+
+Create Cut Planes on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create cut planes for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myCutPlanes = myVisu.CutPlanesOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set number of planes
+myCutPlanes.SetNbPlanes(15)
+
+# Set orientation of the planes (parallel to XY), set rotation around Y to 0.5 radian
+myCutPlanes.SetOrientation(VISU.CutPlanes.XY, 0, 0.5)
+
+# Set scale
+myCutPlanes.UseDeformation(True)
+myCutPlanes.SetVectorialField(fieldEntity, fieldName)
+myCutPlanes.SetScale(0.05)
+
+# Set displacement
+myCutPlanes.SetDisplacement(0.1)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created cut planes
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myCutPlanes)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.CutPlanes "CutPlanes interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_cut_segment.doc b/doc/salome/gui/VISU/input/tui_cut_segment.doc
new file mode 100644 (file)
index 0000000..e9c3171
--- /dev/null
@@ -0,0 +1,54 @@
+/*!
+
+\page tui_cut_segment_page Cut Segment
+
+Create Cut Segment on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create cut segment for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myCutSegment = myVisu.CutSegmentOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set the first point of the segment
+myCutSegment.SetPoint1(0, 0, 0)
+
+# Set the second point of the segment
+myCutSegment.SetPoint2(0.41, 0.0685, 1.082)
+
+# Invert the resulting curve
+myCutSegment.SetAllCurvesInverted(True)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created cut segment
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myCutSegment)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.CutSegment "CutSegment interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_datatable.doc b/doc/salome/gui/VISU/input/tui_datatable.doc
new file mode 100644 (file)
index 0000000..4d48f44
--- /dev/null
@@ -0,0 +1,11 @@
+/*!
+
+\page tui_datatable_page DataTable
+
+<ul>
+<li>\subpage tui_table_import_page</li>
+<li>\subpage tui_table_3d_page</li>
+<li>\subpage tui_table_curves_page</li>
+</ul>
+
+*/
\ No newline at end of file
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..0729c29
--- /dev/null
@@ -0,0 +1,51 @@
+/*!
+
+\page tui_def_shape_page Deformed Shape
+
+Create Deformed Shape on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create 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 scale factor
+myDefShape.SetScale(0.25)
+
+# Set magnitude coloring
+myDefShape.ShowColored(True)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just 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.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_def_shape_and_scalar_map.doc b/doc/salome/gui/VISU/input/tui_def_shape_and_scalar_map.doc
new file mode 100644 (file)
index 0000000..c0cca6a
--- /dev/null
@@ -0,0 +1,53 @@
+/*!
+
+\page tui_def_shape_and_scalar_map_page Deformed Shape and Scalar Map
+
+Create Deformed Shape and Scalar Map presentation on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create deformed shape and scalar map for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myDefShapeScalarMap = myVisu.DeformedShapeAndScalarMapOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set scale
+myDefShapeScalarMap.SetScale(0.25)
+
+# Set 'TAUX_DE_VIDE' as scalar field, use first timestamp
+fieldName = 'TAUX_DE_VIDE'
+myDefShapeScalarMap.SetScalarField(VISU.NODE, fieldName, 1)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created presentation
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myDefShapeScalarMap)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.DeformedShapeAndScalarMap 
+"DeformedShapeAndScalarMap interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
index ea149e3338546e098ca3ccb0c1f5c07401eab174..7a56652f5fd8c8d55c23ff6dde98dea4f2e7f30d 100644 (file)
@@ -1,38 +1,54 @@
 /*!
 
-\page tui_evolution_page Example of Evolution on Point
+\page tui_evolution_page Evolution on Point
+
+Example of Evolution on Point:
 
 \code
 import os
+
+import salome
+
 import VISU
 from visu_gui import *
 
-myViewManager = myVisu.GetViewManager();
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Import MED file 
+medFile = datadir + "/TimeStamps.med"
+myResult = myVisu.ImportFile(medFile)
 
+# Create 2D viewer for the evolution graph:
+myViewManager = myVisu.GetViewManager();
 myView = myViewManager.CreateXYPlot();
 myView.SetTitle("The viewer for Evolution")
-print "myViewManager.CreateXYPlot()"
-
-medFile = "TimeStamps.med"
-medFile = os.getenv('DATA_DIR') + '/MedFiles/' + medFile
-myResult = myVisu.ImportFile(medFile)
 
-anEvolution = myVisu.CreateEvolution(myView);
+# Create evolution instance, use just created view
+myEvolution = myVisu.CreateEvolution(myView);
 
+# Get 'vitesse' field sobject
 aSObj = myStudy.FindObjectIOR(myResult.GetID())
-aSObj = aSObj.FindSubObject(1)[1] # dom
+aSObj = aSObj.FindSubObject(1)[1] # 'dom' mesh
 aSObj = aSObj.FindSubObject(3)[1] # Fields
-aSObj = aSObj.FindSubObject(2)[1] # vitesse
-print "setField : ", anEvolution.setField(aSObj)
+vitesseSO = aSObj.FindSubObject(2)[1] # 'vitesse' field
+myEvolution.setField(vitesseSO)
 
-anEvolution.setComponentId(1) # x component
+# Set "x" as a component
+myEvolution.setComponentId(1)
 
-anEvolution.setPointId(500)
-
-print "Show Evolution"
-anEvolution.showEvolution()
+# Set point via identifier
+myEvolution.setPointId(500)
 
+# Show Evolution
+myEvolution.showEvolution()
 myView.FitAll()
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
 \endcode
 
+<br>Please, see \ref VISU.Evolution "Evolution interface reference documentation" 
+for more details.
+
 */
diff --git a/doc/salome/gui/VISU/input/tui_gauss_points.doc b/doc/salome/gui/VISU/input/tui_gauss_points.doc
new file mode 100644 (file)
index 0000000..397ccbf
--- /dev/null
@@ -0,0 +1,94 @@
+/*!
+
+\page tui_gauss_points_page Gauss Points
+
+Create Gauss Points presentation on the field of the imported MED file:
+
+\code
+import os
+from time import sleep
+
+import salome
+import SALOMEDS
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/pointe.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create gauss points for the first timestamp of 'fieldcelldoublevector' field
+meshName = 'maa1'
+fieldEntity = VISU.CELL
+fieldName = 'fieldcelldoublevector'
+
+# Create Gauss Points presentation of the first type:
+# Results at Gauss Points
+myGaussPoints1 = myVisu.GaussPointsOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set range values (5-50%):
+myGaussPoints1.SetMinSize(0.05)
+myGaussPoints1.SetMaxSize(0.5)
+
+# Set OpenGL Points as a primitive type
+myGaussPoints1.SetPrimitiveType(VISU.GaussPoints.POINT)
+
+# Set points maximum size
+myGaussPoints1.SetClamp(32)
+
+# Create Gauss Points presentation of the second type:
+# Gauss Points on Geometry
+myGaussPoints2 = myVisu.GaussPointsOnField(myResult, meshName, fieldEntity, fieldName, 1)
+myGaussPoints2.SetIsColored(False)
+
+# Set magnification to 200%
+myGaussPoints2.SetMagnification(2)
+
+# Set magnification ratio
+myGaussPoints2.SetMagnificationIncrement(4)
+
+# Set size of points
+myGaussPoints2.SetGeomSize(0.25)
+
+# Set color of points
+myGaussPoints2.SetColor(SALOMEDS.Color(255, 90, 255))
+
+# Create Gauss Points presentation of the third type:
+# Gauss Points on Deformed Shape
+myGaussPoints3 = myVisu.GaussPointsOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Apply deformation
+myGaussPoints3.SetIsDeformed(True)
+myGaussPoints3.SetScaleFactor(0.4)
+
+# Set geometrical sphere as a primitive type
+myGaussPoints3.SetPrimitiveType(VISU.GaussPoints.SPHERE)
+
+# Set sphere resolution
+myGaussPoints3.SetResolution(5)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created presentations one by one
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+prsList = [myGaussPoints1, myGaussPoints2, myGaussPoints3]
+for prs in prsList:
+    myView.DisplayOnly(prs)
+    myView.FitAll()
+    sleep(5)
+\endcode
+
+<br>Please, see \ref VISU.GaussPoints "GaussPoints interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_import_export.doc b/doc/salome/gui/VISU/input/tui_import_export.doc
new file mode 100644 (file)
index 0000000..27d84c6
--- /dev/null
@@ -0,0 +1,59 @@
+/*!
+
+\page tui_import_export_page Import/Export MED
+
+Import MED file:
+
+\code
+import os
+
+import salome
+
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# MED file path
+medFile = datadir + "/fra.med"
+
+# Import MED file
+myResult = myVisu.ImportFile(medFile)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+<br>Export to MED file:
+
+\code
+import os
+
+import salome
+
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# MED file path
+medFile = datadir + "/fra.med"
+
+# Import MED file
+myResult = myVisu.ImportFile(medFile)
+
+# Export MED file
+newFileName = datadir + "/fra_copy.med"
+myResult.ExportMED(newFileName)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_iso_surf.doc b/doc/salome/gui/VISU/input/tui_iso_surf.doc
new file mode 100644 (file)
index 0000000..6a00ccd
--- /dev/null
@@ -0,0 +1,51 @@
+/*!
+
+\page tui_iso_surf_page Iso Surfaces
+
+Create Iso Surfaces on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create iso surfaces for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myIsoSurfaces = myVisu.IsoSurfacesOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set number of surfaces
+myIsoSurfaces.SetNbSurfaces(12)
+
+# Show two value labels per surface
+myIsoSurfaces.ShowLabels(True, 2)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created iso surfaces
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myIsoSurfaces)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.IsoSurfaces "IsoSurfaces interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_manage_3d_prs.doc b/doc/salome/gui/VISU/input/tui_manage_3d_prs.doc
new file mode 100644 (file)
index 0000000..6b7a298
--- /dev/null
@@ -0,0 +1,12 @@
+/*!
+
+\page tui_manage_3d_prs_page Managing 3D Presentations
+
+<ul>
+<li>\subpage tui_view_3d_page</li>
+<li>\subpage tui_animation_page</li>
+<li>\subpage tui_evolution_page</li>
+<li>\subpage tui_point_marker_page</li>
+</ul>
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_plot_3d.doc b/doc/salome/gui/VISU/input/tui_plot_3d.doc
new file mode 100644 (file)
index 0000000..a2997d5
--- /dev/null
@@ -0,0 +1,60 @@
+/*!
+
+\page tui_plot_3d_page Plot 3D
+
+Create Plot 3D presentation on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create plot 3d for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myPlot3D = myVisu.Plot3DOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set cut plane orientation
+myPlot3D.SetOrientation(VISU.Plot3D.ZX, 0, 0)
+
+# Set relative position of the plane
+myPlot3D.SetPlanePosition(0.8, True)
+
+# Set scale factor
+myPlot3D.SetScaleFactor(0.25)
+
+# Set contour as a presentation type
+myPlot3D.SetContourPrs(True)
+
+# Set number of contours
+myPlot3D.SetNbOfContours(100)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created plot 3d presentation
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myPlot3D)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.Plot3D "Plot3D interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
index 1199dc9af162d50f773c52c31422707abeed0414..b11938be26886fb600a4f7915f987e41fb0364cf 100644 (file)
@@ -1,48 +1,61 @@
 /*!
 
-\page tui_point_marker_page Example of using Point Markers
+\page tui_point_marker_page Point Marker
+
+Example of using Point Markers:
 
 \code
 import os
-import time
+from time import sleep
+
+import salome
+
 import VISU
 from visu_gui import *
 
-data_dir = os.getenv("DATA_DIR")
-sleep_delay = 2
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
 
-myViewManager = myVisu.GetViewManager();
+# Import MED file 
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
 
-myView = myViewManager.Create3DView()
-myView.SetTitle("The viewer for Point Marker Example")
-print "myViewManager.Create3DView()"
+# Create scalar map for the first timestamp of 'VITESSE' field
+meshName = "LE VOLUME"
+fieldEntity =  VISU.NODE
+fieldName = "VITESSE"
+timeStampId = 1
 
-medFile = "fra.med"
-medFile = data_dir + '/MedFiles/' + medFile
-myResult = myVisu.ImportFile(medFile)
+myScalarMap = myVisu.ScalarMapOnField(myResult, meshName, fieldEntity, fieldName, timeStampId)
 
-aMeshName ="LE VOLUME"
-anEntity = VISU.NODE
-aFieldName = "VITESSE";
-aTimeStampId = 1
+# Create 3D view
+myViewManager = myVisu.GetViewManager();
+myView = myViewManager.Create3DView()
+myView.SetTitle("The viewer for Point Marker example")
 
-aScalarMap = myVisu.ScalarMapOnField(myResult,aMeshName,anEntity,aFieldName,aTimeStampId)
-myView.Display(aScalarMap);
+# Display just created scalar map
+myView.DisplayOnly(myScalarMap);
 myView.FitAll();
 
-print "Set representation type to Point"
-myView.SetPresentationType(aScalarMap, VISU.POINT)
+# Set the scalar map representation type to point
+myView.SetPresentationType(myScalarMap, VISU.POINT)
 
-print "Set standard marker"
-aScalarMap.SetMarkerStd(VISU.MT_PLUS, VISU.MS_25)
+# Set standard marker
+myScalarMap.SetMarkerStd(VISU.MT_O_PLUS, VISU.MS_25)
 myView.Update()
-time.sleep(sleep_delay)
+sleep(5)
 
-print "Set custom marker"
-custom_texture = myVisu.LoadTexture(os.path.join(data_dir, "Textures", "texture1.dat"))
-aScalarMap.SetMarkerTexture(custom_texture)
+# Set custom marker
+textureFile = os.path.join(datadir, "Textures", "texture1.dat")
+custom_texture = myVisu.LoadTexture(textureFile)
+myScalarMap.SetMarkerTexture(custom_texture)
 myView.Update()
 
+# Update object browser
+salome.sg.updateObjBrowser(1)
 \endcode
 
+<br>Please, see \ref VISU.Prs3d "Prs3d interface reference documentation" 
+for more details.
+
 */
diff --git a/doc/salome/gui/VISU/input/tui_scalar_map.doc b/doc/salome/gui/VISU/input/tui_scalar_map.doc
new file mode 100644 (file)
index 0000000..2a20306
--- /dev/null
@@ -0,0 +1,51 @@
+/*!
+
+\page tui_scalar_map_page Scalar Map
+
+Create Scalar Map on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/pointe.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create scalar map for the first timestamp of 'fieldcelldoublevector' field
+meshName = 'maa1'
+fieldEntity = VISU.CELL
+fieldName = 'fieldcelldoublevector'
+myScalarMap = myVisu.ScalarMapOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set logarithmic scaling
+myScalarMap.SetScaling(VISU.LOGARITHMIC)
+
+# Set scalar range to [2, 5]
+myScalarMap.SetRange(2, 5)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created scalar map
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myScalarMap)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.ScalarMap "ScalarMap interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_stream_lines.doc b/doc/salome/gui/VISU/input/tui_stream_lines.doc
new file mode 100644 (file)
index 0000000..9a035c5
--- /dev/null
@@ -0,0 +1,59 @@
+/*!
+
+\page tui_stream_lines_page Stream Lines
+
+Create Stream Lines on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create stream lines for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myStreamLines = myVisu.StreamLinesOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set stream lines parameters
+integrationStep = 0.003
+propagationTime = 1.5
+stepLength = 0.015
+# Mesh on nodes
+prs3D = myVisu.MeshOnEntity(myResult, meshName, VISU.NODE) 
+pointsPercents = 0.05
+direction = VISU.StreamLines.FORWARD
+
+myStreamLines.SetParams(integrationStep, propagationTime, stepLength, prs3D, pointsPercents, direction)
+
+# Set magnitude coloring
+myStreamLines.ShowColored(True)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created stream lines
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myStreamLines)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.StreamLines "StreamLines interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_submesh.doc b/doc/salome/gui/VISU/input/tui_submesh.doc
new file mode 100644 (file)
index 0000000..5dde8dd
--- /dev/null
@@ -0,0 +1,64 @@
+/*!
+
+\page tui_submesh_page Submesh presentation
+
+Display different submeshes of the imported MED file:
+
+\code
+import os
+from time import sleep
+
+import salome
+import SALOMEDS
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/pointe.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create submesh presentations
+meshName = 'maa1'
+cellEntity = VISU.CELL
+nodeEntity = VISU.NODE
+
+mySubMeshes = []
+
+# Submesh on nodes
+myOnNodes = myVisu.MeshOnEntity(myResult, meshName, nodeEntity)
+mySubMeshes.append(myOnNodes)
+
+# Submesh on family (one cell)
+familyName = 'FAMILLE_ELEMENT_1'
+myOnFamily = myVisu.FamilyMeshOnEntity(myResult, meshName, cellEntity, familyName)
+mySubMeshes.append(myOnFamily)
+
+# Submesh on group (several cells)
+groupName = 'groupe1'
+myOnGroup = myVisu.GroupMesh(myResult, meshName, groupName)
+mySubMeshes.append(myOnGroup)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created presentations one by one
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+for submesh in mySubMeshes:
+    myView.DisplayOnly(submesh)
+    myView.FitAll()
+    sleep(5)
+\endcode
+
+<br>Please, see \ref VISU.Mesh "Mesh interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_table_3d.doc b/doc/salome/gui/VISU/input/tui_table_3d.doc
new file mode 100644 (file)
index 0000000..183f345
--- /dev/null
@@ -0,0 +1,53 @@
+/*!
+
+\page tui_table_3d_page Table 3D presentation 
+
+Create and display Table 3D presentation:
+
+\code
+import os
+
+import salome
+
+import visu_gui
+
+# Directory containing data table files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import tables from file
+tableFile = datadir + '/table_test.xls'
+myTablesSO = myVisu.ImportTables(tableFile, False)
+
+# Create table presentation
+table = None
+anIsFound, aTableSO = myTablesSO.FindSubObject(1)
+if anIsFound:
+      anID = aTableSO.GetID()
+      table = myVisu.CreateTable(anID)
+      # Set 'Contour' presentation type
+      table.SetContourPrs(1)
+      # Set number od contours
+      table.SetNbOfContours(1024)
+      # Set scale factor
+      table.SetScaleFactor(0.2)
+
+# Show table presentation
+if (table is not None):
+    # Display just created tabel presentation
+    myViewManager = myVisu.GetViewManager()
+    myView = myViewManager.Create3DView()
+
+    myView.DisplayOnly(table)
+    myView.FitAll()
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+<br>Please, see \ref VISU.Table "Table interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_table_curves.doc b/doc/salome/gui/VISU/input/tui_table_curves.doc
new file mode 100644 (file)
index 0000000..4e83e25
--- /dev/null
@@ -0,0 +1,75 @@
+/*!
+
+\page tui_table_curves_page Curves
+
+Create and display curves using the imported table:
+
+\code
+import os
+from time import sleep
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing data table files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import tables from file
+tableFile = datadir + '/table_test.xls'
+myTablesSO = myVisu.ImportTables(tableFile, False)
+
+# Get table
+anIsFound, myTableSO = myTablesSO.FindSubObject(1)
+anID = myTableSO.GetID()
+myTable = myVisu.CreateTable(anID)
+
+# Create table view
+myViewManager = myVisu.GetViewManager()
+myTableView = myViewManager.CreateTableView(myTable)
+myTableView.SetTitle('My Curves')
+
+# Create container for a set of curves
+myContainer = myVisu.CreateContainer()
+
+# Create curves
+aNbCurves = myTable.GetNbRows()
+aCurve = None
+for i in range(1, aNbCurves):
+   aCurve = myVisu.CreateCurve( myTable, 1, i )
+   myContainer.AddCurve(aCurve)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Create Plot 2D view
+myView = myViewManager.CreateXYPlot();
+myView.SetTitle("The viewer for My Curves")
+
+# Display all curves (i.e. container)
+myView.Display(myContainer)
+sleep(5)
+
+# Set curves displaying mode
+myView.SetCurveType(VISU.XYPlot.SPLINE)
+# Set marker size
+myView.SetMarkerSize(15)
+
+# Change display parameters of the last created curve
+# Marker type
+aCurve.SetMarker(VISU.Curve.CIRCLE)
+# Line type and width
+aCurve.SetLine(VISU.Curve.SOLIDLINE, 4)
+
+# Display only the last created curve
+myView.DisplayOnly(aCurve)
+\endcode
+
+<br>Please, see \ref VISU.Curve "Curve interface reference documentation" and
+\ref VISU.XYPlot "XYPlot interface reference documentation" for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_table_import.doc b/doc/salome/gui/VISU/input/tui_table_import.doc
new file mode 100644 (file)
index 0000000..6ebef47
--- /dev/null
@@ -0,0 +1,67 @@
+/*!
+
+\page tui_table_import_page Import/Export table
+
+Import tables from file:
+
+\code
+import os
+
+import salome
+
+import visu_gui
+
+# Directory containing data table files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import tables from file
+tableFile = datadir + '/tables_test.xls'
+myTablesSO = myVisu.ImportTables(tableFile, False)
+
+# Print table names
+print "\nNames of the imported tables:"
+iter = salome.myStudy.NewChildIterator(myTablesSO)
+while iter.More():
+    aTableSO = iter.Value()
+    if aTableSO:
+        aTable = aTableSO.GetObject()
+        print "\n", aTable.GetTitle()
+    iter.Next()
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+<br>Export table to the file:
+
+\code
+import os
+
+import salome
+
+import visu_gui
+
+# Directory containing data table files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import tables from file
+tableFile = datadir + '/tables_test.xls'
+myTablesSO = myVisu.ImportTables(tableFile, False)
+
+# Export first of the imported tables to the new file
+expTableFile =  datadir + '/sinus_table.txt'
+
+sinusTableSO = salome.myStudy.FindObject("sinus")
+myVisu.ExportTableToFile(sinusTableSO, expTableFile)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_vectors.doc b/doc/salome/gui/VISU/input/tui_vectors.doc
new file mode 100644 (file)
index 0000000..6792e81
--- /dev/null
@@ -0,0 +1,60 @@
+/*!
+
+\page tui_vectors_page Vectors
+
+Create Vectors on the field of the imported MED file:
+
+\code
+import os
+
+import salome
+
+import VISU
+import visu_gui
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Get VISU engine
+myVisu = visu_gui.myVisu
+
+# Import MED file
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create vectors for the first timestamp of 'VITESSE' field
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+myVectors = myVisu.VectorsOnField(myResult, meshName, fieldEntity, fieldName, 1)
+
+# Set scale factor
+myVectors.SetScale(0.1)
+
+# Set magnitude coloring
+myVectors.ShowColored(True)
+
+# Set line width
+myVectors.SetLineWidth(2)
+
+# Set the type of representation of the vector head (arrow)
+myVectors.SetGlyphType(VISU.Vectors.ARROW)
+
+# Set the position of the vector head (center)
+myVectors.SetGlyphPos(VISU.Vectors.CENTER)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+
+# Display just created vectors
+myViewManager = myVisu.GetViewManager()
+myView = myViewManager.Create3DView()
+
+myView.DisplayOnly(myVectors)
+myView.FitAll()
+\endcode
+
+<br>Please, see \ref VISU.Vectors "Vectors interface reference documentation" 
+for more details.
+
+*/
\ No newline at end of file
diff --git a/doc/salome/gui/VISU/input/tui_view_3d.doc b/doc/salome/gui/VISU/input/tui_view_3d.doc
new file mode 100644 (file)
index 0000000..69d0bb9
--- /dev/null
@@ -0,0 +1,197 @@
+/*!
+
+\page tui_view_3d_page Viewing 3D presentations
+
+Examples of using 3D viewer functionaly from Python:
+
+\code
+import os
+from time import sleep
+
+import salome
+
+import VISU
+from visu_gui import *
+
+# Delay
+delay = 4
+
+# Directory containing MED files
+datadir = os.getenv("DATA_DIR")
+
+# Create temporary 3D view
+print "Create temporary 3D view..."
+myViewManager = myVisu.GetViewManager()
+myTempView = myViewManager.Create3DView()
+myTempView.SetTitle("The window will be soon destroyed!")
+sleep(delay)
+
+# Destroy the view
+print "Destroy the view..."
+myViewManager.Destroy(myTempView)
+sleep(delay)
+
+# Import MED file 
+medFile = datadir + "/fra.med"
+myResult = myVisu.ImportFile(medFile)
+
+# Create scalar map
+meshName = 'LE VOLUME'
+fieldEntity = VISU.NODE
+fieldName = 'VITESSE'
+timestampId = 1
+myScalarMap = myVisu.ScalarMapOnField(myResult, meshName, fieldEntity, fieldName, timestampId)
+
+# Create new 3D view
+print "Create new 3D view..."
+myView = myViewManager.Create3DView()
+
+# Set background
+print "Set blue background..."
+bgColor = SALOMEDS.Color(0.0, 0.3, 1.0)
+myView.SetBackground(bgColor)
+myView.Update()
+sleep(delay)
+
+# Display just created scalar map
+print "Display scalar map..."
+myView.Display(myScalarMap)
+sleep(delay)
+
+# Fit all
+print "Fit all..."
+myView.FitAll()
+sleep(delay)
+
+# Set the point of sight of the camera
+print "Set the point of sight of the camera..."
+myView.SetFocalPoint([1,5,10])
+myView.Update()
+sleep(delay)
+
+# Fit all
+print "Fit all..."
+myView.FitAll()
+sleep(delay)
+
+# Change scalar map range
+print "Change scalar map range..."
+myScalarMap.SetRange(0.2, 0.9)
+sleep(delay)
+
+# Update the view
+print "Update the view..."
+myView.Update()
+sleep(delay)
+
+# Scale view
+print "Scale view..."
+myView.ScaleView(VISU.View3D.YAxis,10.0)
+myView.ScaleView(VISU.View3D.XAxis,3.0)
+myView.Update()
+sleep(delay)
+
+# Set the position of the camera in 3D space
+print "Set the position of the camera in 3D space..."
+myView.SetPointOfView([0.01, 0.05, 0.03])
+myView.Update()
+sleep(delay)
+
+# Fit all
+print "Fit all..."
+myView.FitAll()
+sleep(delay)
+
+# Store view parameters
+stateName = "State1"
+myView.SaveViewParams(stateName)
+
+# Remove scaling
+print "Remove scale..."
+myView.RemoveScale()
+sleep(delay)
+
+# Change background
+print "Set dark background..."
+bgColor = SALOMEDS.Color(0.0, 0.1, 0.2)
+myView.SetBackground(bgColor)
+sleep(delay)
+
+# Update view
+print "Update view..."
+myView.Update()
+sleep(delay)
+
+# Set top view
+print "Set top view..."
+myView.SetView(VISU.View3D.TOP)
+sleep(delay)
+
+# Zoomig out
+print "Zoomig out..."
+aScale = myView.GetParallelScale()
+for i in range(0,50) :
+    aScale = aScale + 0.05
+    myView.SetParallelScale(aScale)
+    myView.Update()
+    
+sleep(delay)
+
+# Zooming in
+print "Zooming in..."
+for i in range(0,75) :
+    aScale = aScale - 0.05
+    myView.SetParallelScale(aScale)
+    myView.Update()
+    
+sleep(delay)
+
+# Set the vertical line of the camera in 3D space
+print "Set the vertical line of the camera in 3D space..."
+aViewUp = myView.GetViewUp()
+for i in range(0,40) :
+    aViewUp[0] = aViewUp[0] + 0.1
+    myView.SetViewUp(aViewUp) 
+    myView.Update()
+
+sleep(delay)
+
+# Rotating Y
+print "Rotating Y..."
+aPoint = myView.GetPointOfView()
+for i in range(0,150) :
+    aPoint[1] = aPoint[1] + 1
+    myView.SetPointOfView(aPoint) 
+    myView.Update()
+
+sleep(delay)
+
+# Restore view parameters
+print "Restore view parameters..."
+myView.RestoreViewParams(stateName)
+sleep(delay)
+
+# Change presentation parameters:
+
+# Make the scalar map shrinked
+print "Make the scalar map shrinked..."
+myView.SetShrinked(myScalarMap, True)
+sleep(delay)
+
+# Set presentation type
+print "Set presentation type to SURFACEFRAME..."
+myView.SetPresentationType(myScalarMap, VISU.SURFACEFRAME)
+sleep(delay)
+
+print "Set presentation type to FEATURE_EDGES..."
+myView.SetPresentationType(myScalarMap, VISU.FEATURE_EDGES)
+sleep(delay)
+
+# Update object browser
+salome.sg.updateObjBrowser(1)
+\endcode
+
+<br>Please, see \ref VISU.View3D "View3D interface reference documentation" 
+for more details.
+
+*/
index 4b2509955d07162d50caf0ea02b902f2988b0d1c..2eff222319e433104e2d4898fab329e11b8417fb 100644 (file)
@@ -43,6 +43,9 @@ scalar bar displayed with this presentation (\ref scalar_map_page "see also").</
 
 After you have finished with setting these parameters, click \b
 OK. Your presentation with scalar bar will be immediately displayed in
-the viewer:
+the viewer.
+
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_vectors_page "Vectors creation" operation.
 
 */
index 0ea0cecc5ac7c5403da3cc83b9fb1eb0cac07104..8b15e2bf85be5a7a58db99e52b2ae6e714219afa 100644 (file)
@@ -160,4 +160,7 @@ the pop-up menu select <b>Merge Scalar Range</b>.
 To restore separate bars and scales for each module select <b>Use
 Field Range</b> from the same menu.
 
+<br><b>See Also</b> a sample TUI Script of a 
+\ref tui_view_3d_page "Viewing 3D presentations".
+
 */