EqPanel
File: Rhapsodist/Widgets/EqPanel.js · Namespace: EqPanel.
Important
Signature likely to change to align with the other widgets.
Overview
Wraps a HISE Parametric EQ effect (effectId) in a DraggableFilterPanel floating tile, with a small auto-hiding display showing the dragged band’s Gain/Freq/Q values.
Display panel
The display panel shows Gain/Freq/Q while a band is being dragged or hovered, and hides itself automatically shortly after the last update.
Usage
create() doesn’t return the panel, it builds directly onto the existing component:
EqPanel.create("pnlEq", "eq", {});
Options
Every key in options is copied onto the panel’s data object.
| Option | Description | Default |
|---|---|---|
displayBufferProperties | Overrides the display buffer’s ring buffer properties (buffer length, window type, decibel range, and so on) set by setEqProperties(). | — |
Look and Feel
| Function | Draws |
|---|---|
drawFilterBackground | The filter panel’s background. |
drawFilterDragHandle | Each band’s draggable handle. |
drawFilterPath | The frequency response curve. |
drawEqPopupMenuBackground | The background of the EQ’s right-click popup menu. |
drawEqPopupMenuItem | Each item in that popup menu (band type icons, delete/enable options, and so on). |
drawAnalyserPath | The spectrum analyser’s waveform path. |
drawAnalyserGrid | The spectrum analyser’s grid lines. |
drawAnalyserBackground | The spectrum analyser’s background. |
Public API
| Function | Description | Returns |
|---|---|---|
create(panelId: string, effectId: string, options: JSON) | Builds the floating tile and display panel, and calls Engine.addModuleStateToUserPreset(effectId) so the EQ’s band configuration is included in saved user presets. Sets display-buffer defaults (2048-sample buffer, Blackman Harris window, -100–0 dB range, logarithmic frequency axis, 0.6 decay) via setEqProperties(). | — |
Broadcasters
| Broadcaster | Description |
|---|---|
data.bc | On the panel identified by panelId (fetch it with Content.getComponent(panelId)). Fires on the EQ’s BandMoved/QChanged/MouseOver events; drives the Gain/Freq/Q display text and its show/hide. |
Internal Reference
| Function | Description | Returns |
|---|---|---|
addBroadcasters(displayPanel: ScriptObject, tileId: string, effect: ScriptObject) | Creates the broadcaster described above. | ScriptObject |
setEqProperties(displayBufferSource, properties) | Applies the display buffer’s ring buffer properties (buffer length, window type, decibel range, and so on). | — |