Audacity 3.2.0
Public Member Functions | List of all members
EffectParameterMethods Class Referenceabstract

Interface for manipulations of an Effect's settings. More...

#include <ShuttleAutomation.h>

Inheritance diagram for EffectParameterMethods:
[legend]

Public Member Functions

virtual ~EffectParameterMethods ()
 
virtual void Reset (Effect &effect) const =0
 
virtual void Visit (Effect &effect, SettingsVisitor &visitor, EffectSettings &settings) const =0
 
virtual void Visit (const Effect &effect, ConstSettingsVisitor &visitor, const EffectSettings &settings) const =0
 
virtual void Get (const Effect &effect, const EffectSettings &settings, CommandParameters &parms) const =0
 
virtual bool Set (Effect &effect, const CommandParameters &parms, EffectSettings &settings) const =0
 

Detailed Description

Interface for manipulations of an Effect's settings.

It is meant to be stateless, so all member functions are const

Definition at line 23 of file ShuttleAutomation.h.

Constructor & Destructor Documentation

◆ ~EffectParameterMethods()

EffectParameterMethods::~EffectParameterMethods ( )
virtualdefault

Member Function Documentation

◆ Get()

virtual void EffectParameterMethods::Get ( const Effect effect,
const EffectSettings settings,
CommandParameters parms 
) const
pure virtual

Implemented in CapturedParameters< EffectType, Parameters >.

Referenced by Effect::SaveSettings().

Here is the caller graph for this function:

◆ Reset()

virtual void EffectParameterMethods::Reset ( Effect effect) const
pure virtual

Implemented in CapturedParameters< EffectType, Parameters >.

Referenced by EffectFindClipping::EffectFindClipping(), EffectLoudness::EffectLoudness(), and EffectNoise::EffectNoise().

Here is the caller graph for this function:

◆ Set()

virtual bool EffectParameterMethods::Set ( Effect effect,
const CommandParameters parms,
EffectSettings settings 
) const
pure virtual

Implemented in CapturedParameters< EffectType, Parameters >.

Referenced by Effect::LoadSettings().

Here is the caller graph for this function:

◆ Visit() [1/2]

virtual void EffectParameterMethods::Visit ( const Effect effect,
ConstSettingsVisitor visitor,
const EffectSettings settings 
) const
pure virtual

◆ Visit() [2/2]

virtual void EffectParameterMethods::Visit ( Effect effect,
SettingsVisitor visitor,
EffectSettings settings 
) const
pure virtual

Implemented in CapturedParameters< EffectType, Parameters >.

Referenced by Effect::VisitSettings().

Here is the caller graph for this function:

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