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>
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 |
◆ GUIVstParam()
◆ connect() [1/2]
- Returns
- an object maintaining the connection between the parameter and the listener
◆ connect() [2/2]
- Returns
- an object maintaining the connection between the parameter and the callback
◆ copyValueFrom()
tresult copyValueFrom |
( |
GUIVstParam< T > 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
◆ edit() [1/2]
- Returns
- an editor to modify the parameter (see Editor)
◆ edit() [2/2]
std::unique_ptr<typename GUIVstParameter<T>::EditorType> 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()
◆ 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()
- Returns
- the current value of the parameter as a T (using the Denormalizer)
◆ operator T()
Allow to use the param as the underlying ParamType (ex: if(param)
in the case ParamType
is bool
))
◆ operator!=()
Allow to write param1 != param2.
◆ operator=() [1/2]
Assignment operator: fMyParam = registerParam(...);
◆ operator=() [2/2]
Allow to write param = 3.0.
◆ operator==()
Allow to write param1 == param2.
◆ 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]
Returns a string representation of this parameter.
◆ fPtr
The documentation for this class was generated from the following file: