A selection of options available for customising a spring style easing function. More...

#include <juce_Easings.h>

Collaboration diagram for juce::SpringEasingOptions:

Public Member Functions
auto	getAttenuation () const
	Returns the value specified by withAttenuation.

auto	getExtraAttenuationRange () const
	Returns the value specified by withExtraAttenuationRange.

auto	getFrequency () const
	Returns the value specified by withFrequency.

auto	withAttenuation (float newAttenuation) const
	Affects how quickly the oscillations die down.

auto	withExtraAttenuationRange (float newExtraAttenuationRange) const
	Specifies the input value at which an extra non-physical attenuation begins to be applied.

auto	withFrequency (float newFrequency) const
	Specifies the number of oscillations the easing would undergo.

Private Attributes
float	attenuation = 3.0f

float	extraAttenuationRange = 0.25f

float	frequency = 3.0f

Detailed Description

A selection of options available for customising a spring style easing function.

@tags{Animations}

Member Function Documentation

◆ getAttenuation()

auto juce::SpringEasingOptions::getAttenuation ( ) const

inline

Returns the value specified by withAttenuation.

If no value was specified the default value is 3.0f.

See also: withAttenuation

References attenuation.

◆ getExtraAttenuationRange()

auto juce::SpringEasingOptions::getExtraAttenuationRange ( ) const

inline

Returns the value specified by withExtraAttenuationRange.

If no value was specified the default value is 0.25f.

See also: withExtraAttenuationRange

References extraAttenuationRange.

◆ getFrequency()

auto juce::SpringEasingOptions::getFrequency ( ) const

inline

Returns the value specified by withFrequency.

If no value was specified the default value is 3.0f.

See also: withFrequency

References frequency.

◆ withAttenuation()

auto juce::SpringEasingOptions::withAttenuation ( float newAttenuation ) const

inline

Affects how quickly the oscillations die down.

See also: getAttenuation, withFrequency, withExtraAttenuationRange

References attenuation, and juce::withMember().

◆ withExtraAttenuationRange()

auto juce::SpringEasingOptions::withExtraAttenuationRange ( float newExtraAttenuationRange ) const

inline

Specifies the input value at which an extra non-physical attenuation begins to be applied.

The value must be in the range [0.05f, 0.98f].

This ensures that the easing always reaches an output value of 1.0f when the input value is 1.0f. If the attenuation is set sufficiently high this won't have a visible effect.