#include <vstparameters.h>

Inheritance diagram for Steinberg::Vst::Parameter:

Public Member Functions
	Parameter ()
	Parameter (const ParameterInfo &)
	Parameter (const TChar title, ParamID tag, const TChar units=nullptr, ParamValue defaultValueNormalized=0., int32 stepCount=0, int32 flags=ParameterInfo::kCanAutomate, UnitID unitID=kRootUnitId, const TChar *shortTitle=nullptr)
	~Parameter () override
virtual const ParameterInfo &	getInfo () const
virtual ParameterInfo &	getInfo ()
virtual void	setUnitID (UnitID id)
virtual UnitID	getUnitID ()
ParamValue	getNormalized () const
virtual bool	setNormalized (ParamValue v)
virtual void	toString (ParamValue valueNormalized, String128 string) const
virtual bool	fromString (const TChar *string, ParamValue &valueNormalized) const
virtual ParamValue	toPlain (ParamValue valueNormalized) const
virtual ParamValue	toNormalized (ParamValue plainValue) const
virtual int32	getPrecision () const
virtual void	setPrecision (int32 val)
Public Member Functions inherited from Steinberg::FObject
	FObject ()
	default constructor...
	FObject (const FObject &)
	overloaded constructor...
virtual	~FObject ()
	destructor...
FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment
virtual FClassID	isA () const
	a local alternative to getFClassID ()
virtual bool	isA (FClassID s) const
	evaluates if the passed ID is of the FObject type
virtual bool	isTypeOf (FClassID s, bool=true) const
	evaluates if the passed ID is of the FObject type
int32	getRefCount ()
	returns the current interface reference count
FUnknown *	unknownCast ()
	get FUnknown interface from object
tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
	please refer to FUnknown::queryInterface ()
uint32 PLUGIN_API	addRef () SMTG_OVERRIDE
	please refer to FUnknown::addref ()
uint32 PLUGIN_API	release () SMTG_OVERRIDE
	please refer to FUnknown::release ()
void PLUGIN_API	update (FUnknown *, int32) SMTG_OVERRIDE
	empty virtual method that should be overridden by derived classes for data updates upon changes
virtual void	addDependent (IDependent *dep)
	adds dependency to the object
virtual void	removeDependent (IDependent *dep)
	removes dependency from the object
virtual void	changed (int32 msg=kChanged)
	Inform all dependents, that the object has changed.
virtual void	deferUpdate (int32 msg=kChanged)
	Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).
virtual void	updateDone (int32)
	empty virtual method that should be overridden by derived classes
virtual bool	isEqualInstance (FUnknown *d)

Protected Attributes
ParameterInfo	info
ParamValue	valueNormalized
int32	precision
Protected Attributes inherited from Steinberg::FObject
int32	refCount
	COM-model local reference count.

Additional Inherited Members
Public Types inherited from Steinberg::IDependent
enum	ChangeMessage { kWillChange , kChanged , kDestroyed , kWillDestroy , kStdChangeMessageLast = kWillDestroy }
Static Public Member Functions inherited from Steinberg::FObject
static FClassID	getFClassID ()
	return Class ID as an ASCII string (statically)
static void	setUpdateHandler (IUpdateHandler *handler)
	set method for the local attribute
static IUpdateHandler *	getUpdateHandler ()
	get method for the local attribute
static bool	classIDsEqual (FClassID ci1, FClassID ci2)
	compares (evaluates) 2 class IDs
static FObject *	unknownToObject (FUnknown *unknown)
	pointer conversion from FUnknown to FObject
Static Public Attributes inherited from Steinberg::FObject
static const FUID	iid
Static Public Attributes inherited from Steinberg::IDependent
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid
Static Protected Attributes inherited from Steinberg::FObject
static IUpdateHandler *	gUpdateHandler = nullptr

Detailed Description

Description of a Parameter.

Constructor & Destructor Documentation

◆ Parameter() [1/3]

Steinberg::Vst::Parameter::Parameter ( )

◆ Parameter() [2/3]

