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

A UI section that allows the user to select, load, save, and browse presets, and manage associated resources. More...

#include <synth_preset_selector.h>

Inheritance diagram for SynthPresetSelector:
SynthSection PresetBrowser::Listener BankExporter::Listener PresetSelector::Listener SynthButton::ButtonListener

Classes

class  Listener
 Interface for components that need to respond to preset selector events. More...
 

Public Types

enum  MenuItems {
  kCancelled , kInitPreset , kSavePreset , kImportPreset ,
  kExportPreset , kImportBank , kExportBank , kBrowsePresets ,
  kLoadTuning , kClearTuning , kOpenSkinDesigner , kLoadSkin ,
  kClearSkin , kLogOut , kLogIn , kNumMenuItems
}
 Menu item IDs for popup menus. More...
 

Public Member Functions

 SynthPresetSelector ()
 Constructor.
 
 ~SynthPresetSelector ()
 Destructor.
 
void resized () override
 Resizes and lays out UI components.
 
void paintBackground (Graphics &g) override
 
void buttonClicked (Button *buttonThatWasClicked) override
 
void newPresetSelected (File preset) override
 
void deleteRequested (File preset) override
 
void hidePresetBrowser () override
 Called when the PresetBrowser is requested to be hidden.
 
void hideBankExporter () override
 Called when the BankExporter is requested to be hidden.
 
void resetText ()
 Resets the text displayed in the PresetSelector to reflect current state.
 
void prevClicked () override
 Called when the previous preset button is clicked in the PresetSelector.
 
void nextClicked () override
 Called when the next preset button is clicked in the PresetSelector.
 
void textMouseUp (const MouseEvent &e) override
 
void showPopupMenu (Component *anchor)
 
void showAlternatePopupMenu (Component *anchor)
 
void setModified (bool modified)
 
void setSaveSection (SaveSection *save_section)
 
void setBrowser (PresetBrowser *browser)
 
void setBankExporter (BankExporter *bank_exporter)
 
void setPresetBrowserVisibile (bool visible)
 
void makeBankExporterVisibile ()
 Makes the bank exporter visible.
 
void initPreset ()
 Initializes the current preset to a default state.
 
void savePreset ()
 Saves the current preset.
 
void importPreset ()
 Imports a preset from an external file.
 
void exportPreset ()
 Exports the current preset to a file.
 
void importBank ()
 Imports a bank from an external file.
 
void exportBank ()
 Exports the current bank.
 
void loadTuningFile ()
 Loads a tuning file and applies it to the synthesizer.
 
void clearTuning ()
 Clears the currently loaded tuning, reverting to default.
 
std::string getTuningName ()
 
bool hasDefaultTuning ()
 
std::string loggedInName ()
 
void signOut ()
 Signs out the currently logged-in user.
 
void signIn ()
 Opens the sign-in dialog for the user.
 
void openSkinDesigner ()
 Opens the skin designer tool.
 
void loadSkin ()
 Loads a skin from a file.
 
void clearSkin ()
 Clears the current skin and reverts to the default.
 
void repaintWithSkin ()
 Repaints the interface with the current skin settings.
 
void browsePresets ()
 Shows the preset browser UI.
 
void addListener (Listener *listener)
 
- 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 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 PresetBrowser::Listener
virtual ~Listener ()
 
- Public Member Functions inherited from BankExporter::Listener
virtual ~Listener ()=default
 
- Public Member Functions inherited from PresetSelector::Listener
virtual ~Listener ()
 Virtual destructor for proper cleanup.
 
virtual void textMouseDown (const MouseEvent &e)
 

Additional Inherited Members

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

A UI section that allows the user to select, load, save, and browse presets, and manage associated resources.

The SynthPresetSelector integrates a PresetSelector with additional UI controls for:

  • Initializing presets
  • Saving and exporting presets
  • Importing/Exporting banks
  • Browsing presets through a PresetBrowser
  • Managing tunings and skins

Member Enumeration Documentation

◆ MenuItems

Menu item IDs for popup menus.

Enumerator
kCancelled 
kInitPreset 
kSavePreset 
kImportPreset 
kExportPreset 
kImportBank 
kExportBank 
kBrowsePresets 
kLoadTuning 
kClearTuning 
kOpenSkinDesigner 
kLoadSkin 
kClearSkin 
kLogOut 
kLogIn 
kNumMenuItems 

Constructor & Destructor Documentation

◆ SynthPresetSelector()

SynthPresetSelector::SynthPresetSelector ( )

Constructor.

◆ ~SynthPresetSelector()

SynthPresetSelector::~SynthPresetSelector ( )

Destructor.

Member Function Documentation

◆ addListener()

void SynthPresetSelector::addListener ( Listener * listener)
inline

Adds a listener for events from this preset selector.

Parameters
listenerThe listener to add.

◆ browsePresets()

void SynthPresetSelector::browsePresets ( )

Shows the preset browser UI.

◆ buttonClicked()

void SynthPresetSelector::buttonClicked ( Button * buttonThatWasClicked)
overridevirtual

Called when a button in this section is clicked.

Parameters
buttonThatWasClickedThe button that triggered the event.

Reimplemented from SynthSection.

◆ clearSkin()

void SynthPresetSelector::clearSkin ( )

Clears the current skin and reverts to the default.

◆ clearTuning()

void SynthPresetSelector::clearTuning ( )

Clears the currently loaded tuning, reverting to default.

