doc/salome/gui/VISU/input/viewing_3d_presentations.doc

   1 /*!
   2
   3 \page viewing_3d_presentations_page Viewing 3D presentations
   4
   5 Each  newly created presentation is displayed in the <b>VTK 3D
   6 Viewer</b>. <b>VTK 3D Viewer</b> is described in details in the
   7 documentation on GUI module.
   8
   9 To display an existing presentation, right-click on it in the
  10 Object Browser and select \b Show.
  11
  12 \image html viewing3.png
  13
  14 Right mouse-click on the Presentation gives access to the following
  15 options:
  16
  17 \image html viewing1.png
  18
  19 \note All parameters are context-sensitive: NOT all types of
  20 visualization and NOT all properties can be set for a certain 3D
  21 presentation.
  22
  23 - <b>Hide all</b> - allows to hide all objects from the
  24 viewer.
  25
  26 - <b>Edit</b> - allows to return to the menu, where the presentation
  27 has been created and change its parameters.
  28
  29 - \anchor filter_by_scalars_anchor <b>Filter by Scalars</b> - allows
  30 showing only the cells with values that fit into the defined
  31 <b>Scalar Range</b>.
  32
  33 \image html viewing2.png
  34
  35 In the dialog box, check in <b>Filter by scalar range</b> box and input
  36 the minimum and the maximum values for the <b>Scalar Range</b>.
  37
  38 \image html viewing4.png
  39
  40 - \anchor rename_anchor <b>Rename</b> - allows to rename the presentation.
  41 - <b>Copy</b> - allows to create a copy of the presentation in the
  42 same subfolder (time stamp) in the Object Browser.
  43
  44 - <b>Values Labeling</b> allows to display values applied to the
  45 cells or nodes of a 3D presentation.
  46
  47 \image html values_labeling.png
  48
  49 \anchor labeling_parameters_anchor
  50
  51 - <b>Labeling Parameters</b> allows to change such labeling parameters as font and color.
  52
  53 \image html labeling_parameters.png
  54
  55 - <b>Hide</b> - allows to hide the selected presentation from the
  56 viewer.
  57 - If selected in the Object Browser, <b>Hide</b> is replaced by
  58 <b>Show</b>, which allows to display the selected presentation in the
  59 viewer.
  60 - <b>Show Only</b> - allows to display only the selected
  61 presentation, hiding all other from the viewer.
  62
  63 - <b>Hide Scalar Bar</b>/<b>Show Scalar Bar</b> - allows to show/hide the scalar bar
  64 attached to the 3d presentation.
  65
  66 - <b>Representation</b> - allows to switch among the available
  67 representation types.\n\n\image html viewing10.png
  68   - <b>Points</b> \image html viewing5.png
  69   - <b>Surface</b> \image html viewing6.png
  70   - <b>Wireframe</b> \image html viewing7.png
  71   - <b>Insideframe</b> - displays the wires lying within the object \image html viewing8.png
  72   - <b>Surfaceframe</b> - displays wires and cells lying on the object surface \image html viewing9.png
  73   - <b>Feature edges</b> - shows the contour of the object \image html viewing11.png
  74   - <b>Shrink</b> \image html viewing12.png
  75   - <b>Shading on</b> - colors the object in a realistic way,
  76     revealing its geometry, for example, by applying shadows to the
  77     inside regions; used together with \b Surface.
  78   - <b>Shading off</b> - colors the object basing only on scalar values.
  79
  80 - <b>2D Quadratic</b> - allows to choose how the quadratic elements
  81 are visualized: as straight lines or as arcs of circle.
  82
  83 \image html quadratic.png
  84
  85 - \b Properties
  86   - \b Transparency - allows to set the value of transparency of the
  87   presentation between 0 (opaque) and 100 (transparent).
  88   \note For a \ref gauss_points_presentations_page "Gauss Points"
  89   presentation, displayed using <b>Point Sprites</b> or <b>OpenGL
  90   Points</b> \ref primitive_types_page "primitives", this property
  91   only allows switching between transparent and opaque modes. The
  92   textures are drawn in the opaque mode if the transparency is equal to
  93   0% and in the transparent mode if the transparency is > 0%
  94   (note that they become invisible when the transparency is equal to
  95   100%).\n\n \image html viewing13.png
  96   - <b>Line Width</b> - allows to set the width of lines representing
  97     edges of the presentation between 1 (thin) and 100 (thick).\n\n
  98     \image html line_width.png
  99   - <b>Shrink Factor</b> - allows to set the shrink factor of the
 100   presentation to be used in \b Shrink mode. Possible values range
 101   between 20 and 100, the default value is 80.\n\n \image html
 102   shrink_factor.png
 103   - <b>Edge Color</b> - allows to set the color of lines representing
 104   the edges of the presentation displayed in SurfaceFrame mode.
 105   - \ref point_marker_page "Point Marker" - allows to change the
 106   representation of points.
 107
 108 - \ref translate_presentation_page "Translate Presentation" - allows
 109 to translate the presentation along coordinate axes.
 110 - \ref clipping_page "Clipping Planes" - allows to create
 111 cross-section views of presentations.
 112 - \ref sweeping_page "Sweep" - allows to display pseudo-animation of
 113 the presentation.
 114
 115 - <b>Dump view</b> - exports an object from the viewer in bmp, png,
 116 jpg or jpeg image format.
 117 - <b>Change Background</b> - allows to change the properties of the
 118 background.
 119
 120 - <b>View Operations</b> checkbox - shows or hides the VTK viewer
 121 toolbar. The information about the VTK viewer functionalities is
 122 available in the documentation on the GUI module.
 123 - <b>Recording operations</b> checkbox - shows or hides buttons used
 124 for \ref recording_page "Recording".
 125
 126 The following menu items are added when the presentation is
 127 selected in the Object Browser.
 128
 129 - \b Delete - removes the presentation from the study.
 130 - \b Refresh - updates the presentation in the VTK viewer.
 131 - \b Find - activates <b> Find Tool</b> described in the documentation
 132   on GUI module.
 133
 134 When you create several presentations of the same object, you may wish
 135 to see them simultaneously,  which might be impossible, because they
 136 all are located at the same place. To solve this problem, right-click
 137 in the viewer and select <b>Arrange Actors</b> in the pop-up menu.
 138
 139 \image html arrangeactors.png
 140
 141 In \b Auto mode you specify along which \b Axis and at which
 142 <b>Relative Distance</b> the presentations should be lined up.
 143
 144 \image html arrangeactors1.png
 145
 146 In \b Manual mode you set the coordinates for each presentation
 147 separately.
 148
 149 Displaying several presentations at the same time may cause
 150 superposition of their scalar bars. To avoid this, check <b>Arrange
 151 Scalar Bars</b> radio button  in the <b>Preferences -> Post-Pro ->
 152 Scalar Bar</b>. A separate scalar bar will be displayed for each
 153 presentation.
 154
 155 Alternatively you may wish to merge the scalar bars to have a
 156 common scalar bar for all presentations. To do this, select several
 157 presentations or fields in the object browser, right-click and from
 158 the pop-up menu select <b>Merge Scalar Range</b>.
 159
 160 To restore separate bars and scales for each module select <b>Use
 161 Field Range</b> from the same menu.
 162
 163 <br><b>See Also</b> sample scripts of
 164 \ref tui_view_3d_page "Viewing 3D presentations" via TUI.
 165
 166 */