Steinberg::Vst::Parameter::Parameter ( const ParameterInfo & info )

◆ Parameter() [3/3]

Steinberg::Vst::Parameter::Parameter	(	const TChar *	title,
		ParamID	tag,
		const TChar *	units = nullptr,
		ParamValue	defaultValueNormalized = 0.,
		int32	stepCount = 0,
		int32	flags = ParameterInfo::kCanAutomate,
		UnitID	unitID = kRootUnitId,
		const TChar *	shortTitle = nullptr )

◆ ~Parameter()

Steinberg::Vst::Parameter::~Parameter ( )

override

Member Function Documentation

◆ fromString()

bool Steinberg::Vst::Parameter::fromString	(	const TChar *	string,
		ParamValue &	valueNormalized ) const

virtual

Converts a string to a normalized value.

Reimplemented in Steinberg::Vst::RangeParameter, and Steinberg::Vst::StringListParameter.

◆ getInfo() [1/2]

virtual ParameterInfo & Steinberg::Vst::Parameter::getInfo ( )

inlinevirtual

Returns its writable info.

◆ getInfo() [2/2]

virtual const ParameterInfo & Steinberg::Vst::Parameter::getInfo ( ) const

inlinevirtual

Returns its read only info.

◆ getNormalized()

ParamValue Steinberg::Vst::Parameter::getNormalized ( ) const

inline

Gets its normalized value [0.0, 1.0].

◆ getPrecision()

virtual int32 Steinberg::Vst::Parameter::getPrecision ( ) const

inlinevirtual

Gets the current precision (used for string representation of float).

◆ getUnitID()

virtual UnitID Steinberg::Vst::Parameter::getUnitID ( )

inlinevirtual

Gets its associated UnitId.

◆ setNormalized()

bool Steinberg::Vst::Parameter::setNormalized ( ParamValue v )

virtual

Sets its normalized value [0.0, 1.0].

◆ setPrecision()

virtual void Steinberg::Vst::Parameter::setPrecision ( int32 val )

inlinevirtual

Sets the precision for string representation of float value (for example 4.34 with 2 as precision).

◆ setUnitID()

virtual void Steinberg::Vst::Parameter::setUnitID ( UnitID id )

inlinevirtual

Sets its associated UnitId.

◆ toNormalized()

ParamValue Steinberg::Vst::Parameter::toNormalized ( ParamValue plainValue ) const

virtual

Converts a plain value to a normalized value (e.g. 10000 to 0.5).

Reimplemented in Steinberg::Vst::RangeParameter, and Steinberg::Vst::StringListParameter.

◆ toPlain()

ParamValue Steinberg::Vst::Parameter::toPlain ( ParamValue valueNormalized ) const

virtual

Converts a normalized value to plain value (e.g. 0.5 to 10000.0Hz).

Reimplemented in Steinberg::Vst::RangeParameter, and Steinberg::Vst::StringListParameter.

◆ toString()

void Steinberg::Vst::Parameter::toString	(	ParamValue	valueNormalized,
		String128	string ) const

virtual

Converts a normalized value to a string.

Reimplemented in Steinberg::Vst::RangeParameter, and Steinberg::Vst::StringListParameter.

Member Data Documentation

◆ info

ParameterInfo Steinberg::Vst::Parameter::info

protected

◆ precision

int32 Steinberg::Vst::Parameter::precision

protected

◆ valueNormalized

ParamValue Steinberg::Vst::Parameter::valueNormalized

protected

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstparameters.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstparameters.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Parameter() [1/3]

◆ Parameter() [2/3]

◆ Parameter() [3/3]

◆ ~Parameter()

Member Function Documentation

◆ fromString()

◆ getInfo() [1/2]

◆ getInfo() [2/2]

◆ getNormalized()

◆ getPrecision()

◆ getUnitID()

◆ setNormalized()

◆ setPrecision()

◆ setUnitID()

◆ toNormalized()

◆ toPlain()

◆ toString()

Member Data Documentation

◆ info

◆ precision

◆ valueNormalized