source: branches/lib/HELP_SOURCE/source/field_shader.hlp

Last change on this file was 19532, checked in by westram, 4 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
File size: 1.9 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6SUB     tree_shading.hlp
7SUB     aci.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Database field shader
13
14OCCURRENCE      ARB_NT/Tree/Tree shading/...
15
16                Select 'Database field shader' and press 'Configure'.
17
18DESCRIPTION     This field shader allows to shade items (eg. species in tree) according
19                to one or more database entries.
20
21                Each row in this window configures one dimension.
22                Each dimension defines one color-channel.
23
24                The toggle at the beginning of each row switches the dimension on/off.
25
26                The button behind selects the database field which shall be visualized as color.
27                The database fields normally has to contain a numeric value.
28
29                The next input field allows to specify an ACI command. It will be applied to the
30                content of the database field and the result will be interpreted as numeric value.
31
32                The two inputfields behind the field-selection specify the lower and upper border
33                of the value-range.
34
35                   Press the 'SCAN' button to scan all database entries (+apply ACI)
36                   for minimum and maximum occurring values and use them as value-range.
37
38                   The value range is mapped to the active color range which can be selected
39                   in the shader setup window.
40
41                   Values outside the value-range are forced into the range, eg. if the specified
42                   value-range is [10 .. 20], then a value of 5 is displayed like 10 and a value
43                   of 25 is displayed like 20.
44
45NOTES           If you exchange the borders of the value range (eg. [20 .. 10]) it will be
46                mapped reverse.
47
48EXAMPLES        None
49
50WARNINGS        None
51
52BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.