tracktion::engine::StepModifier Class Reference

Inheritance diagram for tracktion::engine::StepModifier:

Classes
struct	Assignment

Public Types
enum	{ maxNumSteps = 64 }
using	Ptr = juce::ReferenceCountedObjectPtr< StepModifier >
using	Array = juce::ReferenceCountedArray< StepModifier >
Public Types inherited from tracktion::engine::Modifier
enum class	ProcessingPosition { none , preFX , postFX }
	Determines the position in the FX chain where the modifier should be processed. More...
using	Ptr = juce::ReferenceCountedObjectPtr< Modifier >
using	Array = juce::ReferenceCountedArray< Modifier >
Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	StepModifier (Edit &, const juce::ValueTree &)
	~StepModifier () override
void	initialise () override
	Call this once after construction to connect it to the audio graph. More...
float	getCurrentValue () override
	Must return the current value of the modifier. More...
juce::String	getName () const override
float	getStep (int step) const
void	setStep (int step, float value)
int	getCurrentStep () const noexcept
AutomatableParameter::ModifierAssignment *	createAssignment (const juce::ValueTree &) override
	Must return a new ModifierAssignment for a given state. More...
ProcessingPosition	getProcessingPosition () override
	Should return the position in the plugin chain that this Modifier should be processed. More...
void	applyToBuffer (const PluginRenderContext &) override
	Sub classes should implement this to process the Modifier. More...
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are. More...
virtual void	initialise ()=0
	Call this once after construction to connect it to the audio graph. More...
virtual void	initialise (double, int)
	Sub classes should implement this to initialise the Modifier. More...
Public Member Functions inherited from tracktion::engine::Modifier
	Modifier (Edit &, const juce::ValueTree &)
	Creates a Modifier for a given state. More...
	~Modifier ()
	Destructor. More...
void	remove ()
	Removes this Modifier from its parent Track. More...
virtual juce::StringArray	getMidiInputNames ()
	Can return an array of names represeting MIDI inputs. More...
virtual juce::StringArray	getAudioInputNames ()
	Can return an array of names represeting audio inputs. More...
virtual void	initialise (double, int)
	Sub classes should implement this to initialise the Modifier. More...
virtual void	deinitialise ()
	Sub classes should implement this to deinitialise the Modifier. More...
bool	baseClassNeedsInitialising () const noexcept
	Returns true if the Modifier needs initialising. More...
void	baseClassInitialise (double sampleRate, int blockSizeSamples)
	Initialises the Modifier. More...
void	baseClassDeinitialise ()
	Deinitialises the Modifier. More...
void	baseClassApplyToBuffer (const PluginRenderContext &)
	Updates internal value history and calls the subclass's applyToBuffer method. More...
TimePosition	getCurrentTime () const
	Returns the edit time of the current value. More...
float	getValueAt (TimeDuration numSecondsBeforeNow) const
	Returns the value of the at a given time in the past. More...
std::vector< float >	getValues (TimeDuration numSecondsBeforeNow) const
	Returns a vector of previous sample values. More...
double	getSampleRate () const
	Returns the sample rate the Modifier has been initialised with. More...
Public Member Functions inherited from tracktion::engine::AutomatableEditItem
	AutomatableEditItem (Edit &, const juce::ValueTree &)
virtual	~AutomatableEditItem ()
virtual void	flushPluginStateToValueTree ()
virtual void	restorePluginStateFromValueTree (const juce::ValueTree &)
juce::Array< AutomatableParameter * >	getAutomatableParameters () const
int	getNumAutomatableParameters () const
AutomatableParameter::Ptr	getAutomatableParameter (int index) const
AutomatableParameter::Ptr	getAutomatableParameterByID (const juce::String &paramID) const
void	deleteParameter (AutomatableParameter *)
void	deleteAutomatableParameters ()
int	indexOfAutomatableParameter (const AutomatableParameter::Ptr &) const
AutomatableParameterTree &	getParameterTree () const
juce::ReferenceCountedArray< AutomatableParameter >	getFlattenedParameterTree () const
void	addParameterListChangeListener (ParameterListChangeListener *)
void	removeParameterListChangeListener (ParameterListChangeListener *)
bool	isAutomationNeeded () const noexcept
void	setAutomatableParamPosition (TimePosition)
bool	isBeingActivelyPlayed () const
virtual void	updateAutomatableParamPosition (TimePosition)
	Updates all the auto params to their positions at this time. More...
void	updateParameterStreams (TimePosition)
	Updates all the parameter streams to their positions at this time. More...
void	updateActiveParameters ()
	Iterates all the parameters to find out which ones need to be automated. More...
void	resetRecordingStatus ()
	Marks the end of an automation recording stream. More...
Public Member Functions inherited from tracktion::engine::EditItem
	EditItem (EditItemID, Edit &)
virtual	~EditItem ()=default
Public Member Functions inherited from tracktion::engine::Selectable
	Selectable ()
virtual	~Selectable ()
virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected. More...
virtual void	changed ()
	This should be called to send a change notification to any SelectableListeners that are registered with this object. More...
virtual void	selectableAboutToBeDeleted ()
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point. More...
void	addSelectableListener (SelectableListener *)
void	removeSelectableListener (SelectableListener *)
void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions. More...
void	deselect ()
void	propertiesChanged ()
void	notifyListenersOfDeletion ()
WeakRef	getWeakRef ()
Public Member Functions inherited from tracktion::engine::AutomatableParameter::ModifierSource
	ModifierSource ()=default
virtual	~ModifierSource ()

