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

Manages the display and interaction of wavetable keyframes and groups on a timeline. More...

#include <wavetable_organizer.h>

Inheritance diagram for WavetableOrganizer:
SynthSection WavetablePlayhead::Listener WavetableComponentList::Listener SynthButton::ButtonListener

Classes

class  Listener
 Interface for objects that need to respond to organizer events. More...
 

Public Types

enum  OrganizerMenu { kCancel = 0 , kCreate , kRemove }
 Menu actions available in the organizer context menus. More...
 
enum  MouseMode {
  kWaiting , kSelecting , kDragging , kRightClick ,
  kNumMouseModes
}
 The current mouse interaction mode used by the organizer. More...
 

Public Member Functions

 WavetableOrganizer (WavetableCreator *wavetable_creator, int max_frames)
 Constructs a WavetableOrganizer.
 
virtual ~WavetableOrganizer ()
 
void paintBackground (Graphics &g) override
 Paints the background, including a grid and handle areas.
 
void resized () override
 Handles resizing and rearranges the displayed frames and rows.
 
void mouseDown (const MouseEvent &event) override
 Called when the mouse button is pressed. Used for selecting frames, starting drags, or displaying a menu.
 
void mouseDrag (const MouseEvent &event) override
 Called as the mouse is dragged. Used for dragging frames or adjusting selection rectangles.
 
void mouseUp (const MouseEvent &event) override
 Called when the mouse button is released. Finalizes drags, completes selections, or handles context menu actions.
 
void mouseDoubleClick (const MouseEvent &event) override
 Called on a double-click. Used for quickly adding or removing keyframes.
 
void mouseWheelMove (const MouseEvent &e, const MouseWheelDetails &wheel) override
 Called when the mouse wheel is moved. Passes wheel movements to listeners for additional behaviors (like scrolling).
 
void playheadMoved (int position) override
 Called when the playhead moves, updates the visual playhead position.
 
void componentAdded (WavetableComponent *component) override
 Called when a component is added to the wavetable. Updates frame display accordingly.
 
void componentRemoved (WavetableComponent *component) override
 Called when a component is removed from the wavetable. Ensures selected frames are updated accordingly.
 
void componentsReordered () override
 Called when components are reordered. Refreshes visuals.
 
void componentsChanged () override
 Called when components change (e.g. frames added/removed). Refreshes the displayed frames.
 
void componentsScrolled (int offset) override
 Called when components are scrolled via the WavetableComponentList. Adjusts vertical offset of rows.
 
void addListener (Listener *listener)
 Adds a listener for organizer events.
 
void removeListener (Listener *listener)
 Removes a previously added listener.
 
int handleWidth () const
 Gets the width of the handle area for rows.
 
void deleteSelectedKeyframes ()
 Deletes all currently selected keyframes.
 
void createKeyframeAtMenu ()
 Shows a menu to create a keyframe at a specific position.
 
void selectDefaultFrame ()
 Selects a default frame (usually the first one) if available.
 
void clear ()
 Clears all visible frames and selection.
 
void init ()
 Initializes the organizer and sets up frames.
 
bool hasSelectedFrames () const
 Checks if there is at least one selected frame.
 
- Public Member Functions inherited from SynthSection
 SynthSection (const String &name)
 Constructs a SynthSection with a given name.
 
virtual ~SynthSection ()=default
 
void setParent (const SynthSection *parent)
 Sets the parent SynthSection.
 
float findValue (Skin::ValueId value_id) const
 Finds a value in the skin overrides or from the parent if not found locally.
 
virtual void reset ()
 Resets the section and all sub-sections.
 
virtual void paint (Graphics &g) override
 Called when the component should paint itself.
 
virtual void paintSidewaysHeadingText (Graphics &g)
 Paints the section name heading text vertically if sideways_heading_ is true.
 
virtual void paintHeadingText (Graphics &g)
 Paints the heading text for this section, either sideways or horizontally.
 
