(Meter Parts Library)
| Description: | Draws a legend (i.e. the text labels) for a radial type meter. They are drawn at a constant radius from the center point of the drawing coordinates, beginning at a defined minimum angle and ending at a defined maximum angle. To be called from within a GUITransform. |
| Returns: | Nothing |
Usage:  |
Steady State only. |
| Function Groups: | Graphics |
| Related to: | GUITransform | RadialLegend |
| Format: |
\MeterParts\RadialLegend(TagName[, MinimumAngle, MaximumAngle, NumLabels, Font, Color, Direction, Orientation, 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. |
| MinimumAngle |
| The start angle of the sweep. 0 is defined as up or the 12 o’clock position. The default is 225. |
| MaximumAngle |
| The end angle of the sweep. 0 is defined as up or the 12 o’clock position. The default is 135. |
| NumLabels |
| The number of Labels to show. The default is 5. |
| 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). |
| Direction |
| A flag indicating the direction from the minimum to the maximum value representation. 0 means increase in a clockwise manner while 1 indicates a counter-clockwise manner. The default is 0 (clockwise). |
| Orientation |
| A reserved parameter and 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 won’t scale. |
Example:
GUITransform(478, 616, 628, 466,
1, 1, 1, 1, 1 { Scaling },
0, 0 { Movement },
1, 0 { Visibility, Reserved },
0, 0, 0 { Selectability },
\MeterParts\RadialLegend(Invalid, 225, 135, 5, Invalid,
0, 0, 0, 0, 0, 100));
