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

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