Description of a RangeParameter. More...

#include "vstparameters.h"

Inheritance diagram for Steinberg::Vst::RangeParameter:

Public Member Functions
	RangeParameter (const ParameterInfo &paramInfo, ParamValue min, ParamValue max)

	RangeParameter (const TChar title, ParamID tag, const TChar units=nullptr, ParamValue minPlain=0., ParamValue maxPlain=1., ParamValue defaultValuePlain=0., int32 stepCount=0, int32 flags=ParameterInfo::kCanAutomate, UnitID unitID=kRootUnitId, const TChar *shortTitle=nullptr)

virtual ParamValue	getMin () const
	Gets the minimum plain value, same as toPlain (0).

virtual void	setMin (ParamValue value)
	Sets the minimum plain value.

virtual ParamValue	getMax () const
	Gets the maximum plain value, same as toPlain (1).

virtual void	setMax (ParamValue value)
	Sets the maximum plain value.

void	toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE
	Converts a normalized value to a string.

bool	fromString (const TChar *string, ParamValue &_valueNormalized) const SMTG_OVERRIDE
	Converts a string to a normalized value.

ParamValue	toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE
	Converts a normalized value to plain value (e.g.

ParamValue	toNormalized (ParamValue plainValue) const SMTG_OVERRIDE
	Converts a plain value to a normalized value (e.g.

Public Member Functions inherited from Steinberg::Vst::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)

virtual const ParameterInfo &	getInfo () const
	Returns its read only info.

virtual ParameterInfo &	getInfo ()
	Returns its writable info.

virtual void	setUnitID (UnitID id)
	Sets its associated UnitId.

virtual UnitID	getUnitID ()
	Gets its associated UnitId.

ParamValue	getNormalized () const
	Gets its normalized value [0.0, 1.0].

virtual bool	setNormalized (ParamValue v)
	Sets its normalized value [0.0, 1.0].

virtual int32	getPrecision () const
	Gets the current precision (used for string representation of float).

virtual void	setPrecision (int32 val)
	Sets the precision for string representation of float value (for example 4.34 with 2 as precision).

Public Member Functions inherited from Steinberg::FObject
	FObject ()=default
	default constructor...

	FObject (const FObject &)

FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment

virtual	~FObject ()
	destructor...

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
ParamValue	minPlain

ParamValue	maxPlain

Protected Attributes inherited from Steinberg::Vst::Parameter
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 }

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
	Special UID that is used to cast an FUnknown pointer to a FObject.

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

Detailed Description

Description of a RangeParameter.

Definition at line 110 of file vstparameters.h.

Constructor & Destructor Documentation

◆ RangeParameter() [1/3]

Steinberg::Vst::RangeParameter::RangeParameter	(	const ParameterInfo &	paramInfo,
		ParamValue	min,
		ParamValue	max
	)

Definition at line 151 of file vstparameters.cpp.

◆ RangeParameter() [2/3]

Steinberg::Vst::RangeParameter::RangeParameter	(	const TChar *	title,
		ParamID	tag,
		const TChar *	units = `nullptr`,
		ParamValue	minPlain = `0.`,
		ParamValue	maxPlain = `1.`,
		ParamValue	defaultValuePlain = `0.`,
		int32	stepCount = `0`,
		int32	flags = `ParameterInfo::kCanAutomate`,
		UnitID	unitID = `kRootUnitId`,
		const TChar *	shortTitle = `nullptr`
	)

Definition at line 157 of file vstparameters.cpp.

◆ RangeParameter() [3/3]

Steinberg::Vst::RangeParameter::RangeParameter ( )

protected

Definition at line 146 of file vstparameters.cpp.

Member Function Documentation

◆ fromString()

bool Steinberg::Vst::RangeParameter::fromString	(	const TChar *	string,
		ParamValue &	_valueNormalized
	)		const

virtual

Converts a string to a normalized value.

Reimplemented from Steinberg::Vst::Parameter.

Definition at line 193 of file vstparameters.cpp.

◆ getMax()

virtual ParamValue Steinberg::Vst::RangeParameter::getMax ( ) const

virtual

Gets the maximum plain value, same as toPlain (1).

Definition at line 126 of file vstparameters.h.

◆ getMin()

virtual ParamValue Steinberg::Vst::RangeParameter::getMin ( ) const

virtual

Gets the minimum plain value, same as toPlain (0).

Definition at line 122 of file vstparameters.h.

◆ setMax()

virtual void Steinberg::Vst::RangeParameter::setMax ( ParamValue value )

virtual

Sets the maximum plain value.

Definition at line 128 of file vstparameters.h.

◆ setMin()

virtual void Steinberg::Vst::RangeParameter::setMin ( ParamValue value )

virtual

Sets the minimum plain value.

Definition at line 124 of file vstparameters.h.

◆ toNormalized()

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

virtual

Converts a plain value to a normalized value (e.g.

10000 to 0.5).

Reimplemented from Steinberg::Vst::Parameter.

Definition at line 227 of file vstparameters.cpp.

◆ toPlain()

ParamValue Steinberg::Vst::RangeParameter::toPlain ( ParamValue _valueNormalized ) const

virtual

Converts a normalized value to plain value (e.g.

0.5 to 10000.0Hz).

Reimplemented from Steinberg::Vst::Parameter.

Definition at line 219 of file vstparameters.cpp.

◆ toString()

void Steinberg::Vst::RangeParameter::toString	(	ParamValue	_valueNormalized,
		String128	string
	)		const

virtual

Converts a normalized value to a string.

Reimplemented from Steinberg::Vst::Parameter.

Definition at line 177 of file vstparameters.cpp.

Member Data Documentation

◆ maxPlain

ParamValue Steinberg::Vst::RangeParameter::maxPlain

protected

Definition at line 146 of file vstparameters.h.

◆ minPlain

ParamValue Steinberg::Vst::RangeParameter::minPlain

protected

Definition at line 145 of file vstparameters.h.

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

juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstparameters.h
juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstparameters.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RangeParameter() [1/3]

◆ RangeParameter() [2/3]

◆ RangeParameter() [3/3]

Member Function Documentation

◆ fromString()

◆ getMax()

◆ getMin()

◆ setMax()

◆ setMin()

◆ toNormalized()

◆ toPlain()

◆ toString()

Member Data Documentation

◆ maxPlain

◆ minPlain