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 <GUIVstParameter.h>

Inherits Dereferenceable< GUIVstParam< T > >.

Classes
class	Value
	The purpose of this class is to copy the value so that it can be accessed via `->` thus allowing to write `param->x` to access the underlying type (`T`) when it is a struct or a class. More...

Public Types
using	Editor = std::unique_ptr< EditorType >

using	EditorType = typename GUIVstParameter< T >::ITEditor

using	ParamType = T

Public Member Functions
std::unique_ptr< FObjectCx >	connect (Parameters::IChangeListener *iChangeListener) const
	Allow to write param1 == param2. More...

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

template<typename V >
tresult	copyValueFrom (GUIVstParam< V > const &iParam)
	Shortcut to copy the value from another param to this one. More...

tresult	copyValueFrom (GUIRawVstParam const &iParam)
	Shortcut to copy the value from another param to this one (raw value) More...

Editor	edit ()

Editor	edit (T const &iValue)
	Shortcut to create an editor and set the value to it. More...

bool	exists () const

ParamValue	getNormalizedValue () const

ParamID	getParamID () const

int32	getStepCount () const

T	getValue () const

	GUIVstParam (std::shared_ptr< GUIVstParameter< T >> iPtr=nullptr)

constexpr T	operator * () const
	allow writing param to access the underlying value (or in other words, `param` is the same `param.value()`) More...

constexpr Value	operator -> () const
	allow writing param->x to access the underlying value when T is a struct or class More...

	operator T () const
	Allow to use the param as the underlying ParamType (ex: `if(param)` in the case `ParamType` is `bool`)) More...

GUIVstParam< T > &	operator= (GUIVstParam< T > const &iOther)=default
	Assignment operator: `fMyParam = registerParam(...);` More...

GUIVstParam< T > &	operator= (T const &iValue)
	Allow to write param = 3.0. More...

tresult	resetToDefault ()
	Resets the param to its default value. More...

tresult	setNormalizedValue (ParamValue const &iNormalizedValue)
	Sets the value of this parameter as a normalized value. More...

tresult	setValue (T const &iValue)
	Sets the value of this parameter. More...

void	toString (String128 oString)
	Populates the oString with a string representation of this parameter. More...

Steinberg::String	toString ()
	Returns a string representation of this parameter. 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 &iValue)
	Update the parameter with a value. More...

T	value () const
	Synonym to `getValue()` More...

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

Detailed Description

template<typename T>
class pongasoft::VST::GUI::Params::GUIVstParam< 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 GUIVstParameter<T>::ITEditor

◆ ParamType

using ParamType = T

Constructor & Destructor Documentation

◆ GUIVstParam()

GUIVstParam ( std::shared_ptr< GUIVstParameter< T >> iPtr = nullptr )

inline

Member Function Documentation

◆ connect() [1/2]

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

inline

Allow to write param1 == param2.

Returns: an object maintaining the connection between the parameter and the listener

◆ connect() [2/2]

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

inline

Returns: an object maintaining the connection between the parameter and the callback

◆ copyValueFrom() [1/2]

tresult copyValueFrom ( GUIVstParam< V > const & iParam )

inline

Shortcut to copy the value from another param to this one.

Implementation note: uses normalized value as this is faster and avoid math precision loss in normalize/denormalize

◆ copyValueFrom() [2/2]

tresult copyValueFrom ( GUIRawVstParam const & iParam )

inline

Shortcut to copy the value from another param to this one (raw value)

◆ edit() [1/2]

Editor edit ( )

inline

Returns: an editor to modify the parameter (see Editor)

◆ edit() [2/2]

Editor edit ( T const & iValue )

inline

Shortcut to create an editor and set the value to it.

Returns: an editor to modify the parameter (see Editor)

◆ exists()

bool exists ( ) const

inline

◆ getNormalizedValue()

ParamValue getNormalizedValue ( ) const

inline

Returns: the current value of the parameter as a normalized value

◆ getParamID()

ParamID getParamID ( ) const

inline

◆ getStepCount()

int32 getStepCount ( ) const

inline

Returns: number of steps (for discrete param) or 0 for continuous

◆ getValue()

T getValue ( ) const

inline

Returns: the current value of the parameter as a T (using the Denormalizer)

◆ operator *()

constexpr T operator * ( ) const

inline

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

◆ operator ->()

constexpr Value operator -> ( ) const

inline

allow writing param->x to access the underlying value when T is a struct or class

◆ operator T()

operator T ( ) const

inline

Allow to use the param as the underlying ParamType (ex: if(param) in the case ParamType is bool))

◆ operator=() [1/2]

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

default

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

◆ operator=() [2/2]

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

inline

Allow to write param = 3.0.

◆ resetToDefault()

tresult resetToDefault ( )

inline

Resets the param to its default value.

◆ setNormalizedValue()

tresult setNormalizedValue ( ParamValue const & iNormalizedValue )

inline

Sets the value of this parameter as a normalized value.

Note that this is "transactional" and if you want to make further changes that spans multiple calls (ex: onMouseDown / onMouseMoved / onMouseUp) you should use an editor

◆ setValue()

tresult setValue ( T const & iValue )

inline

Sets the value of this parameter.

Note that this is "transactional" and if you want to make further changes that spans multiple calls (ex: onMouseDown / onMouseMoved / onMouseUp) you should use an editor

◆ toString() [1/2]

void toString ( String128 oString )

inline

Populates the oString with a string representation of this parameter.

◆ toString() [2/2]

Steinberg::String toString ( )

inline

Returns a string representation of this parameter.

◆ 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 & iValue )

inline

Update the parameter with a value.

Returns: true if the value was actually updated, false if it is the same

◆ value()

T value ( ) const

inline

Synonym to getValue()

Member Data Documentation

◆ fPtr

std::shared_ptr<GUIVstParameter<T> > fPtr

private

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

pongasoft/VST/GUI/Params/GUIVstParameter.h

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Editor

◆ EditorType

◆ ParamType

Constructor & Destructor Documentation

◆ GUIVstParam()

Member Function Documentation

◆ connect() [1/2]

◆ connect() [2/2]

◆ copyValueFrom() [1/2]

◆ copyValueFrom() [2/2]

◆ edit() [1/2]

◆ edit() [2/2]

◆ exists()

◆ getNormalizedValue()

◆ getParamID()

◆ getStepCount()

◆ getValue()

◆ operator *()

◆ operator ->()

◆ operator T()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resetToDefault()

◆ setNormalizedValue()

◆ setValue()

◆ toString() [1/2]

◆ toString() [2/2]

◆ toUTF8String()

◆ update()

◆ value()

Member Data Documentation

◆ fPtr

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