Audacity 3.2.0
Classes | Typedefs | Functions
EffectManager.h File Reference
#include "EffectInterface.h"
#include "Identifier.h"
#include <functional>
#include <memory>
#include <unordered_map>
#include <variant>
#include <vector>
Include dependency graph for EffectManager.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  EffectAndDefaultSettings
 
class  EffectManager
 EffectManager is the class that handles effects and effect categories. More...
 

Typedefs

typedef wxString PluginID
 
using EffectMap = std::unordered_map< wxString, EffectAndDefaultSettings >
 
using EffectOwnerMap = std::unordered_map< wxString, std::shared_ptr< EffectPlugin > >
 

Functions

EFFECTS_API RegistryPaths GetUserPresets (EffectPlugin &host)
 
EFFECTS_API bool HasCurrentSettings (EffectPlugin &host)
 
EFFECTS_API bool HasFactoryDefaults (EffectPlugin &host)
 

Typedef Documentation

◆ EffectMap

using EffectMap = std::unordered_map<wxString, EffectAndDefaultSettings>

Definition at line 39 of file EffectManager.h.

◆ EffectOwnerMap

using EffectOwnerMap = std::unordered_map< wxString, std::shared_ptr<EffectPlugin> >

Definition at line 40 of file EffectManager.h.

◆ PluginID

typedef wxString PluginID

Definition at line 28 of file EffectManager.h.

Function Documentation

◆ GetUserPresets()

EFFECTS_API RegistryPaths GetUserPresets ( EffectPlugin host)

Definition at line 112 of file EffectManager.cpp.

113{
114 RegistryPaths presets;
116 UserPresetsGroup({}), presets);
117 std::sort( presets.begin(), presets.end() );
118 return presets;
119}
RegistryPath UserPresetsGroup(const RegistryPath &name)
Compute part of a registry path, given a name which may be empty.
std::vector< RegistryPath > RegistryPaths
Definition: Identifier.h:219
virtual const EffectSettingsManager & GetDefinition() const =0
bool GetConfigSubgroups(const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group, RegistryPaths &subgroups)

References PluginSettings::GetConfigSubgroups(), EffectPlugin::GetDefinition(), PluginSettings::Private, and UserPresetsGroup().

Referenced by EffectPresetsDialog::EffectPresetsDialog(), and EffectManager::HasPresets().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HasCurrentSettings()

EFFECTS_API bool HasCurrentSettings ( EffectPlugin host)

Definition at line 100 of file EffectManager.cpp.

101{
104}
const RegistryPath & CurrentSettingsGroup()
Component of a configuration key path, for last-used destructive settings.
bool HasConfigGroup(const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group)

References CurrentSettingsGroup(), EffectPlugin::GetDefinition(), PluginSettings::HasConfigGroup(), and PluginSettings::Private.

Referenced by EffectPresetsDialog::EffectPresetsDialog(), EffectManager::GetDefaultPreset(), and EffectManager::HasPresets().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HasFactoryDefaults()

EFFECTS_API bool HasFactoryDefaults ( EffectPlugin host)

Definition at line 106 of file EffectManager.cpp.

107{
110}
const RegistryPath & FactoryDefaultsGroup()
Component of a configuration key path, for default state of MakeSettings()

References FactoryDefaultsGroup(), EffectPlugin::GetDefinition(), PluginSettings::HasConfigGroup(), and PluginSettings::Private.

Referenced by EffectPresetsDialog::EffectPresetsDialog(), EffectManager::GetDefaultPreset(), and EffectManager::HasPresets().

Here is the call graph for this function:
Here is the caller graph for this function: