pongasoft::VST::GUI::Params::GUIRawVstParam Class Reference

#include <GUIRawVstParameter.h>

Public Member Functions
tresult	copyValueFrom (GUIRawVstParam const &iParam)
std::unique_ptr< GUIRawVstParameter::Editor >	edit ()
std::unique_ptr< GUIRawVstParameter::Editor >	edit (ParamValue const &iValue)
bool	exists () const
ParamID	getParamID () const
ParamValue	getValue () const
	GUIRawVstParam ()
	GUIRawVstParam (std::unique_ptr< GUIRawVstParameter > &&iPtr)
	GUIRawVstParam (GUIRawVstParam &iPtr)=delete
	GUIRawVstParam (GUIRawVstParam &&iPtr) noexcept
	operator ParamValue () const
bool	operator!= (const GUIRawVstParam &rhs) const
GUIRawVstParam &	operator= (GUIRawVstParam &&iPtr) noexcept
void	operator= (ParamValue const &iValue)
bool	operator== (const GUIRawVstParam &rhs) const
tresult	setValue (ParamValue const &iValue)
void	toString (String128 oString)
String	toString ()

Private Attributes
std::unique_ptr< GUIRawVstParameter >	fPtr

Detailed Description

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).

Constructor & Destructor Documentation

GUIRawVstParam() [1/4]

pongasoft::VST::GUI::Params::GUIRawVstParam::GUIRawVstParam ( )

inline

GUIRawVstParam() [2/4]

pongasoft::VST::GUI::Params::GUIRawVstParam::GUIRawVstParam ( std::unique_ptr< GUIRawVstParameter > &&  iPtr )

inlineexplicit

GUIRawVstParam() [3/4]

pongasoft::VST::GUI::Params::GUIRawVstParam::GUIRawVstParam ( GUIRawVstParam &  iPtr )

delete

GUIRawVstParam() [4/4]

pongasoft::VST::GUI::Params::GUIRawVstParam::GUIRawVstParam ( GUIRawVstParam &&  iPtr )

inlinenoexcept

Member Function Documentation

copyValueFrom()

tresult pongasoft::VST::GUI::Params::GUIRawVstParam::copyValueFrom ( GUIRawVstParam const &  iParam )

inline

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

edit() [1/2]

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

inline

Returns

an editor to modify the parameter (see Editor)

edit() [2/2]

std::unique_ptr<GUIRawVstParameter::Editor> pongasoft::VST::GUI::Params::GUIRawVstParam::edit ( ParamValue 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 pongasoft::VST::GUI::Params::GUIRawVstParam::exists ( ) const

inline

getParamID()

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

inline

getValue()

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

inline

Returns

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

operator ParamValue()

pongasoft::VST::GUI::Params::GUIRawVstParam::operator ParamValue ( ) const

inline

operator!=()

bool pongasoft::VST::GUI::Params::GUIRawVstParam::operator!= ( const GUIRawVstParam &  rhs ) const

inline

operator=() [1/2]

GUIRawVstParam& pongasoft::VST::GUI::Params::GUIRawVstParam::operator= ( GUIRawVstParam &&  iPtr )

inlinenoexcept

operator=() [2/2]

void pongasoft::VST::GUI::Params::GUIRawVstParam::operator= ( ParamValue const &  iValue )

inline

operator==()

bool pongasoft::VST::GUI::Params::GUIRawVstParam::operator== ( const GUIRawVstParam &  rhs ) const

inline

setValue()

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

inline

Populates the oString with a string representation of this parameter

toString() [2/2]

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

inline

Returns a string representation of this parameter

Member Data Documentation

fPtr

std::unique_ptr<GUIRawVstParameter> pongasoft::VST::GUI::Params::GUIRawVstParam::fPtr

private

---

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

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