A UI component that allows editing of a windowing function applied to a waveform. More...

#include <wave_window_editor.h>

Inheritance diagram for WaveWindowEditor:

Classes
class	Listener
	Interface for receiving notifications about window position changes. More...

Public Types
enum	ActiveSide { kNone , kLeft , kRight }
	Enum representing which side (left or right) is being edited or hovered. More...

Public Member Functions
	WaveWindowEditor ()
	Constructs a WaveWindowEditor instance.

virtual	~WaveWindowEditor ()
	Destructor.

void	paintBackground (Graphics &g) override
	Paints the background. Currently does nothing as rendering is handled by OpenGL.

void	resized () override
	Called when the component is resized. Updates the rendering and layout.

virtual void	init (OpenGlWrapper &open_gl) override
	Initializes OpenGL components.

virtual void	render (OpenGlWrapper &open_gl, bool animate) override
	Renders the window editor. Draws the line and the handle bars.

virtual void	destroy (OpenGlWrapper &open_gl) override
	Destroys OpenGL resources.

void	mouseDown (const MouseEvent &e) override
	Handles mouse down events, determining which side (if any) is selected.

void	mouseUp (const MouseEvent &e) override
	Handles mouse up events, finalizing changes if a handle was being moved.

void	mouseMove (const MouseEvent &e) override
	Handles mouse move events, updating hover states over handles.

void	mouseExit (const MouseEvent &e) override
	Handles mouse exit events, resetting hover states.

void	mouseDrag (const MouseEvent &e) override
	Handles mouse drag events, adjusting the window boundaries.

void	addListener (Listener *listener)
	Adds a listener for window changes.

ActiveSide	getHover (Point< int > position)
	Determines which handle (left or right) is being hovered based on a position.

float	getLeftPosition ()
	Gets the left boundary's normalized position.

float	getRightPosition ()
	Gets the right boundary's normalized position.

void	setPositions (float left, float right)
	Sets the left and right boundary positions for the window.

void	setWindowShape (WaveWindowModifier::WindowShape window_shape)
	Sets the window shape type.

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.

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	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.

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	kGrabRadius = 0.05f

static constexpr int	kPointsPerSection = 50

static constexpr int	kTotalPoints = 4 * kPointsPerSection

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< OpenGlCorners >	corners_
	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 SynthSection *	parent_
	Pointer to parent SynthSection for skin lookups.

Skin::SectionOverride	skin_override_
	Skin override for custom appearance.

const vital::StatusOutput *	num_voices_readout_
	StatusOutput for voice count lookups.

Detailed Description

A UI component that allows editing of a windowing function applied to a waveform.

The WaveWindowEditor displays a graphical window shape that can be adjusted by dragging handles on the left and right sides. Users can interact with these handles (left and right) to shift the window's range, and the resulting window shape is updated in real-time. Different window shapes can be applied and listeners can be notified of changes.

Member Enumeration Documentation

◆ ActiveSide

enum WaveWindowEditor::ActiveSide

Enum representing which side (left or right) is being edited or hovered.

Enumerator
kNone	No side is active.
kLeft	The left handle is active.
kRight	The right handle is active.

Constructor & Destructor Documentation

◆ WaveWindowEditor()

WaveWindowEditor::WaveWindowEditor ( )

Constructs a WaveWindowEditor instance.

◆ ~WaveWindowEditor()

WaveWindowEditor::~WaveWindowEditor ( )

virtual

Destructor.

Member Function Documentation

◆ addListener()

void WaveWindowEditor::addListener ( Listener * listener )

inline

Adds a listener for window changes.

Parameters

listener The listener to add.

◆ destroy()

virtual void WaveWindowEditor::destroy ( OpenGlWrapper & open_gl )

inlineoverridevirtual

Destroys OpenGL resources.

Parameters

open_gl The OpenGL wrapper to use.

Reimplemented from OpenGlLineRenderer.

◆ getHover()

WaveWindowEditor::ActiveSide WaveWindowEditor::getHover ( Point< int > position )

Determines which handle (left or right) is being hovered based on a position.

Parameters

position The position to check.

Returns: The active side being hovered, or kNone if none is hovered.

