doc/salome/gui/VISU/input/scalar_bar.doc

   1 /*!
   2
   3 \page scalar_bar_page Scalar Bar
   4
   5 \n Gauss Points Presentations presume that two different scalar bars
   6 are displayed simultaneously:
   7 \n The Global scale corresponds to the minimum and maximum values
   8 founded for the variable at all time stamps (located on the left
   9 side). When active, the second is displayed in grey and disabled. The
  10 Local scale defines the minimum and maximum values at the current time
  11 stamp for the variable (located on the right side). When the Local
  12 scale is active, the Global scale shows its limits 2 black lines.
  13
  14 The dialog allows user to define the characteristics of the scalar
  15 bars displayed within the scene.
  16
  17 \image html gpp6.png
  18
  19 <ul>
  20 <li><b>Active bar</b></li>
  21 <ul>
  22 <li>\b Local: when selected, the \b Local bar will be active and
  23 colors used for rendering of the results will be taken from this
  24 bar. If displayed, the \b Global bar will be displayed in grey and 2
  25 markers will define the limits of the local min/max range.</li>
  26 <li>\b Global: when selected, the \b Global bar will be active and
  27 colors used for rendering of the results will be taken from this bar
  28 (i.e.: not all colors may be used to display results at a given time
  29 stamp). \b Local bar will be displayed in grey  and inactive.</li>
  30 <li>\b Displayed: when checked, the \b Global bar is displayed, else
  31 it is not seen. This control is systematically checked and disabled
  32 when the \b Global bar is defined as active.</li>
  33 </ul>
  34 <li><b>Scalar range</b></li>
  35 <ul>
  36 <li><b>Scalar Mode:</b> this feature allows refining the value to be
  37 inspected:</li>
  38 <ul>
  39 <li>\b Modulus: value of a scalar or modulus of a vector.</li>
  40 <li><b>Component N:</b> Nth component of a vector, a tensor or a
  41 matrix.</li>
  42 </ul>
  43 </ul>
  44 <li><b>Colors and labels</b></li>
  45 <ul>
  46 <li>\b Bicolor: only 2 colors are used for the active bar:</li>
  47 <ul>
  48 <li>\b Red for positive values.</li>
  49 <li>\b Blue for negative values.</li>
  50 </ul>
  51 These colors also correspond to the colors associated to min/max
  52 values of the palette option.
  53 </ul>
  54 <ul>
  55 <li>\b Rainbow: A palette of several colors will be used to render the
  56 results. A regular and linear progression is considered from min to
  57 max.</li>
  58 <ul>
  59 <li><b>Nb. of colors:</b> defines the number of color to design the
  60 palette (up to 256 colors can be used).</li>
  61 <li><b>Nb. of labels:</b> defines the number of labels to be written
  62 in the bar as text markers.</li>
  63 </ul>
  64 </ul>
  65 <li>\b Orientation - allows to choose between \b Vertical and \b
  66 Horizontal orientation.</li>
  67 <li>\b Origin - allows to define placement and lookout of Scalar
  68 Bars.</li>
  69 <ul>
  70 <li>\b X: abscissa of the point of origin (from the left side).</li>
  71 <li>\b Y: ordinate of the origin of the bar (from the bottom).</li>
  72 </ul>
  73 <li>\b Dimensions - allows to define \b Width and \b Height of each
  74 bar.</li>
  75 <ul>
  76 <li>\b Spacing -  space between the bars (only if both are displayed). </li>
  77 </ul>
  78 <li><b>Text properties:</b> allows to define properties of font and
  79 text associated to the active bar.</li>
  80 <li><b>Bar properties:</b> It allows changing the relative scale of Title, Labels and Color Bar. It is possible to change the visibility of units in Scalar Bar title and format of labels.</li>
  81 </ul>
  82
  83 */