juce::AudioProcessorValueTreeState::ParameterAdapter Class Reference

Inheritance diagram for juce::AudioProcessorValueTreeState::ParameterAdapter:

Classes
class	LockedListeners

Public Member Functions
	ParameterAdapter (RangedAudioParameter &parameterIn)
	~ParameterAdapter () override
void	addListener (Listener *l)
void	removeListener (Listener *l)
RangedAudioParameter &	getParameter ()
const RangedAudioParameter &	getParameter () const
const NormalisableRange< float > &	getRange () const
float	getDenormalisedDefaultValue () const
void	setDenormalisedValue (float value)
float	getDenormalisedValueForText (const String &text) const
String	getTextForDenormalisedValue (float value) const
float	getDenormalisedValue () const
std::atomic< float > &	getRawDenormalisedValue ()
bool	flushToTree (const Identifier &key, UndoManager *um)

Public Attributes
ValueTree	tree

Private Types
using	Listener = AudioProcessorValueTreeState::Listener

Private Member Functions
void	parameterGestureChanged (int, bool) override
void	parameterValueChanged (int, float) override
float	denormalise (float normalised) const
float	normalise (float denormalised) const
void	setNormalisedValue (float value)
Private Member Functions inherited from juce::AudioProcessorParameter::Listener
virtual	~Listener ()=default

Private Attributes
RangedAudioParameter &	parameter
LockedListeners	listeners
std::atomic< float >	unnormalisedValue { 0.0f }
std::atomic< bool >	needsUpdate { true }
std::atomic< bool >	listenersNeedCalling { true }
bool	ignoreParameterChangedCallbacks { false }

Member Typedef Documentation

Listener

using juce::AudioProcessorValueTreeState::ParameterAdapter::Listener = AudioProcessorValueTreeState::Listener

private

Constructor & Destructor Documentation

ParameterAdapter()

juce::AudioProcessorValueTreeState::ParameterAdapter::ParameterAdapter ( RangedAudioParameter & parameterIn )

inlineexplicit

~ParameterAdapter()

juce::AudioProcessorValueTreeState::ParameterAdapter::~ParameterAdapter ( )

inlineoverride

Member Function Documentation

addListener()

void juce::AudioProcessorValueTreeState::ParameterAdapter::addListener ( Listener * l )

inline

denormalise()

float juce::AudioProcessorValueTreeState::ParameterAdapter::denormalise ( float normalised ) const

inlineprivate

flushToTree()

bool juce::AudioProcessorValueTreeState::ParameterAdapter::flushToTree ( const Identifier & key, UndoManager * um )

inline

getDenormalisedDefaultValue()

float juce::AudioProcessorValueTreeState::ParameterAdapter::getDenormalisedDefaultValue ( ) const

inline

getDenormalisedValue()

float juce::AudioProcessorValueTreeState::ParameterAdapter::getDenormalisedValue ( ) const

inline

getDenormalisedValueForText()

float juce::AudioProcessorValueTreeState::ParameterAdapter::getDenormalisedValueForText ( const String & text ) const

inline

getParameter() [1/2]

RangedAudioParameter & juce::AudioProcessorValueTreeState::ParameterAdapter::getParameter ( )

inline

getParameter() [2/2]

const RangedAudioParameter & juce::AudioProcessorValueTreeState::ParameterAdapter::getParameter ( ) const

inline

getRange()

const NormalisableRange< float > & juce::AudioProcessorValueTreeState::ParameterAdapter::getRange ( ) const

inline

getRawDenormalisedValue()

std::atomic< float > & juce::AudioProcessorValueTreeState::ParameterAdapter::getRawDenormalisedValue ( )

inline

getTextForDenormalisedValue()

String juce::AudioProcessorValueTreeState::ParameterAdapter::getTextForDenormalisedValue ( float value ) const

inline

normalise()

float juce::AudioProcessorValueTreeState::ParameterAdapter::normalise ( float denormalised ) const

inlineprivate

parameterGestureChanged()

void juce::AudioProcessorValueTreeState::ParameterAdapter::parameterGestureChanged ( int parameterIndex, bool gestureIsStarting )

inlineoverrideprivatevirtual

Indicates that a parameter change gesture has started.

E.g. if the user is dragging a slider, this would be called with gestureIsStarting being true when they first press the mouse button, and it will be called again with gestureIsStarting being false when they release it.

IMPORTANT NOTE: This will be called synchronously, and many audio processors will call it during their audio callback. This means that not only has your handler code got to be completely thread-safe, but it's also got to be VERY fast, and avoid blocking. If you need to handle this event on your message thread, use this callback to trigger an AsyncUpdater or ChangeBroadcaster which you can respond to later on the message thread.

Implements juce::AudioProcessorParameter::Listener.

parameterValueChanged()

void juce::AudioProcessorValueTreeState::ParameterAdapter::parameterValueChanged ( int parameterIndex, float newValue )

inlineoverrideprivatevirtual

Receives a callback when a parameter has been changed.

IMPORTANT NOTE: This will be called synchronously when a parameter changes, and many audio processors will change their parameter during their audio callback. This means that not only has your handler code got to be completely thread-safe, but it's also got to be VERY fast, and avoid blocking. If you need to handle this event on your message thread, use this callback to trigger an AsyncUpdater or ChangeBroadcaster which you can respond to on the message thread.

Implements juce::AudioProcessorParameter::Listener.

removeListener()

void juce::AudioProcessorValueTreeState::ParameterAdapter::removeListener ( Listener * l )

inline

setDenormalisedValue()

void juce::AudioProcessorValueTreeState::ParameterAdapter::setDenormalisedValue ( float value )

inline

setNormalisedValue()

void juce::AudioProcessorValueTreeState::ParameterAdapter::setNormalisedValue ( float value )

inlineprivate

Member Data Documentation

ignoreParameterChangedCallbacks

bool juce::AudioProcessorValueTreeState::ParameterAdapter::ignoreParameterChangedCallbacks { false }

private

listeners

LockedListeners juce::AudioProcessorValueTreeState::ParameterAdapter::listeners

private

listenersNeedCalling

std::atomic<bool> juce::AudioProcessorValueTreeState::ParameterAdapter::listenersNeedCalling { true }

private

needsUpdate

std::atomic<bool> juce::AudioProcessorValueTreeState::ParameterAdapter::needsUpdate { true }

private

parameter

RangedAudioParameter& juce::AudioProcessorValueTreeState::ParameterAdapter::parameter

private

tree

ValueTree juce::AudioProcessorValueTreeState::ParameterAdapter::tree

unnormalisedValue

std::atomic<float> juce::AudioProcessorValueTreeState::ParameterAdapter::unnormalisedValue { 0.0f }

private

---

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

• /home/runner/work/lmms/lmms/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.cpp