A rotary encoder is an adjustable rotary control that 1) manipulates a device parameter and 2) displays values of a device parameter.
When a Custom Panel is activated, the rotary control (inner ring) changes the linked parameter values as the end user clicks and slides it around it to the desired value position (like twisting a nob). The rotary encoder is controlled by right-clicking with the mouse and moving to the top or right to increase the value and moving to the bottom or left to decrease the value.
The LED meter (outer ring) reflects the selected parameter values, which are usually the same as those linked to and adjusted by the rotary control.
Controls can be managed in the Custom Panel designer and, once the Custom Panel is activated, utilized by the end user. This control must be linked to a parameter to function properly.
|
|
OPTIONS / INSTRUCTIONS |
NOTES / EXAMPLE |
General |
||
|
Control Info |
The control type |
Read only |
|
Locked |
Specifies if the control is locked out so that it cannot be moved or re-sized |
Checked = Locked Unchecked = Unlocked |
Parameters |
||
|
Addresses |
The HiQnet address of the control Enables panel designer to edit addressing information with the added benefit that the values can be validated as a group before being applied to the device. This editor also allows the user to assign multiple parameters to the control. Click to select Parameter Address Editor |
Properties correspond to the system explorer |
|
Parameter Info |
Shows information about the Parameter Address |
Read only Properties correspond to the system explorer |
|
Rotary Maximum |
Maximum parameter value |
The largest parameter value |
|
Rotary Minimum |
Minimum parameter value |
The smallest parameter value |
|
Meter Maximum |
Maximum meter value |
The largest meter value |
|
Meter Minimum |
Minimum meter value |
The smallest meter value |
|
Reset Text |
Optional text to display in right click context popup |
|
Appearance |
||
|
Location |
Control location (in pixels) of the control on the Custom Panel Change X (horizontal) and Y (vertical) values in relation to upper left corner You can also drag the control to a different location |
|
|
Size |
Control size (in pixels) Change width and height values You can also re-size the control manually |
|
|
Background Image |
Click to select background image Brings up the Select Image File window |
|
|
Background Color |
Background color of the control Brings up the Select Color window |
|
|
Foreground Color |
Foreground color of the control Brings up the Select Color window |
|
|
Font |
Font style for the text on the control Click on "..." to select desired font
|
Selects from Windows fonts |
|
Mode String |
User-definable description of mode |
|
|
Anti-Aliasing |
Whether or not to draw with anti-aliasing |
Checked = With anti-aliasing Unchecked = Without anti-aliasing
|
|
Tool Tip Text |
The text that appears on control mouse-over |
|
|
Tab Index |
If tab stop is set to true, determines the position of the control in the tab order |
|
|
Tab Stop |
Specifies whether the control appears in the tab order |
Checked = Appears Unchecked = Does not appear |
Backing Circle |
||
|
Radius |
Radius for the backing circle as fraction of control size |
|
|
Color |
Color of the backing circle Brings up the Select Color window |
Use "Transparent" to disable |
|
Border Width |
Width of the backing circle border |
|
|
Border Color |
Color of the backing circle border Brings up the Select Color window |
|
Rotary |
||
|
Encoder Multiplier |
The amount that the turn of the rotary is multiplied to tune sensitivity |
|
|
Base Image |
The image displayed for the inside of the knob Brings up the Select Image File window |
|
|
Ring Image |
The image displayed for the outside of the knob Brings up the Select Image File window |
|
|
Knob Radius |
The radius of the rotary knob as percent of control size. |
Must be less than meter inner radius but greater than half of the meter inner radius. |
|
Nudge Amount |
Determines, with the nudge type, how much the control will adjust when up and down arrow keys are pressed |
|
|
Nudge Type |
Determines, with the nudge amount, how much the control will adjust when up and down arrow keys are pressed Percent - percentage of the total visual display of the control. For non-logarithmic controls, the visual display and the total value of the control will be the same. For logarithmic controls, the visual display will differ from the total value. Bump - small increment Value - specified nudge amount
|
|
Meter |
||
|
Encoder Mode |
The display mode for the LED elements |
Clockwise is the default |
|
Outer Radius |
The outside edge of the display meter as a percentage of the entire circle |
Must be less than 1 (outer edge of control) and greater than the inner radius |
|
Inner Radius |
The inside edge of the display meter as a percentage of the entire circle |
Must be less than meter outer radius |
|
Starting Angle |
Where the meter display starts |
Measured in degrees from where "0" is straight up (-180...180) |
|
Ending Angle |
Where the meter display ends |
Measured in degrees from where "0" is straight up (-180...180) |
|
Separation Angle |
The angle, in degrees, separating each segment |
|
|
Segment Count |
The number of segments in the display |
|
|
Off Color |
The "off" color of the control Brings up the Select Color window |
|
|
On Color |
The "on" color of the control Brings up the Select Color window |
|
|
Segment Border Color |
The color of the segment border Brings up the Select Color window |
|
Command Button |
||
|
Reset Image |
Resets rotary base and ring images |
|