EffectWithSettings< Settings, Base > Class Template Reference

#include <Effect.h>

Inheritance diagram for EffectWithSettings< Settings, Base >:

Collaboration diagram for EffectWithSettings< Settings, Base >:

Public Member Functions
EffectSettings	MakeSettings () const override
bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override

Static Public Member Functions
static Settings &	GetSettings (EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...
static const Settings &	GetSettings (const EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...
static Settings *	FetchParameters (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 154 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 160 of file Effect.h.

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

FetchParameters()

template<typename Settings , typename Base >

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

inlinestatic

Definition at line 178 of file Effect.h.

                                              {
      return &GetSettings(s);
   }

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

   {
      return GetSettings(const_cast<EffectSettings &>(settings));
   }

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

   {
      auto pSettings = settings.cast<Settings>();
      assert(pSettings);
      return *pSettings;
   }

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

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

Referenced by NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

---

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

• Effect.h