SlewLimitModifier Class Reference

A WavetableComponent that applies slew-rate limiting to a wave’s time-domain signal. More...

#include <slew_limit_modifier.h>

Inheritance diagram for SlewLimitModifier:

Classes
class	SlewLimitModifierKeyframe
	A keyframe class holding parameters for slew-rate limits at a given position. More...

Public Member Functions
	SlewLimitModifier ()
	Constructs a SlewLimitModifier.
virtual	~SlewLimitModifier ()
WavetableKeyframe *	createKeyframe (int position) override
	Creates a new keyframe at a given position.
void	render (vital::WaveFrame *wave_frame, float position) override
	Renders the waveform at a given position into a WaveFrame.
WavetableComponentFactory::ComponentType	getType () override
	Returns the type of this WavetableComponent.
SlewLimitModifierKeyframe *	getKeyframe (int index)
	Retrieves a SlewLimitModifierKeyframe by index.
Public Member Functions inherited from WavetableComponent
	WavetableComponent ()
	Constructs a WavetableComponent with a default linear interpolation style.
virtual	~WavetableComponent ()
virtual json	stateToJson ()
	Serializes the component’s state and all keyframes to a JSON object.
virtual void	jsonToState (json data)
	Restores the component’s state from a JSON object.
virtual void	prerender ()
	Called before rendering to perform any needed precomputation.
virtual bool	hasKeyframes ()
	Indicates whether this component relies on multiple keyframes.
void	reset ()
	Clears all keyframes and inserts a default one at position 0.
void	interpolate (WavetableKeyframe *dest, float position)
	Interpolates a destination keyframe at a given position.
WavetableKeyframe *	insertNewKeyframe (int position)
	Inserts a new keyframe at the given position, creating and sorting it into the array.
void	reposition (WavetableKeyframe *keyframe)
	Repositions a keyframe in the keyframe list after its position changed.
void	remove (WavetableKeyframe *keyframe)
	Removes a specific keyframe from the component.
int	numFrames () const
	Gets the number of keyframes.
int	indexOf (WavetableKeyframe *keyframe) const
	Finds the index of a given keyframe.
WavetableKeyframe *	getFrameAt (int index) const
	Gets a keyframe by index.
int	getIndexFromPosition (int position) const
	Finds the insertion index for a given position to keep keyframes sorted.
WavetableKeyframe *	getFrameAtPosition (int position)
	Gets a keyframe by position if one matches exactly, or nullptr otherwise.
int	getLastKeyframePosition ()
	Gets the highest position among all keyframes.
void	setInterpolationStyle (InterpolationStyle type)
	Sets the global interpolation style.
InterpolationStyle	getInterpolationStyle () const
	Gets the current global interpolation style.

Protected Attributes
SlewLimitModifierKeyframe	compute_frame_
	A keyframe used for intermediate computations.
Protected Attributes inherited from WavetableComponent
std::vector< std::unique_ptr< WavetableKeyframe > >	keyframes_
	The list of keyframes sorted by position.
InterpolationStyle	interpolation_style_
	Current interpolation style (none, linear, cubic).

Additional Inherited Members
Public Types inherited from WavetableComponent
enum	InterpolationStyle { kNone , kLinear , kCubic , kNumInterpolationStyles }
	Defines how interpolation is performed between keyframes. More...

Detailed Description

A WavetableComponent that applies slew-rate limiting to a wave’s time-domain signal.

SlewLimitModifier imposes a maximum rate at which the waveform’s amplitude can change between samples. By limiting the upward and downward rate of change (slew), it can soften transients and produce smoother waveform transitions. Users can control separate upward and downward slew limits.

Constructor & Destructor Documentation

SlewLimitModifier()

SlewLimitModifier::SlewLimitModifier ( )

inline

Constructs a SlewLimitModifier.

By default, no slew limits are applied until a keyframe is configured.

~SlewLimitModifier()

virtual SlewLimitModifier::~SlewLimitModifier ( )

inlinevirtual

Member Function Documentation

createKeyframe()

WavetableKeyframe * SlewLimitModifier::createKeyframe ( int position )

overridevirtual

Creates a new keyframe at a given position.

Implemented by subclasses to produce a keyframe type suited to their functionality.

Parameters

position

The wavetable frame index (0 to kNumOscillatorWaveFrames-1).

Returns

A pointer to the newly created WavetableKeyframe.

Implements WavetableComponent.

getKeyframe()

SlewLimitModifier::SlewLimitModifierKeyframe * SlewLimitModifier::getKeyframe

(

int

index

)

Retrieves a SlewLimitModifierKeyframe by index.

Parameters

index

The index of the keyframe to retrieve.

Returns

A pointer to the corresponding SlewLimitModifierKeyframe.

getType()

WavetableComponentFactory::ComponentType SlewLimitModifier::getType ( )

overridevirtual

Returns the type of this WavetableComponent.

Used to identify the specific component for serialization and UI mapping.

Returns

The component type enumerated in WavetableComponentFactory.

Implements WavetableComponent.

render()

void SlewLimitModifier::render ( vital::WaveFrame * wave_frame, float position )

overridevirtual

Renders the waveform at a given position into a WaveFrame.

Uses interpolation between keyframes based on the current interpolation style to produce a waveform for the given position.

Parameters

wave_frame	The WaveFrame to fill with the resulting waveform.
position	The position along the wavetable dimension [0, kNumOscillatorWaveFrames-1].

Implements WavetableComponent.

Member Data Documentation

compute_frame_

SlewLimitModifierKeyframe SlewLimitModifier::compute_frame_

protected

A keyframe used for intermediate computations.

---

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

• /Users/davidvogel/repos/VitalHelp/src/common/wavetable/slew_limit_modifier.h
• /Users/davidvogel/repos/VitalHelp/src/common/wavetable/slew_limit_modifier.cpp