Externalized state of a plug-in. More...

#include <EffectInterface.h>

Inheritance diagram for EffectSettings:

Collaboration diagram for EffectSettings:

Public Member Functions
void	swap (EffectSettings &other)

Public Member Functions inherited from audacity::TypedAny< EffectSettings >
	TypedAny (Args &&... args)
	Constructor with arguments just as for std::any, but it is explicit. More...

	TypedAny (const TypedAny &)=default

	TypedAny (TypedAny &&)=default

TypedAny &	operator= (const TypedAny &)=default

TypedAny &	operator= (TypedAny &&)=default

std::decay_t< ValueType > &	emplace (Args &&... args)

void	reset () noexcept

void	swap (TypedAny &other) noexcept

bool	has_value () const noexcept

const std::type_info &	type () const noexcept

const T *	cast () const noexcept
	Like pointer-valued any_cast but a non-static member function. More...

T *	cast () noexcept
	Like pointer-valued any_cast but a non-static member function. More...

Static Public Member Functions
template<typename T , typename... Args>
static EffectSettings	Make (Args &&... args)
	Like make_any but a static member function. More...

template<typename T >
static bool	Copy (const EffectSettings &src, EffectSettings &dst)

Static Public Member Functions inherited from audacity::TypedAny< EffectSettings >
static TypedAny	make (Args &&... args)
	Like make_any but a static member function. More...

Public Attributes
EffectSettingsExtra	extra

Detailed Description

Externalized state of a plug-in.

Definition at line 97 of file EffectInterface.h.

Member Function Documentation

◆ Copy()

template<typename T >

static bool EffectSettings::Copy	(	const EffectSettings &	src,
		EffectSettings &	dst
	)

inlinestatic

Convenience for defining overrides of EffectDefinitionInterface::CopySettingsContents

Definition at line 117 of file EffectInterface.h.

   {
      const T *pSrc = src.cast<T>();
      T *pDst = dst.cast<T>();
      if (pSrc && pDst) {
         *pDst = *pSrc;
         return true;
      }
      return false;
   }

References audacity::TypedAny< Tag >::cast().

Here is the call graph for this function:

◆ Make()

template<typename T , typename... Args>

static EffectSettings EffectSettings::Make ( Args &&... args )

inlinestatic

Like make_any but a static member function.

Definition at line 109 of file EffectInterface.h.

   {
      return EffectSettings(std::in_place_type<T>, std::forward<Args>(args)...);
   }

◆ swap()

void EffectSettings::swap ( EffectSettings & other )

inline

Definition at line 101 of file EffectInterface.h.

   {
      TypedAny::swap(other);
      std::swap(extra, other.extra);
   }

References extra, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Member Data Documentation

◆ extra

EffectSettingsExtra EffectSettings::extra

Definition at line 99 of file EffectInterface.h.

Referenced by VSTEditor::BuildPlain(), EffectNoise::PopulateOrExchange(), EffectSilence::PopulateOrExchange(), EffectToneGen::PopulateOrExchange(), LadspaEditor::PopulateUI(), swap(), and VST3Editor::VST3Editor().

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

EffectInterface.h

Public Member Functions

Static Public Member Functions