juce::SmoothedValueBase< SmoothedValueType > Class Template Reference

A base class for the smoothed value classes. More...

Inheritance diagram for juce::SmoothedValueBase< SmoothedValueType >:

Public Types
using	FloatType = typename FloatTypeHelper< SmoothedValueType >::Type

Public Member Functions
	SmoothedValueBase ()=default
	Constructor.
bool	isSmoothing () const noexcept
	Returns true if the current value is currently being interpolated.
FloatType	getCurrentValue () const noexcept
	Returns the current value of the ramp.
FloatType	getTargetValue () const noexcept
	Returns the target value towards which the smoothed value is currently moving.
void	setCurrentAndTargetValue (FloatType newValue)
	Sets the current value and the target value.
void	applyGain (FloatType *samples, int numSamples) noexcept
	Applies a smoothed gain to a stream of samples S[i] *= gain.
void	applyGain (FloatType *samplesOut, const FloatType *samplesIn, int numSamples) noexcept
	Computes output as a smoothed gain applied to a stream of samples.
void	applyGain (AudioBuffer< FloatType > &buffer, int numSamples) noexcept
	Applies a smoothed gain to a buffer.
int	getNumSamplesToReachTarget () const noexcept
	Returns the number of samples remaining to reach the target value.

Protected Attributes
FloatType	currentValue = 0
FloatType	target = currentValue
int	countdown = 0

Detailed Description

template<typename SmoothedValueType>
class juce::SmoothedValueBase< SmoothedValueType >

A base class for the smoothed value classes.

This class is used to provide common functionality to the SmoothedValue and dsp::LogRampedValue classes.

Member Typedef Documentation

FloatType

template<typename SmoothedValueType >

using juce::SmoothedValueBase< SmoothedValueType >::FloatType = typename FloatTypeHelper<SmoothedValueType>::Type

Constructor & Destructor Documentation

SmoothedValueBase()

template<typename SmoothedValueType >

juce::SmoothedValueBase< SmoothedValueType >::SmoothedValueBase ( )

default

Constructor.

Member Function Documentation

isSmoothing()

template<typename SmoothedValueType >

bool juce::SmoothedValueBase< SmoothedValueType >::isSmoothing ( ) const

inlinenoexcept

Returns true if the current value is currently being interpolated.

References juce::SmoothedValueBase< SmoothedValueType >::countdown.

Referenced by juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), and juce::dsp::Oscillator< SampleType >::process().

getCurrentValue()

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::getCurrentValue ( ) const

inlinenoexcept

Returns the current value of the ramp.

References juce::SmoothedValueBase< SmoothedValueType >::currentValue.

getTargetValue()

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::getTargetValue ( ) const

inlinenoexcept

Returns the target value towards which the smoothed value is currently moving.

References juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::dsp::Oscillator< SampleType >::getFrequency().

setCurrentAndTargetValue()

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue ( FloatType  newValue )

inline

Sets the current value and the target value.

Parameters

newValue

the new value to take

References juce::SmoothedValueBase< SmoothedValueType >::countdown, juce::SmoothedValueBase< SmoothedValueType >::currentValue, and juce::SmoothedValueBase< SmoothedValueType >::target.

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::reset(), juce::dsp::Oscillator< SampleType >::setFrequency(), juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue(), and juce::SmoothedValue< FloatType, SmoothingType >::skip().

applyGain() [1/3]

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::applyGain ( FloatType *  samples, int  numSamples  )

inlinenoexcept

Applies a smoothed gain to a stream of samples S[i] *= gain.

Parameters

samples	Pointer to a raw array of samples
numSamples	Length of array of samples

References juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

applyGain() [2/3]

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::applyGain ( FloatType *  samplesOut, const FloatType *  samplesIn, int  numSamples  )

inlinenoexcept

Computes output as a smoothed gain applied to a stream of samples.

Sout[i] = Sin[i] * gain

Parameters

samplesOut	A pointer to a raw array of output samples
samplesIn	A pointer to a raw array of input samples
numSamples	The length of the array of samples

References juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

applyGain() [3/3]

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::applyGain ( AudioBuffer< FloatType > &  buffer, int  numSamples  )

inlinenoexcept

Applies a smoothed gain to a buffer.

References juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), jassert, and juce::SmoothedValueBase< SmoothedValueType >::target.

getNumSamplesToReachTarget()

template<typename SmoothedValueType >

int juce::SmoothedValueBase< SmoothedValueType >::getNumSamplesToReachTarget ( ) const

inlinenoexcept

Returns the number of samples remaining to reach the target value.

References juce::SmoothedValueBase< SmoothedValueType >::countdown.

Member Data Documentation

currentValue

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::currentValue = 0

protected

Referenced by juce::SmoothedValueBase< SmoothedValueType >::getCurrentValue(), juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::skip(), and juce::SmoothedValue< FloatType, SmoothingType >::SmoothedValue().

target

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::target = currentValue

protected

Referenced by juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValueBase< SmoothedValueType >::applyGain(), juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), juce::SmoothedValueBase< SmoothedValueType >::getTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::reset(), juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::skip(), and juce::SmoothedValue< FloatType, SmoothingType >::SmoothedValue().

countdown

template<typename SmoothedValueType >

int juce::SmoothedValueBase< SmoothedValueType >::countdown = 0

protected

Referenced by juce::SmoothedValue< FloatType, SmoothingType >::getNextValue(), juce::SmoothedValueBase< SmoothedValueType >::getNumSamplesToReachTarget(), juce::SmoothedValueBase< SmoothedValueType >::isSmoothing(), juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue(), juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue(), and juce::SmoothedValue< FloatType, SmoothingType >::skip().

---

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

• juce_audio_basics/utilities/juce_SmoothedValue.h