/ HALion Developer Resource / HALion Macro Page / Controls /

Meter

Description

The Meter control allows you to display incoming values as a meter bar. It displays a background image and a Bitmap for the lit state of the meter to be drawn. The Bitmap for the lit state is drawn clipped on top of the background image. The size of the clipped region depends on the current value. The Meter control can either be drawn horizontally or vertically. The Meter control can be directly connected to parameter outputs of script modules, for example.

❕ For optimal drawing, the Meter control must be placed on the topmost level on the macro page, no other objects must be layered on top.

To display the meter and peak outputs of HALion's busses, a special vu meter template is required that contains two meters and a special logic that allows for the template to be directly connected to any bus. Please use one of these preconfigured meter templates that are part of the Basic Controls library and set the bus parameter to the desired bus, e.g., @bus:0 for the first bus in the program. The graphical resources and sizes can be customized by modifying these templates.

Properties

PopertyDescription
NameThe name of the element. This name will be displayed in the GUI Tree.
Position/SizePosition X, Position Y, Width, Height: Position and size of the element in pixels. Position X/Y defines the position of the upper left corner.
AttachDefines how an element behaves when its parent element is resized. You can set the following parameters:
  • Left: If the parent element is resized, the element remains attached to left edge, with the specified ratio.
  • Right: If the parent element is resized, the element moves relatively to the right edge, with the specified ratio.
  • Top: If the parent element is resized, the element remains attached to top edge, with the specified ratio.
  • Bottom: If the parent element is resized, the element moves relatively to the bottom edge, with the specified ratio.
  • Left + Right: If the parent element is resized, the element is resized horizontally relatively to the left and right edges, with the specified ratio.
TooltipText that appears as a tooltip when the mouse hovers over the element.
ValueDrag and drop a parameter from the Parameter List to this text field to establish a connection. The assigned parameter will be displayed. Alternatively, you can export the property, which can then be used as a template parameter on a template instance.
Peak ValueAllows you to connect a parameter that delivers a peak hold value.
Style
  • Vertical: Activate this option if you want to display a vertical meter instead of the standard horizontal meter.
  • Scalable: Activate this if you want to be able to resize the element. The assigned Bitmap resources are resized according to the Scale Mode that is defined for the respective Bitmap resource.
Bitmaps
  • Meter: Allows you to assign the Bitmap that is used for the lit meter.
  • Background: Allows you to assign the Bitmap that is used as background for the meter (e.g., a dimmed version of the lit meter bitmap).