juce::SmoothedValueBase< SmoothedValueType > Class Template Reference

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

#include "juce_SmoothedValue.h"

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.

Protected Attributes
FloatType	currentValue
FloatType	target
int	countdown

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}

Definition at line 36 of file juce_SmoothedValue.h.

Member Typedef Documentation

FloatType

template<typename SmoothedValueType >

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

Definition at line 55 of file juce_SmoothedValue.h.

Member Function Documentation

applyGain() [1/3]

template<typename SmoothedValueType >

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

noexcept

Applies a smoothed gain to a buffer.

Definition at line 124 of file juce_SmoothedValue.h.

applyGain() [2/3]

template<typename SmoothedValueType >

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

noexcept

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

Definition at line 87 of file juce_SmoothedValue.h.

applyGain() [3/3]

template<typename SmoothedValueType >

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

noexcept

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

Definition at line 108 of file juce_SmoothedValue.h.

getCurrentValue()

template<typename SmoothedValueType >

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

noexcept

Returns the current value of the ramp.

Definition at line 66 of file juce_SmoothedValue.h.

getTargetValue()

template<typename SmoothedValueType >

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

noexcept

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

Definition at line 70 of file juce_SmoothedValue.h.

isSmoothing()

template<typename SmoothedValueType >

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

noexcept

Returns true if the current value is currently being interpolated.

Definition at line 63 of file juce_SmoothedValue.h.

setCurrentAndTargetValue()

template<typename SmoothedValueType >

void juce::SmoothedValueBase< SmoothedValueType >::setCurrentAndTargetValue

(

FloatType

newValue

)

Sets the current value and the target value.

Parameters

newValue

the new value to take

Definition at line 75 of file juce_SmoothedValue.h.

Member Data Documentation

countdown

template<typename SmoothedValueType >

int juce::SmoothedValueBase< SmoothedValueType >::countdown

protected

Definition at line 165 of file juce_SmoothedValue.h.

currentValue

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::currentValue

protected

Definition at line 163 of file juce_SmoothedValue.h.

target

template<typename SmoothedValueType >

FloatType juce::SmoothedValueBase< SmoothedValueType >::target

protected

Definition at line 164 of file juce_SmoothedValue.h.

---

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

• juce_audio_basics/utilities/juce_SmoothedValue.h