Public Attributes
juce::CachedValue< float >	syncType
juce::CachedValue< float >	numSteps
juce::CachedValue< float >	rate
juce::CachedValue< float >	rateType
juce::CachedValue< float >	depth
AutomatableParameter::Ptr	syncTypeParam
AutomatableParameter::Ptr	numStepsParam
AutomatableParameter::Ptr	rateParam
AutomatableParameter::Ptr	rateTypeParam
AutomatableParameter::Ptr	depthParam
Public Attributes inherited from tracktion::engine::Modifier
juce::ValueTree	state
	Modifier internal state. More...
juce::CachedValue< juce::Colour >	colour
	Colour property. More...
juce::CachedValue< float >	enabled
	Enabled property. More...
AutomatableParameter::Ptr	enabledParam
	Parameter to change the enabled state. More...
Public Attributes inherited from tracktion::engine::AutomatableEditItem
juce::ValueTree	elementState
juce::CachedValue< bool >	remapOnTempoChange
Public Attributes inherited from tracktion::engine::EditItem
Edit &	edit
const EditItemID	itemID
	Every EditItem has an ID which is unique within the edit. More...
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Additional Inherited Members
Static Public Member Functions inherited from tracktion::engine::Selectable
static void	initialise ()
static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted. More...
Static Public Attributes inherited from tracktion::engine::Modifier
static constexpr TimeDuration	maxHistoryTime = TimeDuration::fromSeconds (3.0)
	The max number of seconds of modifier value history that is stored. More...
Protected Member Functions inherited from tracktion::engine::Modifier
void	setEditTime (TimePosition newEditTime)
	Subclasses can call this to update the edit time of the current value. More...
Protected Member Functions inherited from tracktion::engine::AutomatableEditItem
virtual void	buildParameterTree () const
void	updateLastPlaybackTime ()
void	clearParameterList ()
void	addAutomatableParameter (const AutomatableParameter::Ptr &)
void	rebuildParameterTree ()
void	saveChangedParametersToState ()
	Saves the explicit value of any parameters that have deviated to the state. More...
void	restoreChangedParametersFromState ()
	Restores the value of any explicitly set parameters. More...

Member Typedef Documentation

Ptr

using tracktion::engine::StepModifier::Ptr = juce::ReferenceCountedObjectPtr<StepModifier>

Array

using tracktion::engine::StepModifier::Array = juce::ReferenceCountedArray<StepModifier>

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
maxNumSteps

Constructor & Destructor Documentation

StepModifier()

tracktion::engine::StepModifier::StepModifier	(	Edit &	,
		const juce::ValueTree &
	)

~StepModifier()

tracktion::engine::StepModifier::~StepModifier ( )

override

Member Function Documentation

initialise() [1/3]

void tracktion::engine::StepModifier::initialise ( )

overridevirtual

Call this once after construction to connect it to the audio graph.

Implements tracktion::engine::Modifier.

getCurrentValue()

float tracktion::engine::StepModifier::getCurrentValue ( )

overridevirtual

Must return the current value of the modifier.

See also

getValueAt, getValues

Implements tracktion::engine::Modifier.

getName()

juce::String tracktion::engine::StepModifier::getName ( ) const

overridevirtual

Implements tracktion::engine::EditItem.

getStep()

float tracktion::engine::StepModifier::getStep

(

int

step

)

const

setStep()

void tracktion::engine::StepModifier::setStep	(	int	step,
		float	value
	)

getCurrentStep()

int tracktion::engine::StepModifier::getCurrentStep ( ) const

noexcept

createAssignment()

AutomatableParameter::ModifierAssignment* tracktion::engine::StepModifier::createAssignment ( const juce::ValueTree &  )

overridevirtual

Must return a new ModifierAssignment for a given state.

Implements tracktion::engine::Modifier.

getProcessingPosition()

ProcessingPosition tracktion::engine::StepModifier::getProcessingPosition ( )

overridevirtual

Should return the position in the plugin chain that this Modifier should be processed.

Reimplemented from tracktion::engine::Modifier.

References tracktion::engine::Modifier::preFX.

applyToBuffer()

void tracktion::engine::StepModifier::applyToBuffer ( const PluginRenderContext &  )

overridevirtual

Sub classes should implement this to process the Modifier.

Reimplemented from tracktion::engine::Modifier.

getSelectableDescription()

juce::String tracktion::engine::StepModifier::getSelectableDescription ( )

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

initialise() [2/3]

virtual void tracktion::engine::Modifier::initialise

virtual

Call this once after construction to connect it to the audio graph.

Implements tracktion::engine::Modifier.

initialise() [3/3]

virtual void tracktion::engine::Modifier::initialise

virtual

Sub classes should implement this to initialise the Modifier.

Implements tracktion::engine::Modifier.

Member Data Documentation

syncType

juce::CachedValue<float> tracktion::engine::StepModifier::syncType

numSteps

juce::CachedValue<float> tracktion::engine::StepModifier::numSteps

rate

juce::CachedValue<float> tracktion::engine::StepModifier::rate

rateType

juce::CachedValue<float> tracktion::engine::StepModifier::rateType

depth

juce::CachedValue<float> tracktion::engine::StepModifier::depth

syncTypeParam

AutomatableParameter::Ptr tracktion::engine::StepModifier::syncTypeParam

numStepsParam

AutomatableParameter::Ptr tracktion::engine::StepModifier::numStepsParam

rateParam

AutomatableParameter::Ptr tracktion::engine::StepModifier::rateParam

rateTypeParam

AutomatableParameter::Ptr tracktion::engine::StepModifier::rateTypeParam

depthParam

AutomatableParameter::Ptr tracktion::engine::StepModifier::depthParam

---

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

• tracktion_StepModifier.h