AudioParameterFloat Class Reference

A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto a given NormalisableRange. More...

Inheritance diagram for AudioParameterFloat:

Public Member Functions
	AudioParameterFloat (String parameterID, String name, NormalisableRange< float > normalisableRange, float defaultValue)
	Creates a AudioParameterFloat with an ID, name, and range. More...
	AudioParameterFloat (String parameterID, String name, float minValue, float maxValue, float defaultValue)
	Creates a AudioParameterFloat with an ID, name, and range. More...
	~AudioParameterFloat ()
	Destructor. More...
float	get () const noexcept
	Returns the parameter's current value. More...
	operator float () const noexcept
	Returns the parameter's current value. More...
AudioParameterFloat &	operator= (float newValue)
	Changes the parameter's current value. More...
Public Member Functions inherited from AudioProcessorParameterWithID
	AudioProcessorParameterWithID (String parameterID, String name)
	Creation of this object requires providing a name and ID which will be constant for its lifetime. More...
	~AudioProcessorParameterWithID ()
	Destructor. More...
Public Member Functions inherited from AudioProcessorParameter
	AudioProcessorParameter () noexcept
virtual	~AudioProcessorParameter ()
	Destructor. More...
void	setValueNotifyingHost (float newValue)
	Your filter can call this when it needs to change one of its parameters. More...
void	beginChangeGesture ()
	Sends a signal to the host to tell it that the user is about to start changing this parameter. More...
void	endChangeGesture ()
	Tells the host that the user has finished changing this parameter. More...
virtual bool	isOrientationInverted () const
	This can be overridden to tell the host that this parameter operates in the reverse direction. More...
virtual bool	isAutomatable () const
	Returns true if the host can automate this parameter. More...
virtual bool	isMetaParameter () const
	Should return true if this parameter is a "meta" parameter. More...
int	getParameterIndex () const noexcept
	Returns the index of this parameter in its parent processor's parameter list. More...

Public Attributes
NormalisableRange< float >	range
	Provides access to the parameter's range. More...
Public Attributes inherited from AudioProcessorParameterWithID
const String	paramID
	Provides access to the parameter's ID string. More...
const String	name
	Provides access to the parameter's name. More...

Detailed Description

A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto a given NormalisableRange.

See also

AudioParameterInt, AudioParameterBool, AudioParameterChoice

Constructor & Destructor Documentation

AudioParameterFloat::AudioParameterFloat	(	String	parameterID,
		String	name,
		NormalisableRange< float >	normalisableRange,
		float	defaultValue
	)

Creates a AudioParameterFloat with an ID, name, and range.

On creation, its value is set to the default value.

AudioParameterFloat::AudioParameterFloat	(	String	parameterID,
		String	name,
		float	minValue,
		float	maxValue,
		float	defaultValue
	)

Creates a AudioParameterFloat with an ID, name, and range.

On creation, its value is set to the default value. For control over skew factors, you can use the other constructor and provide a NormalisableRange.

AudioParameterFloat::~AudioParameterFloat

(

)

Destructor.

Member Function Documentation

float AudioParameterFloat::get ( ) const

noexcept

Returns the parameter's current value.

AudioParameterFloat::operator float ( ) const

noexcept

Returns the parameter's current value.

AudioParameterFloat& AudioParameterFloat::operator=

(

float

newValue

)

Changes the parameter's current value.

Member Data Documentation

NormalisableRange<float> AudioParameterFloat::range

Provides access to the parameter's range.

---

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

• juce_AudioParameterFloat.h