Jamba C++ API  5.1.1
pongasoft::VST::GUI::Params Namespace Reference

Classes

class  DefaultEditorImpl
 Default implementation of the editor interface. More...
 
class  DiscreteParamConverter
 Simple wrapper to allow to treat any vst parameter as a discrete one: uses the vst sdk definition of what a discrete property is. More...
 
class  GUIDiscreteJmbParameter
 Wraps a GUIJmbParameter<T> to interpret it as a discrete parameter using the converter. More...
 
class  GUIDiscreteValParameter
 Simple extension class to treat a Val parameter as a discrete one. More...
 
class  GUIJmbParam
 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...
 
class  GUIJmbParameter
 This is the templated version providing serializer methods, very similar to the GUIVstParameter concept. More...
 
class  GUIOptionalParam
 Represents an optional parameter (Jmb, Vst or no param at all). More...
 
class  GUIParamCx
 Wrapper class which maintains the connection between a parameter and its listener. More...
 
class  GUIParamCxAware
 Code has been moved to ParamAware class. More...
 
class  GUIParamCxMgr
 Maintains the connections established between parameters and its listeners/callbacks. More...
 
class  GUIRawVstParam
 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...
 
class  GUIRawVstParameter
 Encapsulates a vst parameter and how to access it (read/write) as well as how to "connect" to it in order to be notified of changes. More...
 
class  GUIValParameter
 This parameter is not tied to any parameter definition/registration and is primarily used by the optional parameter. More...
 
class  GUIVstParam
 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...
 
class  GUIVstParameter
 This class wraps a GUIRawVstParameter to deal with any type T. More...
 
class  IGUIJmbParameter
 Base class for a Jamba (Jmb) GUI parameter. More...
 
class  IGUIParam
 Wrapper instance returned by ParamAware::registerBaseParam() methods. More...
 
class  IGUIParameter
 This is the base class of all GUI parameters. More...
 
class  ITGUIParameter
 Represents a gui parameter with its underlying backing type T (aka ParamType). More...
 
class  ParamAware
 This class is inherited by classes who want to be aware of parameters and be notified when they change. More...
 
class  ParamAwareView
 This subclass allows for registering callbacks to any kind of view without having to inherit from it. More...
 
class  UTF8StringParamSerializer
 A parameter backed by a UTF8String. More...
 
class  ViewGUIParamCxAware
 
class  VstParameters
 This class acts as a facade/proxy to the vst parameters managed by the host daw. More...
 

Typedefs

using GUIDiscreteParameter = ITGUIParameter< int32 >
 A discrete parameter is defined by a parameter whose underlying backing type is an int32 and whose number of steps is > 0. More...
 
template<typename T >
using GUIOptionalParamEditor = std::unique_ptr< typename GUIOptionalParam< T >::EditorType >
 
using GUIRawOptionalParam = GUIOptionalParam< ParamValue >
 
using GUIRawOptionalParamEditor = GUIOptionalParamEditor< ParamValue >
 
using GUIRawVstParamEditor = std::unique_ptr< GUIRawVstParameter::EditorType >
 
using GUIVstBooleanParam = GUIVstParam< bool >
 
template<typename T >
using GUIVstParamEditor = std::unique_ptr< typename GUIVstParameter< T >::EditorType >
 
using GUIVstPercentParam = GUIVstParam< Percent >
 
using VstParametersSPtr = std::shared_ptr< VstParameters >
 

Functions

template<typename T >
static std::shared_ptr< GUIJmbParameter< T > > castToJmb (std::shared_ptr< IGUIParameter > iParam)
 Convenient function to cast a generic IGUIParameter to a GUIJmbParameter<T>. More...
 

Typedef Documentation

◆ GUIDiscreteParameter

A discrete parameter is defined by a parameter whose underlying backing type is an int32 and whose number of steps is > 0.

The values that a discrete parameter manages are, by definition, in the range `[0, GUIDiscreteParameter::getStepCount()].

◆ GUIOptionalParamEditor

using GUIOptionalParamEditor = std::unique_ptr<typename GUIOptionalParam<T>::EditorType>

◆ GUIRawOptionalParam

◆ GUIRawOptionalParamEditor

◆ GUIRawVstParamEditor

◆ GUIVstBooleanParam

◆ GUIVstParamEditor

using GUIVstParamEditor = std::unique_ptr<typename GUIVstParameter<T>::EditorType>

◆ GUIVstPercentParam

◆ VstParametersSPtr

using VstParametersSPtr = std::shared_ptr<VstParameters>

Function Documentation

◆ castToJmb()

static std::shared_ptr<GUIJmbParameter<T> > pongasoft::VST::GUI::Params::castToJmb ( std::shared_ptr< IGUIParameter iParam)
static

Convenient function to cast a generic IGUIParameter to a GUIJmbParameter<T>.

If not the proper type it will return nullptr