Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
EffectSettingsExtra Class Referencefinal

Non-polymorphic package of settings values common to many effects. More...

#include <EffectInterface.h>

Collaboration diagram for EffectSettingsExtra:
[legend]

Public Member Functions

const NumericFormatSymbolGetDurationFormat () const
 
void SetDurationFormat (const NumericFormatSymbol &durationFormat)
 
double GetDuration () const
 
void SetDuration (double value)
 
bool GetActive () const
 
void SetActive (bool value)
 

Static Public Member Functions

static const RegistryPathDurationKey ()
 

Private Attributes

NumericFormatSymbol mDurationFormat {}
 
double mDuration {}
 
bool mActive { true }
 

Detailed Description

Non-polymorphic package of settings values common to many effects.

Definition at line 76 of file EffectInterface.h.

Member Function Documentation

◆ DurationKey()

const RegistryPath & EffectSettingsExtra::DurationKey ( )
static

Definition at line 12 of file EffectInterface.cpp.

13{
14 static wxString key("LastUsedDuration");
15 return key;
16}
static const AudacityProject::AttachedObjects::RegisteredFactory key

References key.

Referenced by EffectBase::DoEffect().

Here is the caller graph for this function:

◆ GetActive()

bool EffectSettingsExtra::GetActive ( ) const
inline

Definition at line 88 of file EffectInterface.h.

88{ return mActive; }

◆ GetDuration()

double EffectSettingsExtra::GetDuration ( ) const
inline
Returns
value is not negative

Definition at line 85 of file EffectInterface.h.

85{ return mDuration; }

Referenced by EffectTimeScale::Preview().

Here is the caller graph for this function:

◆ GetDurationFormat()

const NumericFormatSymbol & EffectSettingsExtra::GetDurationFormat ( ) const
inline

Definition at line 79 of file EffectInterface.h.

80 { return mDurationFormat; }
NumericFormatSymbol mDurationFormat

◆ SetActive()

void EffectSettingsExtra::SetActive ( bool  value)
inline

Definition at line 89 of file EffectInterface.h.

89{ mActive = value; }

◆ SetDuration()

void EffectSettingsExtra::SetDuration ( double  value)
inline

Definition at line 86 of file EffectInterface.h.

86{ mDuration = std::max(0.0, value); }

◆ SetDurationFormat()

void EffectSettingsExtra::SetDurationFormat ( const NumericFormatSymbol durationFormat)
inline

Definition at line 81 of file EffectInterface.h.

82 { mDurationFormat = durationFormat; }

Member Data Documentation

◆ mActive

bool EffectSettingsExtra::mActive { true }
private

Definition at line 93 of file EffectInterface.h.

◆ mDuration

double EffectSettingsExtra::mDuration {}
private
Invariant
non-negative

Definition at line 92 of file EffectInterface.h.

◆ mDurationFormat

NumericFormatSymbol EffectSettingsExtra::mDurationFormat {}
private

Definition at line 91 of file EffectInterface.h.


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