Vital
Loading...
Searching...
No Matches
DelayFilterViewer Class Reference

A viewer that displays and allows interaction with the delay effect's filter response. More...

#include <delay_section.h>

Inheritance diagram for DelayFilterViewer:
OpenGlLineRenderer OpenGlComponent

Classes

class  Listener
 Interface for objects that want to respond to mouse drag movements in the filter viewer. More...
 

Public Member Functions

 DelayFilterViewer (const std::string &prefix, int resolution, const vital::output_map &mono_modulations)
 
vital::poly_float getCutoff ()
 Gets the current cutoff value (modulated or from slider).
 
vital::poly_float getSpread ()
 Gets the current spread value (modulated or from slider).
 
void drawLines (OpenGlWrapper &open_gl, bool animate, float high_midi_cutoff, float low_midi_cutoff)
 Draws the filter lines given the high and low MIDI cutoff values.
 
void render (OpenGlWrapper &open_gl, bool animate) override
 
void mouseDown (const MouseEvent &e) override
 
void mouseDrag (const MouseEvent &e) override
 
void setCutoffSlider (Slider *slider)
 
void setSpreadSlider (Slider *slider)
 
void setActive (bool active)
 
void addListener (Listener *listener)
 
- Public Member Functions inherited from OpenGlLineRenderer
 OpenGlLineRenderer (int num_points, bool loop=false)
 Constructs an OpenGlLineRenderer for a given number of points.
 
virtual ~OpenGlLineRenderer ()
 Destructor.
 
virtual void init (OpenGlWrapper &open_gl) override
 Initializes OpenGL resources for rendering the line.
 
virtual void destroy (OpenGlWrapper &open_gl) override
 Destroys OpenGL resources allocated by this line renderer.
 
force_inline void setColor (Colour color)
 Sets the line color.
 
force_inline void setLineWidth (float width)
 Sets the line width in pixels.
 
force_inline void setBoost (float boost)
 Sets a global boost value affecting line thickness.
 
force_inline float boostLeftAt (int index) const
 Gets the left-side boost at a given point index.
 
force_inline float boostRightAt (int index) const
 Gets the right-side boost at a given point index.
 
force_inline float yAt (int index) const
 Gets the y-coordinate of a point at a given index.
 
force_inline float xAt (int index) const
 Gets the x-coordinate of a point at a given index.
 
force_inline void setBoostLeft (int index, float val)
 Sets the left-side boost for a point, marking data as dirty.
 
force_inline void setBoostRight (int index, float val)
 Sets the right-side boost for a point, marking data as dirty.
 
force_inline void setYAt (int index, float val)
 Sets the y-coordinate of a point, marking data as dirty.
 
force_inline void setXAt (int index, float val)
 Sets the x-coordinate of a point, marking data as dirty.
 
void setFillVertices (bool left)
 Sets fill vertices according to the current line and boost data.
 
void setLineVertices (bool left)
 Sets line vertices according to the current line and boost data.
 
force_inline void setFill (bool fill)
 Enables or disables filling below the line.
 
force_inline void setFillColor (Colour fill_color)
 Sets a uniform fill color if only one color is needed.
 
force_inline void setFillColors (Colour fill_color_from, Colour fill_color_to)
 Sets a gradient fill from one color to another.
 
force_inline void setFillCenter (float fill_center)
 Sets the vertical center for the fill area.
 
force_inline void setFit (bool fit)
 Enables fitting the line inside the available area.
 
force_inline void setBoostAmount (float boost_amount)
 Sets the boost amount that affects line thickness.
 
force_inline void setFillBoostAmount (float boost_amount)
 Sets the boost amount that affects fill thickness.
 
force_inline void setIndex (int index)
 Sets an index used for custom behavior (e.g., multiple line sets).
 
void boostLeftRange (float start, float end, int buffer_vertices, float min)
 Boosts left-side range of the line.
 
void boostRightRange (float start, float end, int buffer_vertices, float min)
 Boosts right-side range of the line.
 
void boostRange (float *boosts, float start, float end, int buffer_vertices, float min)
 Boosts a range for the given boost array.
 
void boostRange (vital::poly_float start, vital::poly_float end, int buffer_vertices, vital::poly_float min)
 Boosts left and right arrays using poly_float parameters.
 
void decayBoosts (vital::poly_float mult)
 Decays all boosts by a multiplicative factor, allowing animated damping.
 
void enableBackwardBoost (bool enable)
 Enables backward boost calculation for symmetrical line deformation.
 
force_inline int numPoints () const
 Gets the number of points in the line.
 
force_inline Colour color () const
 Gets the current line color.
 
void drawLines (OpenGlWrapper &open_gl, bool left)
 Draws the line and optional fill using OpenGL.
 
bool anyBoostValue ()
 Checks if any boost value is set.
 
- Public Member Functions inherited from OpenGlComponent
 OpenGlComponent (String name="")
 Constructs an OpenGlComponent.
 
virtual ~OpenGlComponent ()
 Destructor.
 
virtual void resized () override
 Called when the component is resized.
 
virtual void parentHierarchyChanged () override
 Called when the component's parent hierarchy changes.
 
void addRoundedCorners ()
 Adds rounded corners to the component's edges.
 
void addBottomRoundedCorners ()
 Adds rounded corners only at the bottom of the component.
 
void renderCorners (OpenGlWrapper &open_gl, bool animate, Colour color, float rounding)
 Renders the corner shapes using the given color and rounding amount.
 
void renderCorners (OpenGlWrapper &open_gl, bool animate)
 Renders corners with default body color and rounding.
 
virtual void paintBackground (Graphics &g)
 Paints a standard background for the component.
 
void repaintBackground ()
 Requests a repaint of the component's background on the OpenGL layer.
 
Colour getBodyColor () const
 Retrieves the component's body color.
 
void setParent (const SynthSection *parent)
 Sets a pointer to the parent SynthSection for skin value lookups.
 
float findValue (Skin::ValueId value_id)
 Finds a float value from the skin associated with this component's parent.
 
void setSkinValues (const Skin &skin)
 Applies the skin overrides to this component's colors.
 
void setSkinOverride (Skin::SectionOverride skin_override)
 Sets a skin override to control the component's color scheme.
 
force_inline void checkGlError ()
 Checks for and asserts that there are no OpenGL errors.
 
void setBackgroundColor (const Colour &color)
 Sets the background color of the component for painting operations.
 

Static Public Attributes

static constexpr float kMidiDrawStart = 8.0f
 The MIDI note range for drawing the filter response.
 
static constexpr float kMidiDrawEnd = 132.0f
 
static constexpr float kMinDb = -18.0f
 Minimum and maximum dB values for the filter response display.
 
static constexpr float kMaxDb = 6.0f
 
- Static Public Attributes inherited from OpenGlLineRenderer
static constexpr int kLineFloatsPerVertex = 3
 Floats per vertex in the line data (x, y, and potentially others).
 
static constexpr int kFillFloatsPerVertex = 4
 Floats per vertex in the fill data (x, y, and boost value).
 
static constexpr int kLineVerticesPerPoint = 6
 Number of vertices per point in the line representation.
 
static constexpr int kFillVerticesPerPoint = 2
 Number of vertices per point in the fill representation.
 
static constexpr int kLineFloatsPerPoint = kLineVerticesPerPoint * kLineFloatsPerVertex
 Floats per point in the line data (6 vertices * 3 floats each).
 
static constexpr int kFillFloatsPerPoint = kFillVerticesPerPoint * kFillFloatsPerVertex
 Floats per point in the fill data (2 vertices * 4 floats each).
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenGlComponent
static bool setViewPort (Component *component, Rectangle< int > bounds, OpenGlWrapper &open_gl)
 Sets the OpenGL viewport to match a specified rectangle within a component.
 
static bool setViewPort (Component *component, OpenGlWrapper &open_gl)
 Convenience overload that sets the viewport for the entire component's local bounds.
 
static void setScissor (Component *component, OpenGlWrapper &open_gl)
 Sets the OpenGL scissor region to the entire component's local bounds.
 
static void setScissorBounds (Component *component, Rectangle< int > bounds, OpenGlWrapper &open_gl)
 Sets the OpenGL scissor region to a specified rectangle within a component.
 
static std::unique_ptr< OpenGLShaderProgram::Uniform > getUniform (const OpenGlWrapper &open_gl, const OpenGLShaderProgram &program, const char *name)
 Retrieves a uniform from the shader program if it exists.
 
static std::unique_ptr< OpenGLShaderProgram::Attribute > getAttribute (const OpenGlWrapper &open_gl, const OpenGLShaderProgram &program, const char *name)
 Retrieves an attribute from the shader program if it exists.
 
