EffectSettingsExtra Class Reference

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

#include <EffectInterface.h>

Collaboration diagram for EffectSettingsExtra:

Public Member Functions
const NumericFormatID &	GetDurationFormat () const
void	SetDurationFormat (const NumericFormatID &durationFormat)
double	GetDuration () const
void	SetDuration (double value)
bool	GetActive () const
void	SetActive (bool value)

Static Public Member Functions
static const RegistryPath &	DurationKey ()

Private Attributes
NumericFormatID	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 11 of file EffectInterface.cpp.

{
   static wxString key("LastUsedDuration");
   return key;
}

References key.

Referenced by EffectBase::DoEffect(), and EffectUIHost::TransferDataFromWindow().

Here is the caller graph for this function:

GetActive()

bool EffectSettingsExtra::GetActive ( ) const

inline

Definition at line 88 of file EffectInterface.h.

{ return mActive; }

GetDuration()

double EffectSettingsExtra::GetDuration ( ) const

inline

Returns

value is not negative

Definition at line 85 of file EffectInterface.h.

{ return mDuration; }

GetDurationFormat()

const NumericFormatID & EffectSettingsExtra::GetDurationFormat ( ) const

inline

Definition at line 79 of file EffectInterface.h.

      { return mDurationFormat; }

SetActive()

void EffectSettingsExtra::SetActive ( bool  value )

inline

Definition at line 89 of file EffectInterface.h.

{ mActive = value; }

SetDuration()

void EffectSettingsExtra::SetDuration ( double  value )

inline

Definition at line 86 of file EffectInterface.h.

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

SetDurationFormat()

void EffectSettingsExtra::SetDurationFormat ( const NumericFormatID &  durationFormat )

inline

Definition at line 81 of file EffectInterface.h.

      { 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

NumericFormatID EffectSettingsExtra::mDurationFormat {}

private

Definition at line 91 of file EffectInterface.h.

---

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

• EffectInterface.h
• EffectInterface.cpp