Jamba  3.0.2
Public Member Functions | Public Attributes | Protected Member Functions | Private Attributes | Friends | List of all members
pongasoft::VST::Parameters::VstParamDefBuilder< T > Struct Template Reference

#include <Parameters.h>

Public Member Functions

VstParam< T > add () const
 
VstParamDefBuilder & converter (std::shared_ptr< IParamConverter< T >> iConverter)
 
template<typename ParamConverter , typename... Args>
VstParamDefBuilder & converter (Args... iArgs)
 
VstParamDefBuilder & defaultValue (T const &iDefaultValue)
 
VstParamDefBuilder & flags (int32 iFlags)
 
VstParamDefBuilder & guiOwned ()
 
VstParamDefBuilder & precision (int32 iPrecision)
 
VstParamDefBuilder & rtOwned ()
 
VstParamDefBuilder & shortTitle (const TChar *iShortTitle)
 
VstParamDefBuilder & transient (bool iTransient=true)
 
VstParamDefBuilder & unitID (int32 iUnitID)
 
VstParamDefBuilder & units (const TChar *iUnits)
 

Public Attributes

std::shared_ptr< IParamConverter< T > > fConverter {}
 
T fDefaultValue {}
 
int32 fFlags = ParameterInfo::kCanAutomate
 
IParamDef::Owner fOwner = IParamDef::Owner::kRT
 
ParamID fParamID
 
int32 fPrecision = 4
 
const TChar * fShortTitle = nullptr
 
const TChar * fTitle
 
bool fTransient = false
 
UnitID fUnitID = kRootUnitId
 
const TChar * fUnits = nullptr
 

Protected Member Functions

 VstParamDefBuilder (Parameters *iParameters, ParamID iParamID, const TChar *iTitle)
 

Private Attributes

Parameters * fParameters
 

Friends

class Parameters
 

Detailed Description

template<typename T>
struct pongasoft::VST::Parameters::VstParamDefBuilder< T >

Implements the builder pattern for ease of build.

Template Parameters
Tthe underlying type of the param

Constructor & Destructor Documentation

◆ VstParamDefBuilder()

template<typename T>
pongasoft::VST::Parameters::VstParamDefBuilder< T >::VstParamDefBuilder ( Parameters *  iParameters,
ParamID  iParamID,
const TChar *  iTitle 
)
inlineprotected

Member Function Documentation

◆ add()

template<typename T >
VstParam< T > pongasoft::VST::Parameters::VstParamDefBuilder< T >::add ( ) const

◆ converter() [1/2]

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::converter ( std::shared_ptr< IParamConverter< T >>  iConverter)
inline

◆ converter() [2/2]

template<typename T>
template<typename ParamConverter , typename... Args>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::converter ( Args...  iArgs)
inline

◆ defaultValue()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::defaultValue ( T const &  iDefaultValue)
inline

◆ flags()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::flags ( int32  iFlags)
inline

◆ guiOwned()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::guiOwned ( )
inline

◆ precision()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::precision ( int32  iPrecision)
inline

◆ rtOwned()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::rtOwned ( )
inline

◆ shortTitle()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::shortTitle ( const TChar *  iShortTitle)
inline

◆ transient()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::transient ( bool  iTransient = true)
inline

◆ unitID()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::unitID ( int32  iUnitID)
inline

◆ units()

template<typename T>
VstParamDefBuilder& pongasoft::VST::Parameters::VstParamDefBuilder< T >::units ( const TChar *  iUnits)
inline

Friends And Related Function Documentation

◆ Parameters

template<typename T>
friend class Parameters
friend

Member Data Documentation

◆ fConverter

template<typename T>
std::shared_ptr<IParamConverter<T> > pongasoft::VST::Parameters::VstParamDefBuilder< T >::fConverter {}

◆ fDefaultValue

template<typename T>
T pongasoft::VST::Parameters::VstParamDefBuilder< T >::fDefaultValue {}

◆ fFlags

template<typename T>
int32 pongasoft::VST::Parameters::VstParamDefBuilder< T >::fFlags = ParameterInfo::kCanAutomate

◆ fOwner

template<typename T>
IParamDef::Owner pongasoft::VST::Parameters::VstParamDefBuilder< T >::fOwner = IParamDef::Owner::kRT

◆ fParameters

template<typename T>
Parameters* pongasoft::VST::Parameters::VstParamDefBuilder< T >::fParameters
private

◆ fParamID

template<typename T>
ParamID pongasoft::VST::Parameters::VstParamDefBuilder< T >::fParamID

◆ fPrecision

template<typename T>
int32 pongasoft::VST::Parameters::VstParamDefBuilder< T >::fPrecision = 4

◆ fShortTitle

template<typename T>
const TChar* pongasoft::VST::Parameters::VstParamDefBuilder< T >::fShortTitle = nullptr

◆ fTitle

template<typename T>
const TChar* pongasoft::VST::Parameters::VstParamDefBuilder< T >::fTitle

◆ fTransient

template<typename T>
bool pongasoft::VST::Parameters::VstParamDefBuilder< T >::fTransient = false

◆ fUnitID

template<typename T>
UnitID pongasoft::VST::Parameters::VstParamDefBuilder< T >::fUnitID = kRootUnitId

◆ fUnits

template<typename T>
const TChar* pongasoft::VST::Parameters::VstParamDefBuilder< T >::fUnits = nullptr
The documentation for this struct was generated from the following file: