Aviate::ParameterAutomationSequence< T > Class Template Reference

This class allows you to create a sequence of automations where each stage has it's own configuration of start, end, function values. More...

#include <LibBasicFunctions.h>

Public Member Functions
	ParameterAutomationSequence (int numStages)
	Construction an automation sequence with the specified number of stages. More...
virtual	~ParameterAutomationSequence ()
	destructor
void	setupParameter (int index, T startValue, T endValue, size_t durationSamples, typename ParameterAutomation< T >::Function function)
	Configure one of the stages in the automation sequence. More...
void	setupParameter (int index, T startValue, T endValue, float durationMilliseconds, typename ParameterAutomation< T >::Function function)
	Configure one of the stages in the automation sequence. More...
void	trigger ()
	Trigger a the automation sequence until numStages is reached or a Function is ParameterAutomation<T>::Function::NOT_CONFIGURED.
T	getNextValue ()
	get the next value in the automation sequence More...
bool	isFinished ()
	check if the automation is finished More...

Detailed Description

template<typename T>
class Aviate::ParameterAutomationSequence< T >

This class allows you to create a sequence of automations where each stage has it's own configuration of start, end, function values.

Template Parameters

T	the type of parameter to automate

Constructor & Destructor Documentation

ParameterAutomationSequence()

template<typename T >

Aviate::ParameterAutomationSequence< T >::ParameterAutomationSequence

(

int

numStages

)

Construction an automation sequence with the specified number of stages.

Parameters

numStages

the number of stages in the sequence

Member Function Documentation

getNextValue()

template<typename T >

T Aviate::ParameterAutomationSequence< T >::getNextValue

(

)

get the next value in the automation sequence

Returns

the next value

isFinished()

template<typename T >

bool Aviate::ParameterAutomationSequence< T >::isFinished

(

)

check if the automation is finished

Returns

true if finished, otherwise false

setupParameter() [1/2]

template<typename T >

void Aviate::ParameterAutomationSequence< T >::setupParameter	(	int	index,
		T	startValue,
		T	endValue,
		float	durationMilliseconds,
		typename ParameterAutomation< T >::Function	function
	)

Configure one of the stages in the automation sequence.

Parameters

index	the stage index to configure, starting from zero
startValue	after reset, parameter automation start from this value
endValue	after the automation duration, paramter will finish at this value
durationMilliseconds	number of samples to transition from startValue to endValue
function	select which automation curve (function) to use

setupParameter() [2/2]

template<typename T >

void Aviate::ParameterAutomationSequence< T >::setupParameter	(	int	index,
		T	startValue,
		T	endValue,
		size_t	durationSamples,
		typename ParameterAutomation< T >::Function	function
	)

Configure one of the stages in the automation sequence.

Parameters

index	the stage index to configure, starting from zero
startValue	after reset, parameter automation start from this value
endValue	after the automation duration, paramter will finish at this value
durationSamples	length of the automation sequence in samples
function	select which automation curve (function) to use

---

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

• inc/LibBasicFunctions.h