virtual void setSkinValues (const Skin &skin, bool top_level)
 Sets skin values (colors, sizes) and applies them to sub-sections.
 
void setSkinOverride (Skin::SectionOverride skin_override)
 
virtual void repaintBackground ()
 Requests a repaint of the background.
 
void showPopupBrowser (SynthSection *owner, Rectangle< int > bounds, std::vector< File > directories, String extensions, std::string passthrough_name, std::string additional_folders_name)
 Shows a file browser popup (e.g., for loading samples or wavetables).
 
void updatePopupBrowser (SynthSection *owner)
 Updates the currently visible popup browser if any.
 
void showPopupSelector (Component *source, Point< int > position, const PopupItems &options, std::function< void(int)> callback, std::function< void()> cancel={ })
 Shows a popup selector with options.
 
void showDualPopupSelector (Component *source, Point< int > position, int width, const PopupItems &options, std::function< void(int)> callback)
 Shows a dual popup selector for hierarchical selection.
 
void showPopupDisplay (Component *source, const std::string &text, BubbleComponent::BubblePlacement placement, bool primary)
 Shows a brief popup display (like a tooltip).
 
void hidePopupDisplay (bool primary)
 Hides the currently shown popup display.
 
virtual void loadFile (const File &file)
 Loads a file (e.g., a sample or wavetable). Overridden by subclasses.
 
virtual File getCurrentFile ()
 Gets the currently loaded file. Overridden by subclasses.
 
virtual std::string getFileName ()
 Gets the name of the currently loaded file. Overridden by subclasses.
 
virtual std::string getFileAuthor ()
 Gets the author metadata of the currently loaded file. Overridden by subclasses.
 
virtual void paintContainer (Graphics &g)
 Paints the container background, body, heading, etc.
 
virtual void paintBody (Graphics &g, Rectangle< int > bounds)
 Paints the body background within given bounds.
 
virtual void paintBorder (Graphics &g, Rectangle< int > bounds)
 Paints the border around given bounds.
 
virtual void paintBody (Graphics &g)
 Paints the section body background using the entire component area.
 
virtual void paintBorder (Graphics &g)
 Paints the border around the entire component.
 
int getComponentShadowWidth ()
 Gets the width of shadow around components.
 
virtual void paintTabShadow (Graphics &g)
 Paints a tab-like shadow effect around the component.
 
void paintTabShadow (Graphics &g, Rectangle< int > bounds)
 Paints a tab shadow effect within specified bounds.
 
virtual void paintBackgroundShadow (Graphics &g)
 Stub for painting background shadows. Overridden by subclasses if needed.
 
virtual void setSizeRatio (float ratio)
 Sets the size ratio for scaling UI elements.
 
void paintKnobShadows (Graphics &g)
 Paints knob shadows for all sliders.
 
Font getLabelFont ()
 Gets a suitable font for label text.
 
void setLabelFont (Graphics &g)
 Sets the Graphics context font and color for labels.
 
void drawLabelConnectionForComponents (Graphics &g, Component *left, Component *right)
 Draws a rectangular connection between labels of two components.
 
void drawLabelBackground (Graphics &g, Rectangle< int > bounds, bool text_component=false)
 Draws a background for a label area.
 
void drawLabelBackgroundForComponent (Graphics &g, Component *component)
 Draws label background for a specific component.
 
Rectangle< int > getDividedAreaBuffered (Rectangle< int > full_area, int num_sections, int section, int buffer)
 Divides an area into equal sections with buffering, returns the specified section.
 
Rectangle< int > getDividedAreaUnbuffered (Rectangle< int > full_area, int num_sections, int section, int buffer)
 Divides an area into equal sections without extra buffering, returns the specified section.
 
Rectangle< int > getLabelBackgroundBounds (Rectangle< int > bounds, bool text_component=false)
 Gets the background bounds for a label.
 
Rectangle< int > getLabelBackgroundBounds (Component *component, bool text_component=false)
 Gets the label background bounds for a component.
 
