Update documentation according to the issue "20948: EDF 1468 SMESH: Histogram of the quality controls"

This commit is contained in:
rnv 2010-11-22 11:44:39 +00:00
parent 9dd24d46bc
commit 16a840f9c1
4 changed files with 55 additions and 4 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -32,8 +32,6 @@ Edge quality controls:
Face quality controls:
<ul>
<li>\subpage free_faces_page "Free faces"</li>
<li>\subpage bare_border_faces_page "Bare border faces"</li>
<li>\subpage over_constrained_faces_page "Over-constrained faces"</li>
<li>\subpage length_2d_page "Length 2D"</li>
<li>\subpage borders_at_multi_connection_2d_page "Borders at multi-connection 2D"</li>
<li>\subpage area_page "Area"</li>
@ -50,8 +48,21 @@ Volume quality controls:
<li>\subpage aspect_ratio_3d_page "Aspect ratio 3D"</li>
<li>\subpage volume_page "Volume"</li>
<li>\subpage max_element_length_3d_page "Max element length 3D"</li>
<li>\subpage bare_border_volumes_page "Bare border volumes"</li>
<li>\subpage over_constrained_volumes_page "Over-constrained volumes"</li>
</ul>
To manage the quality controls call pop-up in the VTK viewer and select "Controls" sub-menu
\image html controls_popup.png
<ul>
<li> <b>Reset</b> switches off quality controls;</li>
<li> <b>Node Controls</b> provides access to the node quality controls;</li>
<li> <b>Edge Controls</b> provides access to the edge quality controls;</li>
<li> <b>Face Controls</b> provides access to the face quality controls;</li>
<li> <b>Volume Controls</b> provides access to the volume quality controls;</li>
<li> <b>Scalar Bar Properties</b> allows setting \subpage scalar_bar_dlg;</li>
<li> <b>Export Distribution...</b> allows saving the distribution of quality control values in the text file;</li>
<li> <b>Show Distribution</b> Shows/Hides the distribution histogram of the quality control values in the VTK Viewer.</li>
</ul>
*/

View File

@ -0,0 +1,40 @@
/*!
\page scalar_bar_dlg Scalar Bar properties
In this dialog you can specify the properties of the scalar bar
\image html scalar_bar_dlg.png
<ul>
<li><b>Scalar Range</b> in this menu you can specify
<b>Min value</b> and <b>Max value</b> of the <b>Scalar Bar</b> </li>
<li><b>Font</b> - in this menu you can set type, face and color for
the font of <b>Title</b> and <b>Labels</b> of the <b>Scalar
Bar</b></li>
<li><b>Colors & Labels</b> - in this menu you can set the <b>number of
colors</b> and the <b>number of labels</b> of the <b>Scalar
Bar</b></li>
<li><b>Orientation</b> - allows choosing between vertical and
horizontal orientation of the <b>Scalar Bar</b></li>.
<li><b>Origin & Size Vertical & Horizontal</b> - allows defining the
location (<b>X</b> and <b>Y</b>) and size (<b>Width</b> and
<b>Height</b>) of <b>Scalar Bar</b></li>
<ul>
<li><b>X</b>: abscissa of the origin (from the left
side)</li>
<li><b>Y</b>: ordinate of the origin (from the bottom)</li>
</ul>
<li><b>Distribution</b> in this menu you can Show/Hide distribution histogram of the values of the <b>Scalar Bar</b> and specify histogram properties</li>
<ul>
<li><b>Multicolor</b> the histogram is colored as <b>Scalar Bar</b></li>
<li><b>Monocolor</b> the histogram is colored as selected with <b>Distribution color</b> selector</li>
</ul>
</ul>
*/