pongasoft::VST::GUI::Params::GUIRawVstParameter Class Reference

#include <GUIRawVstParameter.h>

Classes
class	Editor

Public Member Functions
std::unique_ptr< FObjectCx >	connect (Parameters::IChangeListener *iChangeListener) const
std::unique_ptr< FObjectCx >	connect (Parameters::ChangeCallback iChangeCallback) const
std::unique_ptr< Editor >	edit ()
std::unique_ptr< Editor >	edit (ParamValue iValue)
ParamID	getParamID () const
ParamValue	getValue () const
	GUIRawVstParameter (ParamID iParamID, VstParametersSPtr iVstParameters)
tresult	setValue (ParamValue iValue)
void	toString (String128 oString)
String	toString ()
	~GUIRawVstParameter ()=default

Private Attributes
ParamID	fParamID
VstParametersSPtr	fVstParameters {}

Detailed Description

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. This "raw" version deals with ParamValue which is the underlying type used by the vst sdk which is always a number in the range [0.0, 1.0]. The class VSTParameter deals with other types and automatic normalization/denormalization.

Constructor & Destructor Documentation

GUIRawVstParameter()

pongasoft::VST::GUI::Params::GUIRawVstParameter::GUIRawVstParameter	(	ParamID	iParamID,
		VstParametersSPtr	iVstParameters
	)

~GUIRawVstParameter()

pongasoft::VST::GUI::Params::GUIRawVstParameter::~GUIRawVstParameter ( )

default

Member Function Documentation

connect() [1/2]

std::unique_ptr<FObjectCx> pongasoft::VST::GUI::Params::GUIRawVstParameter::connect ( Parameters::IChangeListener *  iChangeListener ) const

inline

Returns

an object maintaining the connection between the parameter and the listener

connect() [2/2]

std::unique_ptr<FObjectCx> pongasoft::VST::GUI::Params::GUIRawVstParameter::connect ( Parameters::ChangeCallback  iChangeCallback ) const

inline

Returns

an object maintaining the connection between the parameter and the callback

edit() [1/2]

std::unique_ptr<Editor> pongasoft::VST::GUI::Params::GUIRawVstParameter::edit ( )

inline

Returns

an editor to modify the parameter (see Editor)

edit() [2/2]

std::unique_ptr<Editor> pongasoft::VST::GUI::Params::GUIRawVstParameter::edit ( ParamValue  iValue )

inline

Shortcut to create an editor and set the value to it

Returns

an editor to modify the parameter (see Editor)

getParamID()

ParamID pongasoft::VST::GUI::Params::GUIRawVstParameter::getParamID ( ) const

inline

getValue()

ParamValue pongasoft::VST::GUI::Params::GUIRawVstParameter::getValue ( ) const

inline

Returns

the current raw value of the parameter

setValue()

tresult pongasoft::VST::GUI::Params::GUIRawVstParameter::setValue ( ParamValue  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 pongasoft::VST::GUI::Params::GUIRawVstParameter::toString ( String128  oString )

inline

Populates the oString with a string representation of this parameter

toString() [2/2]

String pongasoft::VST::GUI::Params::GUIRawVstParameter::toString ( )

inline

Returns a string representation of this parameter

Member Data Documentation

fParamID

ParamID pongasoft::VST::GUI::Params::GUIRawVstParameter::fParamID

private

fVstParameters

VstParametersSPtr pongasoft::VST::GUI::Params::GUIRawVstParameter::fVstParameters {}

private

---

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

• pongasoft/VST/GUI/Params/GUIRawVstParameter.h
• pongasoft/VST/GUI/Params/GUIRawVstParameter.cpp