void drawLabel (Graphics &g, String text, Rectangle< int > component_bounds, bool text_component=false)
 Draws a label text below a component.
 
void drawLabelForComponent (Graphics &g, String text, Component *component, bool text_component=false)
 Draws a label for a given component.
 
void drawTextBelowComponent (Graphics &g, String text, Component *component, int space, int padding=0)
 Draws text below a component with optional padding.
 
virtual void paintChildrenShadows (Graphics &g)
 Paints shadows for child sections.
 
void paintChildrenBackgrounds (Graphics &g)
 Paints the backgrounds for all child sections.
 
void paintOpenGlChildrenBackgrounds (Graphics &g)
 Paints the backgrounds for all OpenGL child components.
 
void paintChildBackground (Graphics &g, SynthSection *child)
 Paints a child's background specifically.
 
void paintChildShadow (Graphics &g, SynthSection *child)
 Paints a child's shadow specifically.
 
void paintOpenGlBackground (Graphics &g, OpenGlComponent *child)
 Paints the background of an OpenGlComponent child.
 
void drawTextComponentBackground (Graphics &g, Rectangle< int > bounds, bool extend_to_label)
 Draws a background for a text component area.
 
void drawTempoDivider (Graphics &g, Component *sync)
 Draws a divider line for tempo-related controls.
 
virtual void initOpenGlComponents (OpenGlWrapper &open_gl)
 Initializes all OpenGL components in this section and sub-sections.
 
virtual void renderOpenGlComponents (OpenGlWrapper &open_gl, bool animate)
 Renders all OpenGL components in this section and sub-sections.
 
virtual void destroyOpenGlComponents (OpenGlWrapper &open_gl)
 Destroys all OpenGL components in this section and sub-sections.
 
virtual void sliderValueChanged (Slider *moved_slider) override
 Called when a slider value changes. Updates the synth parameter accordingly.
 
virtual void buttonClicked (Button *clicked_button) override
 Called when a button is clicked. Updates the synth parameter accordingly.
 
virtual void guiChanged (SynthButton *button) override
 Called when a SynthButton state changes (GUI interaction).
 
std::map< std::string, SynthSlider * > getAllSliders ()
 Gets all sliders registered in this section.
 
std::map< std::string, ToggleButton * > getAllButtons ()
 Gets all toggle buttons registered in this section.
 
std::map< std::string, ModulationButton * > getAllModulationButtons ()
 Gets all modulation buttons registered in this section.
 
virtual void setActive (bool active)
 Sets the active state of this section and sub-sections.
 
bool isActive () const
 Checks if the section is currently active.
 
virtual void animate (bool animate)
 Triggers animation state change in sub-sections if needed.
 
virtual void setAllValues (vital::control_map &controls)
 Sets values for all known parameters from a control map.
 
virtual void setValue (const std::string &name, vital::mono_float value, NotificationType notification)
 Sets a single parameter value for a known control.
 
void addModulationButton (ModulationButton *button, bool show=true)
 Adds a modulation button to this section.
 
void addSubSection (SynthSection *section, bool show=true)
 Adds a subsection (another SynthSection) as a child.
 
void removeSubSection (SynthSection *section)
 Removes a previously added subsection.
 
virtual void setScrollWheelEnabled (bool enabled)
 Enables or disables scroll wheel support for this section and sub-sections.
 
ToggleButton * activator () const
 Gets the activator toggle button if any.
 
void setSkinValues (std::map< Skin::ValueId, float > values)
 Sets custom skin values for this section.
 
void setSkinValue (Skin::ValueId id, float value)
 Sets a single skin value override.
 
float getTitleWidth ()
 
float getPadding ()
 
float getPowerButtonOffset () const
 
float getKnobSectionHeight ()
 
float getSliderWidth ()
 
float getSliderOverlap ()
 
float getSliderOverlapWithSpace ()
 
float getTextComponentHeight ()
 
float getStandardKnobSize ()
 
float getTotalKnobHeight ()
 
float getTextSectionYOffset ()
 
float getModButtonWidth ()
 
float getModFontSize ()
 
float getWidgetMargin ()
 
float getWidgetRounding ()
 
float getSizeRatio () const
 
int getPopupWidth () const
 
int getDualPopupWidth () const
 
- Public Member Functions inherited from SynthButton::ButtonListener
virtual ~ButtonListener ()
 Virtual destructor.
 
- Public Member Functions inherited from WavetablePlayhead::Listener
virtual ~Listener ()
 
- Public Member Functions inherited from WavetableComponentList::Listener
virtual ~Listener ()
 

Static Public Attributes

static constexpr float kHandleHeightPercent = 1.0f / 8.0f
 Fraction of the total height used for the handle area.
 
static constexpr int kDrawSkip = 4
 
static constexpr int kDrawSkipLarge = 32
 
static constexpr int kMaxKeyframes = 2048
 
- Static Public Attributes inherited from SynthSection
static constexpr int kDefaultPowerButtonOffset = 0
 
static constexpr float kPowerButtonPaddingPercent = 0.29f
 
static constexpr float kTransposeHeightPercent = 0.5f
 
static constexpr float kTuneHeightPercent = 0.4f
 
static constexpr float kJointModulationRadiusPercent = 0.1f
 
static constexpr float kJointModulationExtensionPercent = 0.6666f
 
static constexpr float kPitchLabelPercent = 0.33f
 
static constexpr float kJointLabelHeightPercent = 0.4f
 
static constexpr double kTransposeMouseSensitivity = 0.2
 
static constexpr float kJointLabelBorderRatioX = 0.05f
 
static constexpr int kDefaultBodyRounding = 4
 
static constexpr int kDefaultLabelHeight = 10
 
static constexpr int kDefaultLabelBackgroundHeight = 16
 
static constexpr int kDefaultLabelBackgroundWidth = 56
 
static constexpr int kDefaultLabelBackgroundRounding = 4
 
static constexpr int kDefaultPadding = 2
 
static constexpr int kDefaultPopupMenuWidth = 150
 
static constexpr int kDefaultDualPopupMenuWidth = 340
 
static constexpr int kDefaultStandardKnobSize = 32
 
static constexpr int kDefaultKnobThickness = 2
 
static constexpr float kDefaultKnobModulationAmountThickness = 2.0f
 
static constexpr int kDefaultKnobModulationMeterSize = 43
 
static constexpr int kDefaultKnobModulationMeterThickness = 4
 
static constexpr int kDefaultModulationButtonWidth = 64
 
static constexpr int kDefaultModFontSize = 10
 
static constexpr int kDefaultKnobSectionHeight = 64
 
static constexpr int kDefaultSliderWidth = 24
 
static constexpr int kDefaultTextWidth = 80
 
static constexpr int kDefaultTextHeight = 24
 
static constexpr int kDefaultWidgetMargin = 6
 
static constexpr float kDefaultWidgetFillFade = 0.3f
 
static constexpr float kDefaultWidgetLineWidth = 4.0f
 
static constexpr float kDefaultWidgetFillCenter = 0.0f
 

Additional Inherited Members

- Protected Member Functions inherited from SynthSection
void setSliderHasHzAlternateDisplay (SynthSlider *slider)
 
void setSidewaysHeading (bool sideways)
 
void addToggleButton (ToggleButton *button, bool show)
 
void addButton (OpenGlToggleButton *button, bool show=true)
 
void addButton (OpenGlShapeButton *button, bool show=true)
 
void addSlider (SynthSlider *slider, bool show=true, bool listen=true)
 
void addOpenGlComponent (OpenGlComponent *open_gl_component, bool to_beginning=false)
 
void setActivator (SynthButton *activator)
 
void createOffOverlay ()
 
void setPresetSelector (PresetSelector *preset_selector, bool half=false)
 
void paintJointControlSliderBackground (Graphics &g, int x, int y, int width, int height)
 
void paintJointControlBackground (Graphics &g, int x, int y, int width, int height)
 
void paintJointControl (Graphics &g, int x, int y, int width, int height, const std::string &name)
 
void placeJointControls (int x, int y, int width, int height, SynthSlider *left, SynthSlider *right, Component *widget=nullptr)
 
void placeTempoControls (int x, int y, int width, int height, SynthSlider *tempo, SynthSlider *sync)
 
void placeRotaryOption (Component *option, SynthSlider *rotary)
 
void placeKnobsInArea (Rectangle< int > area, std::vector< Component * > knobs)
 
void lockCriticalSection ()
 
void unlockCriticalSection ()
 
Rectangle< int > getPresetBrowserBounds ()
 
int getTitleTextRight ()
 
Rectangle< int > getPowerButtonBounds ()
 
Rectangle< int > getTitleBounds ()
 
float getDisplayScale () const
 
virtual int getPixelMultiple () const
 
- Protected Attributes inherited from SynthSection
std::map< Skin::ValueId, float > value_lookup_
 
std::vector< SynthSection * > sub_sections_
 
std::vector< OpenGlComponent * > open_gl_components_
 
std::map< std::string, SynthSlider * > slider_lookup_
 
std::map< std::string, Button * > button_lookup_
 
std::map< std::string, ModulationButton * > modulation_buttons_
 
std::map< std::string, SynthSlider * > all_sliders_
 
std::map< std::string, ToggleButton * > all_buttons_
 
std::map< std::string, ModulationButton * > all_modulation_buttons_
 
const SynthSectionparent_
 
SynthButtonactivator_
 
PresetSelectorpreset_selector_
 
bool preset_selector_half_width_
 
std::unique_ptr< OffOverlayoff_overlay_
 
Skin::SectionOverride skin_override_
 
float size_ratio_
 
bool active_
 
bool sideways_heading_
 

Detailed Description

Manages the display and interaction of wavetable keyframes and groups on a timeline.

WavetableOrganizer provides a scrollable, interactive timeline of wavetable groups and their components' keyframes. Users can create, remove, select, and drag keyframes to rearrange positions. The organizer integrates with a WavetableCreator and updates keyframe positions within components.

It also notifies attached listeners about changes in selected frames and frame positions.

Member Enumeration Documentation

◆ MouseMode

The current mouse interaction mode used by the organizer.

Enumerator
kWaiting 
kSelecting 
kDragging 
kRightClick 
kNumMouseModes 

◆ OrganizerMenu

Menu actions available in the organizer context menus.

Enumerator
kCancel 
kCreate 
kRemove 

Constructor & Destructor Documentation

◆ WavetableOrganizer()

WavetableOrganizer::WavetableOrganizer ( WavetableCreator * wavetable_creator,
int max_frames )

Constructs a WavetableOrganizer.

Parameters
wavetable_creatorThe WavetableCreator that this organizer interacts with.
max_framesThe maximum number of frames that can be displayed on the timeline.

◆ ~WavetableOrganizer()

WavetableOrganizer::~WavetableOrganizer ( )
virtual

Member Function Documentation

◆ addListener()

void WavetableOrganizer::addListener ( Listener * listener)
inline

Adds a listener for organizer events.

Parameters
listenerThe listener to add.

◆ clear()

void WavetableOrganizer::clear ( )
inline

Clears all visible frames and selection.

◆ componentAdded()

void WavetableOrganizer::componentAdded ( WavetableComponent * component)
overridevirtual

Called when a component is added to the wavetable. Updates frame display accordingly.

Implements WavetableComponentList::Listener.

◆ componentRemoved()

void WavetableOrganizer::componentRemoved ( WavetableComponent * component)
overridevirtual

Called when a component is removed from the wavetable. Ensures selected frames are updated accordingly.

Implements WavetableComponentList::Listener.

◆ componentsChanged()

