DH_ControlOverlay

In operation, this module tracks the mouse, monitors your controls, and outputs text strings and/or tool tips containing descriptive and value information about the control under the current mouse position. It also provides the tools you use to draw the layout, and define the information you want to have displayed for each control.

Because this module does so much, it is covered in much more detail in a dedicated section of the User's Guide, entitled An In-Depth Guide to the DH_ControlOverlay. A brief description is given here.

Here's a quick rundown of its input and output pins:

Ctrl Name - Outputs the name of the control currently under the mouse.

Mode - the module has 2 modes:

• Layout, used to create your control display setup

• Run, for actual operation.
  
   

Enable Tool Tips - Controls whether or not tool tips will be displayed. This is a global switch that affects the tool tips for all controls. It could be used, for example, to give the user the option to turn all tool tips off.

Default Description - An optional text string to be output at the Description pin when the mouse is not over a predefined area..

Value String - Outputs the current value of the control currently under the mouse.
For Numeric controls, a formatted text string containing the number and optional units or labels.
For List controls, the selected item, as specified in a text file of list items assigned to the control.


Description - Outputs a text string that describes the control currently under the mouse. May contain more than one line.

Ctrl Index - Outputs the Control # of the control currently under the mouse. Output is 0 if mouse is not over a predefined area. May be used to integrate a DH_ControlOverlay with other modules, including other DH_ControlOverlays from different panels.

Ctrl In - Autoduplicates to provide an input for each control. The controls are assigned index numbers as they are connected, from the top down. This Control # links the connected control to the information you enter fro the control in the DH_ControlOverlay dialog, and to the Ctrl Index.
 

Parameters on the Properties window:

Title - Normally the name of the module, but may be blanked out to make the overlay totally invisible on the panel in run mode.

VST_Name - Normally, the name of your VST. The extension ".txt" will be appended to this to create the filename for the file that stores layout and control information.

Note: If you have multiple panels, and want to use DH_ControlOverlays on more than one, append a number or other designator to the end of the VST name so that each panel will have its own layout file.
 

top