Audacity 3.2.0
Public Member Functions | Static Public Member Functions | List of all members
EffectWithSettings< Settings, Base > Class Template Reference

#include <Effect.h>

Inheritance diagram for EffectWithSettings< Settings, Base >:
[legend]
Collaboration diagram for EffectWithSettings< Settings, Base >:
[legend]

Public Member Functions

EffectSettings MakeSettings () const override
 
bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override
 

Static Public Member Functions

static SettingsGetSettings (EffectSettings &settings)
 Assume settings originated from MakeSettings() and copies thereof. More...
 
static const SettingsGetSettings (const EffectSettings &settings)
 Assume settings originated from MakeSettings() and copies thereof. More...
 
static SettingsFetchParameters (Base &, EffectSettings &s)
 

Detailed Description

template<typename Settings, typename Base>
class EffectWithSettings< Settings, Base >

Convenience for generating EffectDefinitionInterface overrides and static down-casting functions

Definition at line 314 of file Effect.h.

Member Function Documentation

◆ CopySettingsContents()

template<typename Settings , typename Base >
bool EffectWithSettings< Settings, Base >::CopySettingsContents ( const EffectSettings src,
EffectSettings dst 
) const
inlineoverride

Definition at line 320 of file Effect.h.

322 {
323 return EffectSettings::Copy<Settings>(src, dst);
324 }

◆ FetchParameters()

template<typename Settings , typename Base >
static Settings * EffectWithSettings< Settings, Base >::FetchParameters ( Base &  ,
EffectSettings s 
)
inlinestatic

Definition at line 338 of file Effect.h.

338 {
339 return &GetSettings(s);
340 }
static Settings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:326

References EffectWithSettings< Settings, Base >::GetSettings().

Here is the call graph for this function:

◆ GetSettings() [1/2]

template<typename Settings , typename Base >
static const Settings & EffectWithSettings< Settings, Base >::GetSettings ( const EffectSettings settings)
inlinestatic

Assume settings originated from MakeSettings() and copies thereof.

Definition at line 333 of file Effect.h.

334 {
335 return GetSettings(const_cast<EffectSettings &>(settings));
336 }
static Settings & settings()
Definition: TrackInfo.cpp:87
Externalized state of a plug-in.

References EffectWithSettings< Settings, Base >::GetSettings(), and settings().

Here is the call graph for this function:

◆ GetSettings() [2/2]

template<typename Settings , typename Base >
static Settings & EffectWithSettings< Settings, Base >::GetSettings ( EffectSettings settings)
inlinestatic

Assume settings originated from MakeSettings() and copies thereof.

Definition at line 326 of file Effect.h.

327 {
328 auto pSettings = settings.cast<Settings>();
329 assert(pSettings);
330 return *pSettings;
331 }

References settings().

Referenced by EffectWithSettings< Settings, Base >::FetchParameters(), and EffectWithSettings< Settings, Base >::GetSettings().

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

◆ MakeSettings()

template<typename Settings , typename Base >
EffectSettings EffectWithSettings< Settings, Base >::MakeSettings ( ) const
inlineoverride

Definition at line 316 of file Effect.h.

317 {
318 return EffectSettings::Make<Settings>();
319 }

Referenced by NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

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