(Meter Parts Library)
| Description | Draws a legend (i.e. the text labels) for a linear type meter. They are drawn in a line, either horizontally or vertically, with consistent spacing. This function must be called inside a GUITransform to work properly. |
| Returns | Image handle |
| Usage | Steady State only. |
| Function Groups | Graphics |
| Related to: | |
Format:  |
\MeterParts\LinearLegend(TagName, Orientation, NumLabels, Font, Color, Reserved, UseTagScaling, MinScaleValue, MaxScaleValue) |
| Parameters |
| TagName |
| Required. The name of the Tag to use for scaling. If no tag is specified, then tag scaling cannot be used to automatically obtain the minimum and maximum scale values. |
| Orientation |
| A flag indicating the orientation of the legend. Set to 0 for horizontal and 1 for vertical. The default is 0 (Horizontal). |
| NumLabels |
| The number of Labels to show. The default is 3. |
| Font |
| The name of a Font tag to use for the legend text. |
| Color |
| A color index for the color of the legend text. The default is 0 (black). |
| Reserved n/a |
| For use at a later time. Should be set to 0. |
| UseTagScaling |
| A flag that indicates whether to use the supplied tag’s scaling values. The default is false. |
| MinScaleValue |
| The minimum scale value to use if the UseTagScaling flag is not true. The default is 0. |
| MaxScaleValue |
| The maximum scale value to use if the UseTagScaling flag is not true. The default is 100. |
| Comments | This function must be called within a GUITransform statement in order for it to work correctly. The text should scale with the size of the transform. If it does not, then you might have picked a font that doesn’t scale. Some non true-type fonts will not scale. |
Example:
GUITransform(694, 852, 844, 702,
1, 1, 1, 1, 1 { Scaling },
0, 0 { Movement },
1, 0 { Visibility, Reserved },
0, 0, 0 { Selectability },
\MeterParts\LinearLegend(Invalid, 0, 3, Invalid, 0, 0,
0, 0, 0, 100));
