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 403 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 409 of file Effect.h.

411 {
412 return EffectSettings::Copy<Settings>(src, dst);
413 }

◆ FetchParameters()

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

Definition at line 427 of file Effect.h.

427 {
428 return &GetSettings(s);
429 }
static Settings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:415

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 422 of file Effect.h.

423 {
424 return GetSettings(const_cast<EffectSettings &>(settings));
425 }
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 415 of file Effect.h.

416 {
417 auto pSettings = settings.cast<Settings>();
418 assert(pSettings);
419 return *pSettings;
420 }

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 405 of file Effect.h.

406 {
407 return EffectSettings::Make<Settings>();
408 }

Referenced by NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

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