◆ deleteRequested()

void SynthPresetSelector::deleteRequested ( File preset)
overridevirtual

Called when the delete action is requested on a preset in the PresetBrowser.

Parameters
presetThe preset file to delete.

Implements PresetBrowser::Listener.

◆ exportBank()

void SynthPresetSelector::exportBank ( )

Exports the current bank.

◆ exportPreset()

void SynthPresetSelector::exportPreset ( )

Exports the current preset to a file.

◆ getTuningName()

std::string SynthPresetSelector::getTuningName ( )

Retrieves the current tuning name.

Returns
A string containing the tuning name.

◆ hasDefaultTuning()

bool SynthPresetSelector::hasDefaultTuning ( )

Checks if the current tuning is the default tuning.

Returns
True if default, false otherwise.

◆ hideBankExporter()

void SynthPresetSelector::hideBankExporter ( )
overridevirtual

Called when the BankExporter is requested to be hidden.

Implements BankExporter::Listener.

◆ hidePresetBrowser()

void SynthPresetSelector::hidePresetBrowser ( )
overridevirtual

Called when the PresetBrowser is requested to be hidden.

Implements PresetBrowser::Listener.

◆ importBank()

void SynthPresetSelector::importBank ( )

Imports a bank from an external file.

◆ importPreset()

void SynthPresetSelector::importPreset ( )

Imports a preset from an external file.

◆ initPreset()

void SynthPresetSelector::initPreset ( )

Initializes the current preset to a default state.

◆ loadSkin()

void SynthPresetSelector::loadSkin ( )

Loads a skin from a file.

◆ loadTuningFile()

void SynthPresetSelector::loadTuningFile ( )

Loads a tuning file and applies it to the synthesizer.

◆ loggedInName()

std::string SynthPresetSelector::loggedInName ( )

Gets the name of the logged-in user.

Returns
The logged-in user's name or an empty string if not logged in.

◆ makeBankExporterVisibile()

void SynthPresetSelector::makeBankExporterVisibile ( )

Makes the bank exporter visible.

◆ newPresetSelected()

void SynthPresetSelector::newPresetSelected ( File preset)
overridevirtual

Called when a new preset is selected in the PresetBrowser.

Parameters
presetThe selected preset file.

Implements PresetBrowser::Listener.

◆ nextClicked()

void SynthPresetSelector::nextClicked ( )
overridevirtual

Called when the next preset button is clicked in the PresetSelector.

Implements PresetSelector::Listener.

◆ openSkinDesigner()

void SynthPresetSelector::openSkinDesigner ( )

Opens the skin designer tool.

◆ paintBackground()

void SynthPresetSelector::paintBackground ( Graphics & g)
inlineoverridevirtual

Paints the background of the selector area (delegated to the PresetSelector).

Parameters
gThe graphics context to use.

Reimplemented from SynthSection.

◆ prevClicked()

void SynthPresetSelector::prevClicked ( )
overridevirtual

Called when the previous preset button is clicked in the PresetSelector.

Implements PresetSelector::Listener.

◆ repaintWithSkin()

void SynthPresetSelector::repaintWithSkin ( )

Repaints the interface with the current skin settings.

◆ resetText()

void SynthPresetSelector::resetText ( )

Resets the text displayed in the PresetSelector to reflect current state.

◆ resized()

void SynthPresetSelector::resized ( )
overridevirtual

Resizes and lays out UI components.

Reimplemented from SynthSection.

◆ savePreset()

void SynthPresetSelector::savePreset ( )

Saves the current preset.

◆ setBankExporter()

void SynthPresetSelector::setBankExporter ( BankExporter * bank_exporter)
inline

Sets the BankExporter to use.

Parameters
bank_exporterThe BankExporter instance.

◆ setBrowser()

void SynthPresetSelector::setBrowser ( PresetBrowser * browser)
inline

Sets the PresetBrowser to use.

Parameters
browserThe PresetBrowser instance.

◆ setModified()

void SynthPresetSelector::setModified ( bool modified)

Sets whether the current preset is considered modified.

Parameters
modifiedTrue if modified, false otherwise.

◆ setPresetBrowserVisibile()

void SynthPresetSelector::setPresetBrowserVisibile ( bool visible)

Shows or hides the preset browser.

Parameters
visibleTrue to show, false to hide.

◆ setSaveSection()

void SynthPresetSelector::setSaveSection ( SaveSection * save_section)
inline

Assigns a SaveSection to handle saving presets.

Parameters
save_sectionThe SaveSection to use.

◆ showAlternatePopupMenu()

void SynthPresetSelector::showAlternatePopupMenu ( Component * anchor)

Shows an alternate popup menu (used for advanced/hidden options).

Parameters
anchorThe component used as the position anchor for the popup.

◆ showPopupMenu()

void SynthPresetSelector::showPopupMenu ( Component * anchor)

Shows a popup menu for preset management.

Parameters
anchorThe component used as the position anchor for the popup.

◆ signIn()

void SynthPresetSelector::signIn ( )

Opens the sign-in dialog for the user.

◆ signOut()

void SynthPresetSelector::signOut ( )

Signs out the currently logged-in user.

◆ textMouseUp()

void SynthPresetSelector::textMouseUp ( const MouseEvent & e)
overridevirtual

Called when the text area in the PresetSelector receives a mouse-up event.

Parameters
eThe mouse event data.

Reimplemented from PresetSelector::Listener.


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