static String translateFragmentShader (const String &code)
 Translates a fragment shader code snippet to be compatible with the current GL version.
 
static String translateVertexShader (const String &code)
 Translates a vertex shader code snippet to be compatible with the current GL version.
 
- Protected Member Functions inherited from OpenGlComponent
bool setViewPort (OpenGlWrapper &open_gl)
 Sets the viewport for this component using the current OpenGlWrapper.
 
- Protected Attributes inherited from OpenGlComponent
std::unique_ptr< OpenGlCornerscorners_
 Optional corners for rounded edges.
 
bool only_bottom_corners_
 Flag to round only the bottom corners.
 
Colour background_color_
 The background color of the component.
 
Colour body_color_
 The body color of the component.
 
const SynthSectionparent_
 Pointer to parent SynthSection for skin lookups.
 
Skin::SectionOverride skin_override_
 Skin override for custom appearance.
 
const vital::StatusOutputnum_voices_readout_
 StatusOutput for voice count lookups.
 

Detailed Description

A viewer that displays and allows interaction with the delay effect's filter response.

This class uses an OpenGL line renderer to show the frequency response of the delay's filter. It supports dragging to modify filter cutoff and spread values. Observers implementing the Listener interface can respond to mouse drag delta movements.

Constructor & Destructor Documentation

◆ DelayFilterViewer()

DelayFilterViewer::DelayFilterViewer ( const std::string & prefix,
int resolution,
const vital::output_map & mono_modulations )
inline

Constructor.

Parameters
prefixA string prefix to identify the delay's parameters.
resolutionThe number of points to use when rendering the line.
mono_modulationsA map of modulation outputs from the synth.

Member Function Documentation

◆ addListener()

void DelayFilterViewer::addListener ( Listener * listener)
inline

Adds a listener to receive mouse drag events.

Parameters
listenerThe listener to add.

◆ drawLines()

void DelayFilterViewer::drawLines ( OpenGlWrapper & open_gl,
bool animate,
float high_midi_cutoff,
float low_midi_cutoff )
inline

Draws the filter lines given the high and low MIDI cutoff values.

◆ getCutoff()

vital::poly_float DelayFilterViewer::getCutoff ( )
inline

Gets the current cutoff value (modulated or from slider).

◆ getSpread()

vital::poly_float DelayFilterViewer::getSpread ( )
inline

Gets the current spread value (modulated or from slider).

◆ mouseDown()

void DelayFilterViewer::mouseDown ( const MouseEvent & e)
inlineoverride

Handles mouse down events, storing the initial mouse position.

Parameters
eThe mouse event.

◆ mouseDrag()

void DelayFilterViewer::mouseDrag ( const MouseEvent & e)
inlineoverride

Handles mouse drag events, calculating delta movements and notifying listeners.

Parameters
eThe mouse event.

◆ render()

void DelayFilterViewer::render ( OpenGlWrapper & open_gl,
bool animate )
inlineoverridevirtual

Renders the filter line based on current cutoff and spread values.

Parameters
open_glThe OpenGlWrapper.
animateWhether to animate transitions.

Reimplemented from OpenGlLineRenderer.

◆ setActive()

void DelayFilterViewer::setActive ( bool active)
inline

Sets whether the viewer is active.

Parameters
activeTrue if active, false otherwise.

◆ setCutoffSlider()

void DelayFilterViewer::setCutoffSlider ( Slider * slider)
inline

Sets the slider controlling the cutoff frequency.

Parameters
sliderThe cutoff slider.

◆ setSpreadSlider()

void DelayFilterViewer::setSpreadSlider ( Slider * slider)
inline

Sets the slider controlling the filter spread.

Parameters
sliderThe spread slider.

Member Data Documentation

◆ kMaxDb

float DelayFilterViewer::kMaxDb = 6.0f
staticconstexpr

◆ kMidiDrawEnd

float DelayFilterViewer::kMidiDrawEnd = 132.0f
staticconstexpr

◆ kMidiDrawStart

float DelayFilterViewer::kMidiDrawStart = 8.0f
staticconstexpr

The MIDI note range for drawing the filter response.

◆ kMinDb

float DelayFilterViewer::kMinDb = -18.0f
staticconstexpr

Minimum and maximum dB values for the filter response display.


The documentation for this class was generated from the following file: