WE Core
Loading...
Searching...
No Matches
ParameterDefinition::RangedParameter< T > Class Template Reference

#include <ParameterDefinition.h>

Inheritance diagram for ParameterDefinition::RangedParameter< T >:
ParameterDefinition::BaseParameter< T >

Public Member Functions

NormalisedToInternal (T val) const
 
InternalToNormalised (T val) const
 
- Public Member Functions inherited from ParameterDefinition::BaseParameter< T >
 BaseParameter ()=delete
 
virtual ~BaseParameter ()=default
 
 BaseParameter (T newMinValue, T newMaxValue, T newDefaultValue)
 
BoundsCheck (T val) const
 

Additional Inherited Members

- Public Attributes inherited from ParameterDefinition::BaseParameter< T >
const T minValue
 
const T maxValue
 
const T defaultValue
 

Detailed Description

template<class T>
class ParameterDefinition::RangedParameter< T >

Provides storage for minimum, maximum and default values for a parameter which can contain a continuous value (such as a slider), as well as methods to convert between the normalised and internal ranges, and clip a value to the appropriate range.

Definition at line 101 of file ParameterDefinition.h.

Member Function Documentation

◆ InternalToNormalised()

template<class T >
T ParameterDefinition::RangedParameter< T >::InternalToNormalised ( T val) const
inline

Translates parameter values from the range used internally for that parameter, to the normalised range (0 to 1) as required by VSTs.

Parameters
valValue of the parameter in the internal range
Returns
The normalised value of the parameter

Definition at line 127 of file ParameterDefinition.h.

References ParameterDefinition::BaseParameter< T >::maxValue, and ParameterDefinition::BaseParameter< T >::minValue.

◆ NormalisedToInternal()

template<class T >
T ParameterDefinition::RangedParameter< T >::NormalisedToInternal ( T val) const
inline

Translates parameter values from the normalised (0 to 1) range as required by VSTs to the range used internally for that parameter

Parameters
valNormalised value of the parameter
Returns
The value of the parameter in the internal range for that parameter

Definition at line 115 of file ParameterDefinition.h.

References ParameterDefinition::BaseParameter< T >::maxValue, and ParameterDefinition::BaseParameter< T >::minValue.


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