◆ getLeftPosition()

float WaveWindowEditor::getLeftPosition ( )

inline

Gets the left boundary's normalized position.

Returns: The left boundary position in [0, 1].

◆ getRightPosition()

float WaveWindowEditor::getRightPosition ( )

inline

Gets the right boundary's normalized position.

Returns: The right boundary position in [0, 1].

◆ init()

virtual void WaveWindowEditor::init ( OpenGlWrapper & open_gl )

inlineoverridevirtual

Initializes OpenGL components.

Parameters

open_gl The OpenGL wrapper to use.

Reimplemented from OpenGlLineRenderer.

◆ mouseDown()

void WaveWindowEditor::mouseDown ( const MouseEvent & e )

override

Handles mouse down events, determining which side (if any) is selected.

Parameters

e	The mouse event.

◆ mouseDrag()

void WaveWindowEditor::mouseDrag ( const MouseEvent & e )

override

Handles mouse drag events, adjusting the window boundaries.

Parameters

e	The mouse event.

◆ mouseExit()

void WaveWindowEditor::mouseExit ( const MouseEvent & e )

override

Handles mouse exit events, resetting hover states.

Parameters

e	The mouse event.

◆ mouseMove()

void WaveWindowEditor::mouseMove ( const MouseEvent & e )

override

Handles mouse move events, updating hover states over handles.

Parameters

e	The mouse event.

◆ mouseUp()

void WaveWindowEditor::mouseUp ( const MouseEvent & e )

override

Handles mouse up events, finalizing changes if a handle was being moved.

Parameters

e	The mouse event.

◆ paintBackground()

void WaveWindowEditor::paintBackground ( Graphics & g )

inlineoverridevirtual

Paints the background. Currently does nothing as rendering is handled by OpenGL.

Parameters

g	The graphics context to draw into.

Reimplemented from OpenGlComponent.

◆ render()

virtual void WaveWindowEditor::render	(	OpenGlWrapper &	open_gl,
		bool	animate )

inlineoverridevirtual

Renders the window editor. Draws the line and the handle bars.

Parameters

open_gl	The OpenGL wrapper to use.
animate	True if animation is enabled.

Reimplemented from OpenGlLineRenderer.

◆ resized()

void WaveWindowEditor::resized ( )

overridevirtual

Called when the component is resized. Updates the rendering and layout.

Reimplemented from OpenGlComponent.

◆ setPositions()

void WaveWindowEditor::setPositions	(	float	left,
		float	right )

inline

Sets the left and right boundary positions for the window.

Parameters

left	New left position in [0, 1].
right	New right position in [0, 1].

◆ setWindowShape()

void WaveWindowEditor::setWindowShape ( WaveWindowModifier::WindowShape window_shape )

inline

Sets the window shape type.

Parameters

window_shape The new window shape.

Member Data Documentation

◆ kGrabRadius

float WaveWindowEditor::kGrabRadius = 0.05f

staticconstexpr

The radius (in normalized units) around the handles to detect mouse hover or dragging.

◆ kPointsPerSection

int WaveWindowEditor::kPointsPerSection = 50

staticconstexpr

The number of points per window section to ensure a smooth curve.

◆ kTotalPoints

int WaveWindowEditor::kTotalPoints = 4 * kPointsPerSection

staticconstexpr

The total number of points plotted for the full window shape.

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

/Users/davidvogel/repos/VitalHelp/src/interface/wavetable/editors/wave_window_editor.h
/Users/davidvogel/repos/VitalHelp/src/interface/wavetable/editors/wave_window_editor.cpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ActiveSide

Constructor & Destructor Documentation

◆ WaveWindowEditor()

◆ ~WaveWindowEditor()

Member Function Documentation

◆ addListener()

◆ destroy()

◆ getHover()

◆ getLeftPosition()

◆ getRightPosition()

◆ init()

◆ mouseDown()

◆ mouseDrag()

◆ mouseExit()

◆ mouseMove()

◆ mouseUp()

◆ paintBackground()

◆ render()

◆ resized()

◆ setPositions()

◆ setWindowShape()

Member Data Documentation

◆ kGrabRadius

◆ kPointsPerSection

◆ kTotalPoints