From 7896c77540da9cbfc70bf53a2d8331624a693bb0 Mon Sep 17 00:00:00 2001 From: vsr Date: Wed, 20 Oct 2010 11:20:47 +0000 Subject: [PATCH] Update documentation for 5.1.5 --- doc/salome/gui/VISU/input/animating.doc | 6 +- doc/salome/gui/VISU/input/creating_curves.doc | 6 +- doc/salome/gui/VISU/input/creating_plot2d.doc | 4 +- doc/salome/gui/VISU/input/cut_lines.doc | 4 +- doc/salome/gui/VISU/input/cut_planes.doc | 4 +- doc/salome/gui/VISU/input/cut_segment.doc | 4 +- doc/salome/gui/VISU/input/deformed_shape.doc | 6 +- doc/salome/gui/VISU/input/evolution.doc | 4 +- .../VISU/input/gauss_points_presentations.doc | 6 +- .../input/importing_exporting_tables_page.doc | 4 +- .../gui/VISU/input/importing_med_objects.doc | 4 +- doc/salome/gui/VISU/input/iso_surfaces.doc | 6 +- doc/salome/gui/VISU/input/plot_3d.doc | 6 +- doc/salome/gui/VISU/input/point_marker.doc | 4 +- .../VISU/input/presentation_of_submesh.doc | 6 +- doc/salome/gui/VISU/input/scalar_map.doc | 4 +- .../input/scalar_map_on_deformed_shape.doc | 7 ++- doc/salome/gui/VISU/input/stream_lines.doc | 6 +- doc/salome/gui/VISU/input/table_3d.doc | 4 +- doc/salome/gui/VISU/input/tui_animation.doc | 56 ++++++++--------- doc/salome/gui/VISU/input/tui_cut_lines.doc | 22 +++---- doc/salome/gui/VISU/input/tui_cut_planes.doc | 20 +++--- doc/salome/gui/VISU/input/tui_cut_segment.doc | 14 ++--- doc/salome/gui/VISU/input/tui_def_shape.doc | 16 ++--- .../input/tui_def_shape_and_scalar_map.doc | 18 +++--- doc/salome/gui/VISU/input/tui_evolution.doc | 18 +++--- .../gui/VISU/input/tui_gauss_points.doc | 29 ++++----- .../gui/VISU/input/tui_import_export.doc | 24 +++---- doc/salome/gui/VISU/input/tui_iso_surf.doc | 14 ++--- doc/salome/gui/VISU/input/tui_plot_3d.doc | 24 +++---- .../gui/VISU/input/tui_point_marker.doc | 59 ++++++++---------- doc/salome/gui/VISU/input/tui_scalar_map.doc | 16 ++--- .../gui/VISU/input/tui_stream_lines.doc | 12 ++-- doc/salome/gui/VISU/input/tui_submesh.doc | 18 +++--- doc/salome/gui/VISU/input/tui_table_3d.doc | 12 ++-- .../gui/VISU/input/tui_table_curves.doc | 24 +++---- .../gui/VISU/input/tui_table_import.doc | 12 ++-- doc/salome/gui/VISU/input/tui_view_3d.doc | 62 +++++++++---------- doc/salome/gui/VISU/input/vectors.doc | 2 +- .../VISU/input/viewing_3d_presentations.doc | 4 +- 40 files changed, 280 insertions(+), 291 deletions(-) diff --git a/doc/salome/gui/VISU/input/animating.doc b/doc/salome/gui/VISU/input/animating.doc index d1298a90..896f01da 100644 --- a/doc/salome/gui/VISU/input/animating.doc +++ b/doc/salome/gui/VISU/input/animating.doc @@ -115,7 +115,7 @@ your animation with proportional periods of time between every frame Time stamp frequency spin box: this option is available if Save animation to AVI file mode is turned on. It provides a possibility to capture only timestamps with indices divisible by the -specified frequency, that allows to generate less voluminous films. +specified frequency, which allows to generate less voluminous films.

Clean memory at each frame - this option allows to optimize the performance of the operation. @@ -139,7 +139,7 @@ to study again you get another animation in the Object Browser. Publish to Study - saves your animation in the study and presents it in the Object Browser. -
See Also a sample TUI Script of an -\ref tui_animation_page "Animation" creation. +
See Also a sample script of using +\ref tui_animation_page "Animation" via TUI. */ diff --git a/doc/salome/gui/VISU/input/creating_curves.doc b/doc/salome/gui/VISU/input/creating_curves.doc index 61a20de7..33919483 100644 --- a/doc/salome/gui/VISU/input/creating_curves.doc +++ b/doc/salome/gui/VISU/input/creating_curves.doc @@ -30,7 +30,7 @@ the Plot2d viewer.
  • \b V2 (vertical right) - the values of this column will correspond to Y-coordinates of the curve to be attached to the right vertical axis of the Plot2d viewer.
    • -\note If there are several curves attached both to left and right +\note If there are several curves attached both to the left and the right vertical axes, they will be indicated by the following icons in the legend: \image html axis_bottom_left.png @@ -72,7 +72,7 @@ be created automatically. -
    See Also a sample TUI Script of a -\ref tui_table_curves_page "Curves creation and displaying" operation. +
    See Also a sample TUI Script of +\ref tui_table_curves_page "Curves creation and displaying". */ diff --git a/doc/salome/gui/VISU/input/creating_plot2d.doc b/doc/salome/gui/VISU/input/creating_plot2d.doc index c5f98fc0..b829ac43 100755 --- a/doc/salome/gui/VISU/input/creating_plot2d.doc +++ b/doc/salome/gui/VISU/input/creating_plot2d.doc @@ -57,8 +57,8 @@ selected curve lines, will be displayed in the viewer: -See Also a sample TUI Script of a -\ref tui_table_curves_page "Curves creation and displaying" operation. +See Also a sample script of +\ref tui_table_curves_page "Curves creation and displaying" via TUI. */ diff --git a/doc/salome/gui/VISU/input/cut_lines.doc b/doc/salome/gui/VISU/input/cut_lines.doc index 1544970c..49739925 100644 --- a/doc/salome/gui/VISU/input/cut_lines.doc +++ b/doc/salome/gui/VISU/input/cut_lines.doc @@ -83,7 +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"). -
    See Also a sample TUI Script of a -\ref tui_cut_lines_page "Cut Lines creation" operation. +
    See Also a sample TUI Script of +\ref tui_cut_lines_page "Cut Lines" presentation operation. */ diff --git a/doc/salome/gui/VISU/input/cut_planes.doc b/doc/salome/gui/VISU/input/cut_planes.doc index 66df5365..258683db 100644 --- a/doc/salome/gui/VISU/input/cut_planes.doc +++ b/doc/salome/gui/VISU/input/cut_planes.doc @@ -52,7 +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. -
    See Also a sample TUI Script of a -\ref tui_cut_planes_page "Cut Planes creation" operation. +
    See Also a sample TUI Script of +\ref tui_cut_planes_page "Cut Planes" presentation creation. */ diff --git a/doc/salome/gui/VISU/input/cut_segment.doc b/doc/salome/gui/VISU/input/cut_segment.doc index 7e1cf9f5..096e8961 100644 --- a/doc/salome/gui/VISU/input/cut_segment.doc +++ b/doc/salome/gui/VISU/input/cut_segment.doc @@ -63,7 +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"). -
    See Also a sample TUI Script of a -\ref tui_cut_segment_page "Cut Segment creation" operation. +
    See Also a sample TUI Script of +\ref tui_cut_segment_page "Cut Segment" presentation creation. */ diff --git a/doc/salome/gui/VISU/input/deformed_shape.doc b/doc/salome/gui/VISU/input/deformed_shape.doc index 5774a57a..88ceebcb 100644 --- a/doc/salome/gui/VISU/input/deformed_shape.doc +++ b/doc/salome/gui/VISU/input/deformed_shape.doc @@ -43,7 +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. -
    See Also a sample TUI Script of a -\ref tui_def_shape_page "Deformed Shape creation" operation. +
    See Also a sample TUI Script of +\ref tui_def_shape_page "Deformed Shape" presentation creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/evolution.doc b/doc/salome/gui/VISU/input/evolution.doc index 94a0c44b..bacaacd9 100644 --- a/doc/salome/gui/VISU/input/evolution.doc +++ b/doc/salome/gui/VISU/input/evolution.doc @@ -41,7 +41,7 @@ menu on the published object: \image html evolution_restore.png -See Also a sample TUI Script of an -\ref tui_evolution_page "Evolution on Point" operation. +See Also a sample script of using +\ref tui_evolution_page "Evolution on Point" operation via TUI. */ diff --git a/doc/salome/gui/VISU/input/gauss_points_presentations.doc b/doc/salome/gui/VISU/input/gauss_points_presentations.doc index c27cb48f..0f989d67 100644 --- a/doc/salome/gui/VISU/input/gauss_points_presentations.doc +++ b/doc/salome/gui/VISU/input/gauss_points_presentations.doc @@ -29,7 +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. -
    See Also a sample TUI Script of a -\ref tui_gauss_points_page "Gauss Points creation" operation. +
    See Also a sample TUI Script of +\ref tui_gauss_points_page "Gauss Points presentations" creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/importing_exporting_tables_page.doc b/doc/salome/gui/VISU/input/importing_exporting_tables_page.doc index 33ed005b..42341571 100644 --- a/doc/salome/gui/VISU/input/importing_exporting_tables_page.doc +++ b/doc/salome/gui/VISU/input/importing_exporting_tables_page.doc @@ -46,7 +46,7 @@ Or you can export table to *.csv file -See Also a sample TUI Script of an -\ref tui_table_import_page "Import/Export table" operation. +See Also a sample script of +\ref tui_table_import_page "Import/Export" of tables via TUI. */ diff --git a/doc/salome/gui/VISU/input/importing_med_objects.doc b/doc/salome/gui/VISU/input/importing_med_objects.doc index aaf1e008..e7a004b1 100644 --- a/doc/salome/gui/VISU/input/importing_med_objects.doc +++ b/doc/salome/gui/VISU/input/importing_med_objects.doc @@ -88,7 +88,7 @@ path and change the name of the exported MED file: To complete file export click Save. -
    See Also a sample TUI Script of an -\ref tui_import_export_page "Import/Export" operation. +
    See Also a sample script of +\ref tui_import_export_page "Import/Export" of MED objects via TUI. */ diff --git a/doc/salome/gui/VISU/input/iso_surfaces.doc b/doc/salome/gui/VISU/input/iso_surfaces.doc index 5cb8ba03..fd391402 100644 --- a/doc/salome/gui/VISU/input/iso_surfaces.doc +++ b/doc/salome/gui/VISU/input/iso_surfaces.doc @@ -45,7 +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. -
    See Also a sample TUI Script of a -\ref tui_iso_surf_page "Iso Surfaces creation" operation. +
    See Also a sample TUI Script of +\ref tui_iso_surf_page "Iso Surfaces presentation" creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/plot_3d.doc b/doc/salome/gui/VISU/input/plot_3d.doc index 1b7183e7..fe5ecbb9 100644 --- a/doc/salome/gui/VISU/input/plot_3d.doc +++ b/doc/salome/gui/VISU/input/plot_3d.doc @@ -59,7 +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. -
    See Also a sample TUI Script of a -\ref tui_plot_3d_page "Plot 3D creation" operation. +
    See Also a sample TUI Script of +\ref tui_plot_3d_page "Plot 3D presentation" creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/point_marker.doc b/doc/salome/gui/VISU/input/point_marker.doc index fbe6c9b0..4df393bf 100644 --- a/doc/salome/gui/VISU/input/point_marker.doc +++ b/doc/salome/gui/VISU/input/point_marker.doc @@ -49,8 +49,8 @@ Here is a texture file sample: \image html custom_point_marker.png "Presentation with custom point markers" -See Also a sample TUI Script of a -\ref tui_point_marker_page "Point Marker" functionality using. +See Also a sample script of using +\ref tui_point_marker_page "Point Marker" functionality via TUI. */ diff --git a/doc/salome/gui/VISU/input/presentation_of_submesh.doc b/doc/salome/gui/VISU/input/presentation_of_submesh.doc index ae93a623..c2660a1d 100644 --- a/doc/salome/gui/VISU/input/presentation_of_submesh.doc +++ b/doc/salome/gui/VISU/input/presentation_of_submesh.doc @@ -14,7 +14,7 @@ object and from the pop-up menu choose Create Presentation.

    This presentation will be displayed in the viewer. -
    See Also a sample TUI Script of a -\ref tui_submesh_page "Submesh presentation creation" operation. +
    See Also a sample TUI Script of +\ref tui_submesh_page "Submesh presentation" creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/scalar_map.doc b/doc/salome/gui/VISU/input/scalar_map.doc index 71a03471..50ec7688 100644 --- a/doc/salome/gui/VISU/input/scalar_map.doc +++ b/doc/salome/gui/VISU/input/scalar_map.doc @@ -177,7 +177,7 @@ OK. The presentation will be immediately displayed in the viewer: \image html scalar_map_on_cells.png "Scalar map on Cell Mesh" -See Also a sample TUI Script of a -\ref tui_scalar_map_page "Scalar Map creation" operation. +See Also a sample TUI Script of +\ref tui_scalar_map_page "Scalar Map presentation" creation. */ diff --git a/doc/salome/gui/VISU/input/scalar_map_on_deformed_shape.doc b/doc/salome/gui/VISU/input/scalar_map_on_deformed_shape.doc index dd5eb89f..ec518fb6 100755 --- a/doc/salome/gui/VISU/input/scalar_map_on_deformed_shape.doc +++ b/doc/salome/gui/VISU/input/scalar_map_on_deformed_shape.doc @@ -45,7 +45,8 @@ 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" -See Also a sample TUI Script of a -\ref tui_def_shape_and_scalar_map_page "Deformed Shape and Scalar Map creation" operation. +See Also a sample TUI Script of +\ref tui_def_shape_and_scalar_map_page "Deformed Shape and Scalar Map +presentation" creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/stream_lines.doc b/doc/salome/gui/VISU/input/stream_lines.doc index 82979ffd..12a1a31b 100644 --- a/doc/salome/gui/VISU/input/stream_lines.doc +++ b/doc/salome/gui/VISU/input/stream_lines.doc @@ -81,7 +81,7 @@ After you have finished with setting these parameters, click \b OK. Your presentation with scalar bar will be immediately displayed in the viewer. -
    See Also a sample TUI Script of a -\ref tui_stream_lines_page "Stream Lines creation" operation. +
    See Also a sample TUI Script of +\ref tui_stream_lines_page "Stream Lines presentation" creation. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/table_3d.doc b/doc/salome/gui/VISU/input/table_3d.doc index 7fd97b9c..7a02dd46 100644 --- a/doc/salome/gui/VISU/input/table_3d.doc +++ b/doc/salome/gui/VISU/input/table_3d.doc @@ -45,7 +45,7 @@ bar displayed with this presentation (\ref scalar_map_page "see also"). It is also possible to choose \b Wireframe or \b Shading \b Representation type, change such properties as \b Opacity and Line Width and Translate the presentation using the context menu. -
    See Also a sample TUI Script of a -\ref tui_table_3d_page "Table 3D presentation creation" operation. +
    See Also a sample TUI Script of +\ref tui_table_3d_page "Table 3D presentation creation". */ diff --git a/doc/salome/gui/VISU/input/tui_animation.doc b/doc/salome/gui/VISU/input/tui_animation.doc index 44166efe..37588119 100644 --- a/doc/salome/gui/VISU/input/tui_animation.doc +++ b/doc/salome/gui/VISU/input/tui_animation.doc @@ -2,7 +2,7 @@ \page tui_animation_page Animation -Successive Animation example: +Example of Successive Animation: \code import os @@ -13,40 +13,40 @@ import salome import VISU from visu_gui import * -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") -# Import MED file +# Import a MED file medFile = datadir + "/TimeStamps.med" myResult = myVisu.ImportFile(medFile) -# Create 3D view +# Create a 3D view myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() myView.SetTitle("Animation view") -# Create animation instance +# Create an animation instance fieldName = "vitesse" myAnimation = myVisu.CreateAnimation(myView); -# Set successive animation mode +# Set the successive animation mode myAnimation.setAnimationMode(VISU.Animation.SUCCESSIVE) -# Set animation properties: +# Set the animation properties: -# Add one field on which timestamps the animation will be performed +# Add a field with timestamps, on which 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 +# Set the presentation type for the first field myAnimation.setPresentationType(0, VISU.TDEFORMEDSHAPEANDSCALARMAP) # Generate presentations myAnimation.generatePresentations(0) -# Create the pattern of Deformed Shape and Scalar Map presentation +# Create the pattern of a Deformed Shape and Scalar Map presentation meshName = "dom" fieldName = "vitesse" fieldEntity = VISU.NODE @@ -60,30 +60,30 @@ myAnimation.ApplyProperties(0, myDefShapeScalarMap) # Generate frames myAnimation.generateFrames() -# Publisj animation object in study +# Publish the animation object in the study myAnimation.publishInStudy() -# Set speed +# Set the speed myAnimation.setSpeed(80) -# Save animation after changing the speed +# Save the animation after changing the speed myAnimation.saveAnimation() # Fit All myView.FitAll() -# Start animation +# Start the animation myAnimation.startAnimation() # Rewind to the first frame sleep(10) myAnimation.firstFrame() -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode -
    Parallel Animation example: +
    Example of Parallel Animation: \code import os @@ -94,29 +94,29 @@ import salome import VISU from visu_gui import * -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") -# Import MED file +# Import a MED file medFile = datadir + "/TimeStamps.med" myResult = myVisu.ImportFile(medFile) -# Create 3D view +# Create a 3D view myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() myView.SetTitle("Animation view") -# Create animation instance +# Create an animation instance fieldName = "vitesse" myAnimation = myVisu.CreateAnimation(myView); -# Set successive animation mode +# Set the successive animation mode myAnimation.setAnimationMode(VISU.Animation.PARALLEL) # Set animation properties: -# Add two fields on which timestamps the animation will be performed +# Add two fields with timestamps, on which the animation will be performed fieldName1 = "vitesse, m/s" fieldSO1 = salome.myStudy.FindObject(fieldName1) fieldName2 = "temperature, K" @@ -125,10 +125,10 @@ fieldSO2 = salome.myStudy.FindObject(fieldName2) myAnimation.addField(fieldSO1) myAnimation.addField(fieldSO2) -# Set presentation type for the first field +# Set the presentation type for the first field myAnimation.setPresentationType(0, VISU.TVECTORS) -# Set presentation type for the second field +# Set the presentation type for the second field myAnimation.setPresentationType(1, VISU.TSCALARMAP) # Generate presentations for all fields @@ -151,19 +151,19 @@ myAnimation.ApplyProperties(0, myVectors) # Generate frames myAnimation.generateFrames() -# Publisj animation object in study +# Publish the animation object in the study myAnimation.publishInStudy() -# Set speed +# Set the speed myAnimation.setSpeed(95) # Fit All myView.FitAll() -# Start animation +# Start the animation myAnimation.startAnimation() -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode diff --git a/doc/salome/gui/VISU/input/tui_cut_lines.doc b/doc/salome/gui/VISU/input/tui_cut_lines.doc index 45f5feb1..fc57a3a0 100644 --- a/doc/salome/gui/VISU/input/tui_cut_lines.doc +++ b/doc/salome/gui/VISU/input/tui_cut_lines.doc @@ -2,7 +2,7 @@ \page tui_cut_lines_page Cut Lines -Create Cut Lines on the field of the imported MED file: +Create Cut Lines presentation on a field of the imported MED file: \code import os @@ -12,13 +12,13 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) @@ -28,26 +28,26 @@ fieldEntity = VISU.NODE fieldName = 'VITESSE' myCutLines = myVisu.CutLinesOnField(myResult, meshName, fieldEntity, fieldName, 1) -# Set orientation of the base plane (parallel to ZX) +# Set the orientation of the base plane (parallel to ZX) myCutLines.SetOrientation(VISU.CutPlanes.ZX, 0, 0) -# Set orientation of the cutting planes (parallel to ZX) +# Set the orientation of the cutting planes (parallel to ZX) myCutLines.SetOrientation2(VISU.CutPlanes.XY, 0, 0) -# Set number of lines +# Set the number of lines myCutLines.SetNbLines(12) -# Set displacement of the base plane +# Set the displacement of the base plane myCutLines.SetDisplacement(0) -# Set custom position for the first line +# Set a custom position for the first line newPos = (myCutLines.GetLinePosition(1) - myCutLines.GetLinePosition(0))/2 myCutLines.SetLinePosition(0, newPos) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created cut lines +# Display the newly created cut lines myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -58,4 +58,4 @@ myView.FitAll()
    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 index 1057c5d2..9fcbff27 100644 --- a/doc/salome/gui/VISU/input/tui_cut_planes.doc +++ b/doc/salome/gui/VISU/input/tui_cut_planes.doc @@ -2,7 +2,7 @@ \page tui_cut_planes_page Cut Planes -Create Cut Planes on the field of the imported MED file: +Create Cut Planes presentation on a field of the imported MED file: \code import os @@ -12,13 +12,13 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) @@ -28,24 +28,24 @@ fieldEntity = VISU.NODE fieldName = 'VITESSE' myCutPlanes = myVisu.CutPlanesOnField(myResult, meshName, fieldEntity, fieldName, 1) -# Set number of planes +# Set the number of planes myCutPlanes.SetNbPlanes(15) -# Set orientation of the planes (parallel to XY), set rotation around Y to 0.5 radian +# Set the planes orientation (parallel to XY), set rotation around Y to 0.5 radian myCutPlanes.SetOrientation(VISU.CutPlanes.XY, 0, 0.5) -# Set scale +# Set the scale myCutPlanes.UseDeformation(True) myCutPlanes.SetVectorialField(fieldEntity, fieldName) myCutPlanes.SetScale(0.05) -# Set displacement +# Set the displacement myCutPlanes.SetDisplacement(0.1) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created cut planes +# Display the newly created cut planes myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -56,4 +56,4 @@ myView.FitAll()
    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 index e9c31713..31d950ae 100644 --- a/doc/salome/gui/VISU/input/tui_cut_segment.doc +++ b/doc/salome/gui/VISU/input/tui_cut_segment.doc @@ -2,7 +2,7 @@ \page tui_cut_segment_page Cut Segment -Create Cut Segment on the field of the imported MED file: +Create Cut Segment presentation on a field of the imported MED file: \code import os @@ -12,17 +12,17 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) -# Create cut segment for the first timestamp of 'VITESSE' field +# Create a cut segment for the first timestamp of 'VITESSE' field meshName = 'LE VOLUME' fieldEntity = VISU.NODE fieldName = 'VITESSE' @@ -37,10 +37,10 @@ myCutSegment.SetPoint2(0.41, 0.0685, 1.082) # Invert the resulting curve myCutSegment.SetAllCurvesInverted(True) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created cut segment +# Display the newly created cut segment myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -51,4 +51,4 @@ myView.FitAll()
    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_def_shape.doc b/doc/salome/gui/VISU/input/tui_def_shape.doc index 0729c29a..b2b767f6 100644 --- a/doc/salome/gui/VISU/input/tui_def_shape.doc +++ b/doc/salome/gui/VISU/input/tui_def_shape.doc @@ -2,7 +2,7 @@ \page tui_def_shape_page Deformed Shape -Create Deformed Shape on the field of the imported MED file: +Create Deformed Shape presentation on a field of the imported MED file: \code import os @@ -12,32 +12,32 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) -# Create deformed shape for the first timestamp of 'VITESSE' field +# 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 scale factor +# Set the scale factor myDefShape.SetScale(0.25) # Set magnitude coloring myDefShape.ShowColored(True) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created deformed shape +# Display the newly created deformed shape myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -48,4 +48,4 @@ myView.FitAll()
    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 index c0cca6a4..7fc4f283 100644 --- 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 @@ -2,7 +2,7 @@ \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: +Create Deformed Shape and Scalar Map presentation on the field of the imported MED file: \code import os @@ -12,33 +12,33 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) -# Create deformed shape and scalar map for the first timestamp of 'VITESSE' field +# Create a deformed shape and a 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 +# Set the scale myDefShapeScalarMap.SetScale(0.25) -# Set 'TAUX_DE_VIDE' as scalar field, use first timestamp +# Set 'TAUX_DE_VIDE' as a scalar field, use the first timestamp fieldName = 'TAUX_DE_VIDE' myDefShapeScalarMap.SetScalarField(VISU.NODE, fieldName, 1) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created presentation +# Display the newly created presentation myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -50,4 +50,4 @@ myView.FitAll() "DeformedShapeAndScalarMap interface reference documentation" for more details. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/tui_evolution.doc b/doc/salome/gui/VISU/input/tui_evolution.doc index 7a56652f..a0a60dae 100644 --- a/doc/salome/gui/VISU/input/tui_evolution.doc +++ b/doc/salome/gui/VISU/input/tui_evolution.doc @@ -2,7 +2,7 @@ \page tui_evolution_page Evolution on Point -Example of Evolution on Point: +Example of Evolution on Point presentation: \code import os @@ -12,22 +12,22 @@ import salome import VISU from visu_gui import * -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") -# Import MED file +# Import a MED file medFile = datadir + "/TimeStamps.med" myResult = myVisu.ImportFile(medFile) -# Create 2D viewer for the evolution graph: +# Create a 2D viewer for the evolution graph: myViewManager = myVisu.GetViewManager(); myView = myViewManager.CreateXYPlot(); myView.SetTitle("The viewer for Evolution") -# Create evolution instance, use just created view +# Create an evolution instance, using the newly created view myEvolution = myVisu.CreateEvolution(myView); -# Get 'vitesse' field sobject +# Get 'vitesse' field object aSObj = myStudy.FindObjectIOR(myResult.GetID()) aSObj = aSObj.FindSubObject(1)[1] # 'dom' mesh aSObj = aSObj.FindSubObject(3)[1] # Fields @@ -37,14 +37,14 @@ myEvolution.setField(vitesseSO) # Set "x" as a component myEvolution.setComponentId(1) -# Set point via identifier +# Set a point via identifier myEvolution.setPointId(500) -# Show Evolution +# Show the Evolution myEvolution.showEvolution() myView.FitAll() -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode diff --git a/doc/salome/gui/VISU/input/tui_gauss_points.doc b/doc/salome/gui/VISU/input/tui_gauss_points.doc index 397ccbf1..a40e29ae 100644 --- a/doc/salome/gui/VISU/input/tui_gauss_points.doc +++ b/doc/salome/gui/VISU/input/tui_gauss_points.doc @@ -2,7 +2,7 @@ \page tui_gauss_points_page Gauss Points -Create Gauss Points presentation on the field of the imported MED file: +Create Gauss Points presentations on a field of the imported MED file: \code import os @@ -14,13 +14,13 @@ import SALOMEDS import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import the file medFile = datadir + "/pointe.med" myResult = myVisu.ImportFile(medFile) @@ -29,8 +29,7 @@ meshName = 'maa1' fieldEntity = VISU.CELL fieldName = 'fieldcelldoublevector' -# Create Gauss Points presentation of the first type: -# Results at Gauss Points +# Create a Gauss Points presentation of the first type: Results at Gauss Points myGaussPoints1 = myVisu.GaussPointsOnField(myResult, meshName, fieldEntity, fieldName, 1) # Set range values (5-50%): @@ -40,11 +39,10 @@ myGaussPoints1.SetMaxSize(0.5) # Set OpenGL Points as a primitive type myGaussPoints1.SetPrimitiveType(VISU.GaussPoints.POINT) -# Set points maximum size +# Set the maximum size of points myGaussPoints1.SetClamp(32) -# Create Gauss Points presentation of the second type: -# Gauss Points on Geometry +# Create a Gauss Points presentation of the second type: Gauss Points on Geometry myGaussPoints2 = myVisu.GaussPointsOnField(myResult, meshName, fieldEntity, fieldName, 1) myGaussPoints2.SetIsColored(False) @@ -54,21 +52,20 @@ myGaussPoints2.SetMagnification(2) # Set magnification ratio myGaussPoints2.SetMagnificationIncrement(4) -# Set size of points +# Set the size of points myGaussPoints2.SetGeomSize(0.25) -# Set color of points +# Set the color of points myGaussPoints2.SetColor(SALOMEDS.Color(255, 90, 255)) -# Create Gauss Points presentation of the third type: -# Gauss Points on Deformed Shape +# Create a Gauss Points presentation of the third type: Gauss Points on Deformed Shape myGaussPoints3 = myVisu.GaussPointsOnField(myResult, meshName, fieldEntity, fieldName, 1) -# Apply deformation +# Apply the deformation myGaussPoints3.SetIsDeformed(True) myGaussPoints3.SetScaleFactor(0.4) -# Set geometrical sphere as a primitive type +# Set a geometrical sphere as the primitive type myGaussPoints3.SetPrimitiveType(VISU.GaussPoints.SPHERE) # Set sphere resolution @@ -77,7 +74,7 @@ myGaussPoints3.SetResolution(5) # Update object browser salome.sg.updateObjBrowser(1) -# Display just created presentations one by one +# Display the newly created presentations one by one myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -91,4 +88,4 @@ for prs in prsList:
    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 index 27d84c6a..4c17ad13 100644 --- a/doc/salome/gui/VISU/input/tui_import_export.doc +++ b/doc/salome/gui/VISU/input/tui_import_export.doc @@ -2,7 +2,7 @@ \page tui_import_export_page Import/Export MED -Import MED file: +Import data from a MED file: \code import os @@ -11,23 +11,23 @@ import salome import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# MED file path +# The path to the file medFile = datadir + "/fra.med" -# Import MED file +# Import the file myResult = myVisu.ImportFile(medFile) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode -
    Export to MED file: +
    Export data to a MED file: \code import os @@ -36,24 +36,24 @@ import salome import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# MED file path +# The path to the file medFile = datadir + "/fra.med" -# Import MED file +# Import the file myResult = myVisu.ImportFile(medFile) -# Export MED file +# Export the file newFileName = datadir + "/fra_copy.med" myResult.ExportMED(newFileName) -# Update object browser +# Update the 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 index 6a00ccda..01170c41 100644 --- a/doc/salome/gui/VISU/input/tui_iso_surf.doc +++ b/doc/salome/gui/VISU/input/tui_iso_surf.doc @@ -2,7 +2,7 @@ \page tui_iso_surf_page Iso Surfaces -Create Iso Surfaces on the field of the imported MED file: +Create Iso Surfaces presentation on a field of the imported MED file: \code import os @@ -12,13 +12,13 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) @@ -28,16 +28,16 @@ fieldEntity = VISU.NODE fieldName = 'VITESSE' myIsoSurfaces = myVisu.IsoSurfacesOnField(myResult, meshName, fieldEntity, fieldName, 1) -# Set number of surfaces +# Set the number of surfaces myIsoSurfaces.SetNbSurfaces(12) # Show two value labels per surface myIsoSurfaces.ShowLabels(True, 2) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created iso surfaces +# Display the newly created iso surfaces myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -48,4 +48,4 @@ myView.FitAll()
    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_plot_3d.doc b/doc/salome/gui/VISU/input/tui_plot_3d.doc index a2997d56..6f0556d4 100644 --- a/doc/salome/gui/VISU/input/tui_plot_3d.doc +++ b/doc/salome/gui/VISU/input/tui_plot_3d.doc @@ -2,7 +2,7 @@ \page tui_plot_3d_page Plot 3D -Create Plot 3D presentation on the field of the imported MED file: +Create Plot 3D presentation on a field of the imported MED file: \code import os @@ -12,41 +12,41 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) -# Create plot 3d for the first timestamp of 'VITESSE' field +# Create a 3d plot 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 +# Set the cut plane orientation myPlot3D.SetOrientation(VISU.Plot3D.ZX, 0, 0) -# Set relative position of the plane +# Set the relative position of the plane myPlot3D.SetPlanePosition(0.8, True) -# Set scale factor +# Set the scale factor myPlot3D.SetScaleFactor(0.25) -# Set contour as a presentation type +# Set the contour presentation type myPlot3D.SetContourPrs(True) -# Set number of contours +# Set the number of contours myPlot3D.SetNbOfContours(100) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created plot 3d presentation +# Display the newly created plot 3d presentation myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -57,4 +57,4 @@ myView.FitAll()
    Please, see \ref VISU.Plot3D "Plot3D interface reference documentation" for more details. -*/ \ No newline at end of file +*/ diff --git a/doc/salome/gui/VISU/input/tui_point_marker.doc b/doc/salome/gui/VISU/input/tui_point_marker.doc index b11938be..e2680a0b 100644 --- a/doc/salome/gui/VISU/input/tui_point_marker.doc +++ b/doc/salome/gui/VISU/input/tui_point_marker.doc @@ -2,60 +2,51 @@ \page tui_point_marker_page Point Marker -Example of using Point Markers: +Example of using Point Markers: \code import os -from time import sleep - -import salome - +import time import VISU from visu_gui import * -# Directory containing MED files -datadir = os.getenv("DATA_DIR") +data_dir = os.getenv("DATA_DIR") +sleep_delay = 2 -# Import MED file -medFile = datadir + "/fra.med" -myResult = myVisu.ImportFile(medFile) +myViewManager = myVisu.GetViewManager(); -# Create scalar map for the first timestamp of 'VITESSE' field -meshName = "LE VOLUME" -fieldEntity = VISU.NODE -fieldName = "VITESSE" -timeStampId = 1 +myView = myViewManager.Create3DView() +myView.SetTitle("The viewer for Point Marker Example") +print "myViewManager.Create3DView()" -myScalarMap = myVisu.ScalarMapOnField(myResult, meshName, fieldEntity, fieldName, timeStampId) +medFile = "fra.med" +medFile = data_dir + '/MedFiles/' + medFile +myResult = myVisu.ImportFile(medFile) -# Create 3D view -myViewManager = myVisu.GetViewManager(); -myView = myViewManager.Create3DView() -myView.SetTitle("The viewer for Point Marker example") +aMeshName ="LE VOLUME" +anEntity = VISU.NODE +aFieldName = "VITESSE"; +aTimeStampId = 1 -# Display just created scalar map -myView.DisplayOnly(myScalarMap); +aScalarMap = myVisu.ScalarMapOnField(myResult,aMeshName,anEntity,aFieldName,aTimeStampId) +myView.Display(aScalarMap); myView.FitAll(); -# Set the scalar map representation type to point -myView.SetPresentationType(myScalarMap, VISU.POINT) +print "Set the representation type to Point" +myView.SetPresentationType(aScalarMap, VISU.POINT) -# Set standard marker -myScalarMap.SetMarkerStd(VISU.MT_O_PLUS, VISU.MS_25) +print "Set a standard marker" +aScalarMap.SetMarkerStd(VISU.MT_PLUS, VISU.MS_25) myView.Update() -sleep(5) +time.sleep(sleep_delay) -# Set custom marker -textureFile = os.path.join(datadir, "Textures", "texture1.dat") -custom_texture = myVisu.LoadTexture(textureFile) -myScalarMap.SetMarkerTexture(custom_texture) +print "Set a custom marker" +custom_texture = myVisu.LoadTexture(os.path.join(data_dir, "Textures", "texture1.dat")) +aScalarMap.SetMarkerTexture(custom_texture) myView.Update() -# Update object browser -salome.sg.updateObjBrowser(1) \endcode
    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 index 2a20306e..5158702f 100644 --- a/doc/salome/gui/VISU/input/tui_scalar_map.doc +++ b/doc/salome/gui/VISU/input/tui_scalar_map.doc @@ -2,7 +2,7 @@ \page tui_scalar_map_page Scalar Map -Create Scalar Map on the field of the imported MED file: +Create Scalar Map presentation on a field of the imported MED file: \code import os @@ -12,32 +12,32 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/pointe.med" myResult = myVisu.ImportFile(medFile) -# Create scalar map for the first timestamp of 'fieldcelldoublevector' field +# Create a 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 +# Set the logarithmic scaling myScalarMap.SetScaling(VISU.LOGARITHMIC) # Set scalar range to [2, 5] myScalarMap.SetRange(2, 5) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created scalar map +# Display the newly created scalar map myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -48,4 +48,4 @@ myView.FitAll()
    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 index 9a035c5e..e223cb41 100644 --- a/doc/salome/gui/VISU/input/tui_stream_lines.doc +++ b/doc/salome/gui/VISU/input/tui_stream_lines.doc @@ -2,7 +2,7 @@ \page tui_stream_lines_page Stream Lines -Create Stream Lines on the field of the imported MED file: +Create Stream Lines presentation on a field of the imported MED file: \code import os @@ -12,13 +12,13 @@ import salome import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) @@ -42,10 +42,10 @@ myStreamLines.SetParams(integrationStep, propagationTime, stepLength, prs3D, poi # Set magnitude coloring myStreamLines.ShowColored(True) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created stream lines +# Display the newly created stream lines myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -56,4 +56,4 @@ myView.FitAll()
    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 index 5dde8dd7..2c599bd7 100644 --- a/doc/salome/gui/VISU/input/tui_submesh.doc +++ b/doc/salome/gui/VISU/input/tui_submesh.doc @@ -2,7 +2,7 @@ \page tui_submesh_page Submesh presentation -Display different submeshes of the imported MED file: +Display various submeshes of the imported MED file: \code import os @@ -14,13 +14,13 @@ import SALOMEDS import VISU import visu_gui -# Directory containing MED files +# The directory containing MED files datadir = os.getenv("DATA_DIR") # Get VISU engine myVisu = visu_gui.myVisu -# Import MED file +# Import a MED file medFile = datadir + "/pointe.med" myResult = myVisu.ImportFile(medFile) @@ -31,24 +31,24 @@ nodeEntity = VISU.NODE mySubMeshes = [] -# Submesh on nodes +# Create submesh on nodes myOnNodes = myVisu.MeshOnEntity(myResult, meshName, nodeEntity) mySubMeshes.append(myOnNodes) -# Submesh on family (one cell) +# Create submesh on a family (one cell) familyName = 'FAMILLE_ELEMENT_1' myOnFamily = myVisu.FamilyMeshOnEntity(myResult, meshName, cellEntity, familyName) mySubMeshes.append(myOnFamily) -# Submesh on group (several cells) +# Create submesh on a group (several cells) groupName = 'groupe1' myOnGroup = myVisu.GroupMesh(myResult, meshName, groupName) mySubMeshes.append(myOnGroup) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Display just created presentations one by one +# Display newly created presentations one by one myViewManager = myVisu.GetViewManager() myView = myViewManager.Create3DView() @@ -61,4 +61,4 @@ for submesh in mySubMeshes:
    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 index 183f3455..29f5f3a0 100644 --- a/doc/salome/gui/VISU/input/tui_table_3d.doc +++ b/doc/salome/gui/VISU/input/tui_table_3d.doc @@ -2,7 +2,7 @@ \page tui_table_3d_page Table 3D presentation -Create and display Table 3D presentation: +Create and display a Table 3D presentation: \code import os @@ -11,7 +11,7 @@ import salome import visu_gui -# Directory containing data table files +# The directory containing data table files datadir = os.getenv("DATA_DIR") # Get VISU engine @@ -21,7 +21,7 @@ myVisu = visu_gui.myVisu tableFile = datadir + '/table_test.xls' myTablesSO = myVisu.ImportTables(tableFile, False) -# Create table presentation +# Create a table presentation table = None anIsFound, aTableSO = myTablesSO.FindSubObject(1) if anIsFound: @@ -34,7 +34,7 @@ if anIsFound: # Set scale factor table.SetScaleFactor(0.2) -# Show table presentation +# Show the table presentation if (table is not None): # Display just created tabel presentation myViewManager = myVisu.GetViewManager() @@ -43,11 +43,11 @@ if (table is not None): myView.DisplayOnly(table) myView.FitAll() -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode
    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 index 4e83e25b..072833d0 100644 --- a/doc/salome/gui/VISU/input/tui_table_curves.doc +++ b/doc/salome/gui/VISU/input/tui_table_curves.doc @@ -13,7 +13,7 @@ import salome import VISU import visu_gui -# Directory containing data table files +# The directory containing data table files datadir = os.getenv("DATA_DIR") # Get VISU engine @@ -23,17 +23,17 @@ myVisu = visu_gui.myVisu tableFile = datadir + '/table_test.xls' myTablesSO = myVisu.ImportTables(tableFile, False) -# Get table +# Get the table anIsFound, myTableSO = myTablesSO.FindSubObject(1) anID = myTableSO.GetID() myTable = myVisu.CreateTable(anID) -# Create table view +# Create a table view myViewManager = myVisu.GetViewManager() myTableView = myViewManager.CreateTableView(myTable) myTableView.SetTitle('My Curves') -# Create container for a set of curves +# Create a container for a set of curves myContainer = myVisu.CreateContainer() # Create curves @@ -43,10 +43,10 @@ for i in range(1, aNbCurves): aCurve = myVisu.CreateCurve( myTable, 1, i ) myContainer.AddCurve(aCurve) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) -# Create Plot 2D view +# Create a Plot 2D view myView = myViewManager.CreateXYPlot(); myView.SetTitle("The viewer for My Curves") @@ -54,15 +54,15 @@ myView.SetTitle("The viewer for My Curves") myView.Display(myContainer) sleep(5) -# Set curves displaying mode +# Set the curves displaying mode myView.SetCurveType(VISU.XYPlot.SPLINE) -# Set marker size +# Set the marker size myView.SetMarkerSize(15) -# Change display parameters of the last created curve -# Marker type +# Change the display parameters of the last created curve +# Set the marker type aCurve.SetMarker(VISU.Curve.CIRCLE) -# Line type and width +# Set the line type and width aCurve.SetLine(VISU.Curve.SOLIDLINE, 4) # Display only the last created curve @@ -72,4 +72,4 @@ myView.DisplayOnly(aCurve)
    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 index 6ebef473..095c4c37 100644 --- a/doc/salome/gui/VISU/input/tui_table_import.doc +++ b/doc/salome/gui/VISU/input/tui_table_import.doc @@ -11,7 +11,7 @@ import salome import visu_gui -# Directory containing data table files +# The directory containing data table files datadir = os.getenv("DATA_DIR") # Get VISU engine @@ -31,7 +31,7 @@ while iter.More(): print "\n", aTable.GetTitle() iter.Next() -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode @@ -44,7 +44,7 @@ import salome import visu_gui -# Directory containing data table files +# The directory containing data table files datadir = os.getenv("DATA_DIR") # Get VISU engine @@ -54,14 +54,14 @@ myVisu = visu_gui.myVisu tableFile = datadir + '/tables_test.xls' myTablesSO = myVisu.ImportTables(tableFile, False) -# Export first of the imported tables to the new file +# Export the first imported table to a new file expTableFile = datadir + '/sinus_table.txt' sinusTableSO = salome.myStudy.FindObject("sinus") myVisu.ExportTableToFile(sinusTableSO, expTableFile) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode -*/ \ 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 index 69d0bb96..3f1f41c2 100644 --- a/doc/salome/gui/VISU/input/tui_view_3d.doc +++ b/doc/salome/gui/VISU/input/tui_view_3d.doc @@ -13,14 +13,14 @@ import salome import VISU from visu_gui import * -# Delay +# Set the delay delay = 4 -# Directory containing MED files +# Set the directory containing MED files datadir = os.getenv("DATA_DIR") -# Create temporary 3D view -print "Create temporary 3D view..." +# Create a temporary 3D view +print "Create a temporary 3D view..." myViewManager = myVisu.GetViewManager() myTempView = myViewManager.Create3DView() myTempView.SetTitle("The window will be soon destroyed!") @@ -31,30 +31,30 @@ print "Destroy the view..." myViewManager.Destroy(myTempView) sleep(delay) -# Import MED file +# Import a MED file medFile = datadir + "/fra.med" myResult = myVisu.ImportFile(medFile) -# Create scalar map +# Create a 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..." +# Create a new 3D view +print "Create a new 3D view..." myView = myViewManager.Create3DView() -# Set background -print "Set blue background..." +# Set the background +print "Set a 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..." +# Display the newly created scalar map +print "Display the scalar map..." myView.Display(myScalarMap) sleep(delay) @@ -74,8 +74,8 @@ print "Fit all..." myView.FitAll() sleep(delay) -# Change scalar map range -print "Change scalar map range..." +# Change the scalar map range +print "Change the scalar map range..." myScalarMap.SetRange(0.2, 0.9) sleep(delay) @@ -84,15 +84,15 @@ print "Update the view..." myView.Update() sleep(delay) -# Scale view -print "Scale view..." +# Scale the view +print "Scale the 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..." +# Set the camera position in 3D space +print "Set the the camera position in 3D space..." myView.SetPointOfView([0.01, 0.05, 0.03]) myView.Update() sleep(delay) @@ -106,29 +106,29 @@ sleep(delay) stateName = "State1" myView.SaveViewParams(stateName) -# Remove scaling +# Remove scale print "Remove scale..." myView.RemoveScale() sleep(delay) -# Change background -print "Set dark background..." +# Change the background +print "Set a dark background..." bgColor = SALOMEDS.Color(0.0, 0.1, 0.2) myView.SetBackground(bgColor) sleep(delay) -# Update view -print "Update view..." +# Update the view +print "Update the view..." myView.Update() sleep(delay) -# Set top view -print "Set top view..." +# Set the top view +print "Set the top view..." myView.SetView(VISU.View3D.TOP) sleep(delay) -# Zoomig out -print "Zoomig out..." +# Zooming out +print "Zooming out..." aScale = myView.GetParallelScale() for i in range(0,50) : aScale = aScale + 0.05 @@ -178,16 +178,16 @@ print "Make the scalar map shrinked..." myView.SetShrinked(myScalarMap, True) sleep(delay) -# Set presentation type -print "Set presentation type to SURFACEFRAME..." +# Set the presentation type +print "Set the presentation type to SURFACEFRAME..." myView.SetPresentationType(myScalarMap, VISU.SURFACEFRAME) sleep(delay) -print "Set presentation type to FEATURE_EDGES..." +print "Set the presentation type to FEATURE_EDGES..." myView.SetPresentationType(myScalarMap, VISU.FEATURE_EDGES) sleep(delay) -# Update object browser +# Update the object browser salome.sg.updateObjBrowser(1) \endcode diff --git a/doc/salome/gui/VISU/input/vectors.doc b/doc/salome/gui/VISU/input/vectors.doc index 2eff2223..3e971e01 100644 --- a/doc/salome/gui/VISU/input/vectors.doc +++ b/doc/salome/gui/VISU/input/vectors.doc @@ -45,7 +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. -
    See Also a sample TUI Script of a +
    See Also a sample TUI Script of \ref tui_vectors_page "Vectors creation" operation. */ diff --git a/doc/salome/gui/VISU/input/viewing_3d_presentations.doc b/doc/salome/gui/VISU/input/viewing_3d_presentations.doc index 8b15e2bf..d5a679da 100644 --- a/doc/salome/gui/VISU/input/viewing_3d_presentations.doc +++ b/doc/salome/gui/VISU/input/viewing_3d_presentations.doc @@ -160,7 +160,7 @@ the pop-up menu select Merge Scalar Range. To restore separate bars and scales for each module select Use Field Range from the same menu. -
    See Also a sample TUI Script of a -\ref tui_view_3d_page "Viewing 3D presentations". +
    See Also sample scripts of +\ref tui_view_3d_page "Viewing 3D presentations" via TUI. */ -- 2.39.2