void WavetableOrganizer::componentsChanged ( )
inlineoverridevirtual

Called when components change (e.g. frames added/removed). Refreshes the displayed frames.

Implements WavetableComponentList::Listener.

◆ componentsReordered()

void WavetableOrganizer::componentsReordered ( )
inlineoverridevirtual

Called when components are reordered. Refreshes visuals.

Implements WavetableComponentList::Listener.

◆ componentsScrolled()

void WavetableOrganizer::componentsScrolled ( int offset)
overridevirtual

Called when components are scrolled via the WavetableComponentList. Adjusts vertical offset of rows.

Parameters
offsetThe vertical offset after scrolling.

Reimplemented from WavetableComponentList::Listener.

◆ createKeyframeAtMenu()

void WavetableOrganizer::createKeyframeAtMenu ( )

Shows a menu to create a keyframe at a specific position.

◆ deleteSelectedKeyframes()

void WavetableOrganizer::deleteSelectedKeyframes ( )

Deletes all currently selected keyframes.

◆ handleWidth()

int WavetableOrganizer::handleWidth ( ) const

Gets the width of the handle area for rows.

Returns
The width in pixels of the handle area.

◆ hasSelectedFrames()

bool WavetableOrganizer::hasSelectedFrames ( ) const
inline

Checks if there is at least one selected frame.

Returns
True if one or more frames are selected.

◆ init()

void WavetableOrganizer::init ( )
inline

Initializes the organizer and sets up frames.

◆ mouseDoubleClick()

void WavetableOrganizer::mouseDoubleClick ( const MouseEvent & event)
override

Called on a double-click. Used for quickly adding or removing keyframes.

◆ mouseDown()

void WavetableOrganizer::mouseDown ( const MouseEvent & event)
override

Called when the mouse button is pressed. Used for selecting frames, starting drags, or displaying a menu.

◆ mouseDrag()

void WavetableOrganizer::mouseDrag ( const MouseEvent & event)
override

Called as the mouse is dragged. Used for dragging frames or adjusting selection rectangles.

◆ mouseUp()

void WavetableOrganizer::mouseUp ( const MouseEvent & event)
override

Called when the mouse button is released. Finalizes drags, completes selections, or handles context menu actions.

◆ mouseWheelMove()

void WavetableOrganizer::mouseWheelMove ( const MouseEvent & e,
const MouseWheelDetails & wheel )
inlineoverride

Called when the mouse wheel is moved. Passes wheel movements to listeners for additional behaviors (like scrolling).

◆ paintBackground()

void WavetableOrganizer::paintBackground ( Graphics & g)
overridevirtual

Paints the background, including a grid and handle areas.

Reimplemented from SynthSection.

◆ playheadMoved()

void WavetableOrganizer::playheadMoved ( int position)
overridevirtual

Called when the playhead moves, updates the visual playhead position.

Parameters
positionThe new playhead position.

Implements WavetablePlayhead::Listener.

◆ removeListener()

void WavetableOrganizer::removeListener ( Listener * listener)
inline

Removes a previously added listener.

Parameters
listenerThe listener to remove.

◆ resized()

void WavetableOrganizer::resized ( )
overridevirtual

Handles resizing and rearranges the displayed frames and rows.

Reimplemented from SynthSection.

◆ selectDefaultFrame()

void WavetableOrganizer::selectDefaultFrame ( )

Selects a default frame (usually the first one) if available.

Member Data Documentation

◆ kDrawSkip

int WavetableOrganizer::kDrawSkip = 4
staticconstexpr

◆ kDrawSkipLarge

int WavetableOrganizer::kDrawSkipLarge = 32
staticconstexpr

◆ kHandleHeightPercent

float WavetableOrganizer::kHandleHeightPercent = 1.0f / 8.0f
staticconstexpr

Fraction of the total height used for the handle area.

◆ kMaxKeyframes

int WavetableOrganizer::kMaxKeyframes = 2048
staticconstexpr

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