RangeParameter Class Reference

Description of a RangeParameter. More...

#include <vstparameters.h>

Inheritance diagram for 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). More...
virtual void	setMin (ParamValue value)
	Sets the minimum plain value. More...
virtual ParamValue	getMax () const
	Gets the maximum plain value, same as toPlain (1). More...
virtual void	setMax (ParamValue value)
	Sets the maximum plain value. More...
void	toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE
	Converts a normalized value to a string. More...
bool	fromString (const TChar *string, ParamValue &_valueNormalized) const SMTG_OVERRIDE
	Converts a string to a normalized value. More...
ParamValue	toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE
	Converts a normalized value to plain value (e.g. More...
ParamValue	toNormalized (ParamValue plainValue) const SMTG_OVERRIDE
	Converts a plain value to a normalized value (e.g. More...
Public Member Functions inherited from Parameter
	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
	Returns its read only info. More...
virtual ParameterInfo &	getInfo ()
	Returns its writable info. More...
virtual void	setUnitID (UnitID id)
	Sets its associated UnitId. More...
virtual UnitID	getUnitID ()
	Gets its associated UnitId. More...
ParamValue	getNormalized () const
	Gets its normalized value [0.0, 1.0]. More...
virtual bool	setNormalized (ParamValue v)
	Sets its normalized value [0.0, 1.0]. More...
virtual void	toString (ParamValue valueNormalized, String128 string) const
	Converts a normalized value to a string. More...
virtual bool	fromString (const TChar *string, ParamValue &valueNormalized) const
	Converts a string to a normalized value. More...
virtual ParamValue	toPlain (ParamValue valueNormalized) const
	Converts a normalized value to plain value (e.g. More...
virtual ParamValue	toNormalized (ParamValue plainValue) const
	Converts a plain value to a normalized value (e.g. More...
virtual int32	getPrecision () const
	Gets the current precision (used for string representation of float). More...
virtual void	setPrecision (int32 val)
	Sets the precision for string representation of float value (for example 4.34 with 2 as precision). More...

Public Attributes
OBJ_METHODS(RangeParameter, Parameter) protected ParamValue	minPlain
ParamValue	maxPlain
Public Attributes inherited from Parameter
OBJ_METHODS(Parameter, FObject) protected ParamValue	valueNormalized {0.}
int32	precision {4}

Detailed Description

Description of a RangeParameter.

Constructor & Destructor Documentation

RangeParameter() [1/2]

RangeParameter	(	const ParameterInfo &	paramInfo,
		ParamValue	min,
		ParamValue	max
	)

RangeParameter() [2/2]

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
	)

Member Function Documentation

getMin()

virtual ParamValue getMin ( ) const

inlinevirtual

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

setMin()

virtual void setMin ( ParamValue  value )

inlinevirtual

Sets the minimum plain value.

getMax()

virtual ParamValue getMax ( ) const

inlinevirtual

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

setMax()

virtual void setMax ( ParamValue  value )

inlinevirtual

Sets the maximum plain value.

toString()

void toString ( ParamValue  _valueNormalized, String128  string  ) const

virtual

Converts a normalized value to a string.

Reimplemented from Parameter.

fromString()

bool fromString ( const TChar *  string, ParamValue &  _valueNormalized  ) const

virtual

Converts a string to a normalized value.

Reimplemented from Parameter.

toPlain()

ParamValue toPlain ( ParamValue  _valueNormalized ) const

virtual

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

0.5 to 10000.0Hz).

Reimplemented from Parameter.

toNormalized()

ParamValue toNormalized ( ParamValue  plainValue ) const

virtual

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

10000 to 0.5).

Reimplemented from Parameter.

Member Data Documentation

minPlain

OBJ_METHODS (RangeParameter, Parameter) protected ParamValue minPlain

maxPlain

ParamValue maxPlain