GUIJmbParam< T > Class Template Reference

This is the main class that the plugin should use as it exposes only the necessary methods of the param as well as redefine a couple of operators which helps in writing simpler and natural code (the param behaves like T in many ways). More...

#include <GUIJmbParameter.h>

Inherits Dereferenceable< GUIJmbParam< T > >.

Public Types
using	Editor = std::unique_ptr< EditorType >
using	EditorType = typename GUIJmbParameter< T >::EditorType
using	ParamType = T

Public Member Functions
tresult	broadcast () const
void	broadcast (T const &iValue)
void	broadcast (T &&iValue)
std::unique_ptr< FObjectCx >	connect (Parameters::IChangeListener *iChangeListener)
std::unique_ptr< FObjectCx >	connect (Parameters::ChangeCallback iChangeCallback)
Editor	edit ()
Editor	edit (T const &iValue)
bool	exists () const
ParamID	getParamID () const
T const &	getValue () const
	GUIJmbParam (std::shared_ptr< GUIJmbParameter< T >> iPtr=nullptr)
constexpr T const &	operator * () const
	allow writing *param to access the underlying value (or in other words, *param is the same param.value()) More...
	operator T const & () const
constexpr T const *	operator-> () const
GUIJmbParam< T > &	operator= (GUIJmbParam< T > const &iOther)=default
	Assignment operator: fMyParam = registerParam(...); More...
GUIJmbParam< T > &	operator= (T const &iValue)
	Allow to write param = 3.0. More...
tresult	resetToDefault ()
	Resets the param to its default value. More...
void	setValue (T const &iNewValue)
	The difference with update is that it does not check for equality (case when T is not comparable) More...
void	setValue (T &&iNewValue)
	The difference with update is that it does not check for equality (case when T is not comparable) More...
std::string	toUTF8String (int32 iPrecision) const
	Returns the current value of the parameter as a string (which is properly UTF-8 encoded). More...
bool	update (T const &iNewValue)
	This method is typically called by a view to change the value of the parameter. More...
template<class ValueModifier >
bool	updateIf (ValueModifier const &iValueModifier)
	Use this flavor of update if you want to modify the value itself. More...
T const &	value () const
	Synonym to getValue() More...

Private Attributes
std::shared_ptr< GUIJmbParameter< T > >	fPtr

Detailed Description

template<typename T>
class pongasoft::VST::GUI::Params::GUIJmbParam< T >

This is the main class that the plugin should use as it exposes only the necessary methods of the param as well as redefine a couple of operators which helps in writing simpler and natural code (the param behaves like T in many ways).

Template Parameters

T	the underlying type of the param

Member Typedef Documentation

Editor

using Editor = std::unique_ptr<EditorType>

EditorType

using EditorType = typename GUIJmbParameter<T>::EditorType

ParamType

using ParamType = T

Constructor & Destructor Documentation

GUIJmbParam()

GUIJmbParam ( std::shared_ptr< GUIJmbParameter< T >>  iPtr = nullptr )

inline

Member Function Documentation

broadcast() [1/3]

tresult broadcast ( ) const

inline

broadcast() [2/3]

void broadcast ( T const &  iValue )

inline

broadcast() [3/3]

void broadcast ( T &&  iValue )

inline

connect() [1/2]

std::unique_ptr<FObjectCx> connect ( Parameters::IChangeListener *  iChangeListener )

inline

connect() [2/2]

std::unique_ptr<FObjectCx> connect ( Parameters::ChangeCallback  iChangeCallback )

inline

edit() [1/2]

Editor edit ( )

inline

Returns

the editor to change the parameter (commit/rollback)

edit() [2/2]

Editor edit ( T const &  iValue )

inline

Parameters

iValue

first value to set

Returns

the editor to change the parameter (commit/rollback)

exists()

bool exists ( ) const

inline

getParamID()

ParamID getParamID ( ) const

inline

getValue()

T const& getValue ( ) const

inline

operator *()

constexpr T const& operator * ( ) const

inline

allow writing *param to access the underlying value (or in other words, *param is the same param.value())

operator T const &()

operator T const & ( ) const

inline

operator->()

constexpr T const* operator-> ( ) const

inline

operator=() [1/2]

GUIJmbParam<T>& operator= ( GUIJmbParam< T > const &  iOther )

default

Assignment operator: fMyParam = registerParam(...);

operator=() [2/2]

GUIJmbParam<T>& operator= ( T const &  iValue )

inline

Allow to write param = 3.0.

resetToDefault()

tresult resetToDefault ( )

inline

Resets the param to its default value.

setValue() [1/2]

void setValue ( T const &  iNewValue )

inline

The difference with update is that it does not check for equality (case when T is not comparable)

setValue() [2/2]

void setValue ( T &&  iNewValue )

inline

The difference with update is that it does not check for equality (case when T is not comparable)

toUTF8String()

std::string toUTF8String ( int32  iPrecision ) const

inline

Returns the current value of the parameter as a string (which is properly UTF-8 encoded).

Parameters

iPrecision

if iPrecision < 0 the parameter is free to use whichever precision is tied to the parameter otherwise it should use the one provided

update()

bool update ( T const &  iNewValue )

inline

This method is typically called by a view to change the value of the parameter.

Listeners will be notified of the changes.

updateIf()

bool updateIf ( ValueModifier const &  iValueModifier )

inline

Use this flavor of update if you want to modify the value itself.

ValueModifier will be called back with &fValue. The callback should return true when the value was updated, false otherwise

value()

T const& value ( ) const

inline

Synonym to getValue()

Member Data Documentation

fPtr

std::shared_ptr<GUIJmbParameter<T> > fPtr

private

---

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

• pongasoft/VST/GUI/Params/GUIJmbParameter.h