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

#include <juce_SmoothedValue.h>

Inheritance diagram for juce::SmoothedValueBase< SmoothedValueType >:

[legend]

Collaboration diagram for juce::SmoothedValueBase< SmoothedValueType >:

[legend]

Classes
struct	FloatTypeHelper

struct	FloatTypeHelper< SmoothedValueClass< FloatType > >

struct	FloatTypeHelper< SmoothedValueClass< FloatType, SmoothingType > >

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

Public Member Functions
	SmoothedValueBase ()=default
	Constructor. More...

void	applyGain (AudioBuffer< FloatType > &buffer, int numSamples) noexcept
	Applies a smoothed gain to a buffer. More...

void	applyGain (FloatType *samples, int numSamples) noexcept
	Applies a smoothed gain to a stream of samples S[i] *= gain. More...

void	applyGain (FloatType samplesOut, const FloatType samplesIn, int numSamples) noexcept
	Computes output as a smoothed gain applied to a stream of samples. More...

FloatType	getCurrentValue () const noexcept
	Returns the current value of the ramp. More...

FloatType	getTargetValue () const noexcept
	Returns the target value towards which the smoothed value is currently moving. More...

bool	isSmoothing () const noexcept
	Returns true if the current value is currently being interpolated. More...

void	setCurrentAndTargetValue (FloatType newValue)
	Sets the current value and the target value. More...

Protected Attributes
int	countdown = 0

FloatType	currentValue = 0

FloatType	target = currentValue

Private Member Functions
FloatType	getNextSmoothedValue () noexcept

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.

@tags{Audio}

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

◆ applyGain() [1/3]

template<typename SmoothedValueType >

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

inlinenoexcept

Applies a smoothed gain to a buffer.

◆ applyGain() [2/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

◆ applyGain() [3/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

◆ getCurrentValue()

template<typename SmoothedValueType >

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

inlinenoexcept

Returns the current value of the ramp.

◆ getNextSmoothedValue()

template<typename SmoothedValueType >

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

inlineprivatenoexcept

Referenced by juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::applyGain().

◆ getTargetValue()

template<typename SmoothedValueType >

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

inlinenoexcept

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

Referenced by juce::dsp::Bias< FloatType >::getBias(), juce::dsp::Oscillator< SampleType >::getFrequency(), and juce::dsp::Gain< FloatType >::getGainLinear().

◆ isSmoothing()

template<typename SmoothedValueType >

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

inlinenoexcept

Returns true if the current value is currently being interpolated.

Referenced by juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::applyGain(), juce::dsp::Gain< FloatType >::isSmoothing(), and juce::dsp::Oscillator< SampleType >::process().

◆ 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

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

Member Data Documentation

◆ countdown

template<typename SmoothedValueType >

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

protected

Referenced by juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::isSmoothing(), and juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::setCurrentAndTargetValue().

◆ currentValue

template<typename SmoothedValueType >

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

protected

Referenced by juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::getCurrentValue(), and juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::setCurrentAndTargetValue().

◆ target

template<typename SmoothedValueType >

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

protected

Referenced by juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::applyGain(), juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::getTargetValue(), and juce::SmoothedValueBase< SmoothedValue< SampleType, ValueSmoothingTypes::Linear > >::setCurrentAndTargetValue().

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

juce_SmoothedValue.h

Classes

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ FloatType

Constructor & Destructor Documentation

◆ SmoothedValueBase()

Member Function Documentation

◆ applyGain() [1/3]

◆ applyGain() [2/3]

◆ applyGain() [3/3]

◆ getCurrentValue()

◆ getNextSmoothedValue()

◆ getTargetValue()

◆ isSmoothing()

◆ setCurrentAndTargetValue()

Member Data Documentation

◆ countdown

◆ currentValue

◆ target

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