Inheritance diagram for tracktion::engine::StepModifier:

Classes
struct	Assignment

struct	StepModifierTimer

Public Types
enum	{ maxNumSteps }

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 &)

void	initialise () override
	Call this once after construction to connect it to the audio graph.

float	getCurrentValue () override
	Must return the current value of the modifier.

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.

ProcessingPosition	getProcessingPosition () override
	Should return the position in the plugin chain that this Modifier should be processed.

void	applyToBuffer (const PluginRenderContext &) override
	Sub classes should implement this to process the Modifier.

juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.

virtual void	initialise ()=0
	Call this once after construction to connect it to the audio graph.

virtual void	initialise (double, int)
	Sub classes should implement this to initialise the Modifier.

Public Member Functions inherited from tracktion::engine::Modifier
	Modifier (Edit &, const juce::ValueTree &)
	Creates a Modifier for a given state.

	~Modifier () override
	Destructor.

void	remove ()
	Removes this Modifier from its parent Track.

virtual juce::StringArray	getMidiInputNames ()
	Can return an array of names represeting MIDI inputs.

virtual juce::StringArray	getAudioInputNames ()
	Can return an array of names represeting audio inputs.

virtual void	deinitialise ()
	Sub classes should implement this to deinitialise the Modifier.

bool	baseClassNeedsInitialising () const noexcept
	Returns true if the Modifier needs initialising.

void	baseClassInitialise (double sampleRate, int blockSizeSamples)
	Initialises the Modifier.

void	baseClassDeinitialise ()
	Deinitialises the Modifier.

void	baseClassApplyToBuffer (const PluginRenderContext &)
	Updates internal value history and calls the subclass's applyToBuffer method.

TimePosition	getCurrentTime () const
	Returns the edit time of the current value.

float	getValueAt (TimeDuration numSecondsBeforeNow) const
	Returns the value of the at a given time in the past.

std::vector< float >	getValues (TimeDuration numSecondsBeforeNow) const
	Returns a vector of previous sample values.

double	getSampleRate () const
	Returns the sample rate the Modifier has been initialised with.

void	selectableAboutToBeDeleted () override
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.

Public Member Functions inherited from tracktion::engine::AutomatableEditItem
	AutomatableEditItem (Edit &, const juce::ValueTree &)

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	visitAllAutomatableParams (const std::function< void(AutomatableParameter &)> &visit) 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.

void	updateParameterStreams (TimePosition)
	Updates all the parameter streams to their positions at this time.

void	updateActiveParameters ()
	Iterates all the parameters to find out which ones need to be automated.

void	resetRecordingStatus ()
	Marks the end of an automation recording stream.

Public Member Functions inherited from tracktion::engine::EditItem
	EditItem (EditItemID, Edit &)

Public Member Functions inherited from tracktion::engine::Selectable
virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.

virtual void	changed ()
	This should be called to send a change notification to any SelectableListeners that are registered with this object.

void	addListener (SelectableListener *)

void	removeListener (SelectableListener *)

void	addSelectableListener (SelectableListener *)

void	removeSelectableListener (SelectableListener *)

void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions.

void	deselect ()

void	propertiesChanged ()

void	notifyListenersOfDeletion ()

WeakRef	getWeakRef ()

Public Member Functions inherited from juce::ReferenceCountedObject
void	incReferenceCount () noexcept

void	decReferenceCount () noexcept

bool	decReferenceCountWithoutDeleting () noexcept

int	getReferenceCount () const noexcept

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.

juce::CachedValue< juce::Colour >	colour
	Colour property.

juce::CachedValue< float >	enabled
	Enabled property.

AutomatableParameter::Ptr	enabledParam
	Parameter to change the enabled state.

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.

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.

Static Public Attributes inherited from tracktion::engine::Modifier
static constexpr TimeDuration	maxHistoryTime
	The max number of seconds of modifier value history that is stored.

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.

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.

void	restoreChangedParametersFromState ()
	Restores the value of any explicitly set parameters.

Protected Member Functions inherited from juce::ReferenceCountedObject
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept

	ReferenceCountedObject (ReferenceCountedObject &&) noexcept

ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept

ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept

void	resetReferenceCount () noexcept

Detailed Description

Definition at line 15 of file tracktion_StepModifier.h.

Member Typedef Documentation

◆ Array

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

Definition at line 24 of file tracktion_StepModifier.h.

◆ Ptr

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

Definition at line 23 of file tracktion_StepModifier.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 33 of file tracktion_StepModifier.h.

Constructor & Destructor Documentation

◆ StepModifier()

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

Definition at line 103 of file tracktion_StepModifier.cpp.

◆ ~StepModifier()

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

override

Definition at line 155 of file tracktion_StepModifier.cpp.

Member Function Documentation

◆ applyToBuffer()

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

overridevirtual

Sub classes should implement this to process the Modifier.

Reimplemented from tracktion::engine::Modifier.

Definition at line 208 of file tracktion_StepModifier.cpp.

◆ createAssignment()

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

overridevirtual

Must return a new ModifierAssignment for a given state.

Implements tracktion::engine::Modifier.

Definition at line 203 of file tracktion_StepModifier.cpp.

◆ getCurrentStep()

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

noexcept

Definition at line 198 of file tracktion_StepModifier.cpp.

◆ getCurrentValue()

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

overridevirtual

Must return the current value of the modifier.

See also: getValueAt, getValues

Implements tracktion::engine::Modifier.

Definition at line 177 of file tracktion_StepModifier.cpp.

◆ getName()

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

overridevirtual

Implements tracktion::engine::EditItem.

Definition at line 30 of file tracktion_StepModifier.h.

◆ 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.

Definition at line 41 of file tracktion_StepModifier.h.

◆ getSelectableDescription()

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

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 242 of file tracktion_StepModifier.cpp.

◆ getStep()

float tracktion::engine::StepModifier::getStep ( int step ) const

Definition at line 183 of file tracktion_StepModifier.cpp.

◆ 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.

Definition at line 168 of file tracktion_StepModifier.cpp.

◆ 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	(	double	,
		int
	)

virtual

Sub classes should implement this to initialise the Modifier.

Reimplemented from tracktion::engine::Modifier.

Definition at line 81 of file tracktion_Modifier.h.

◆ setStep()

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

Definition at line 189 of file tracktion_StepModifier.cpp.

Member Data Documentation

◆ depth

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

Definition at line 61 of file tracktion_StepModifier.h.

◆ depthParam

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

Definition at line 63 of file tracktion_StepModifier.h.

◆ numSteps

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

Definition at line 61 of file tracktion_StepModifier.h.

◆ numStepsParam

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

Definition at line 63 of file tracktion_StepModifier.h.

◆ rate

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

Definition at line 61 of file tracktion_StepModifier.h.

◆ rateParam

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

Definition at line 63 of file tracktion_StepModifier.h.

◆ rateType

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

Definition at line 61 of file tracktion_StepModifier.h.

◆ rateTypeParam

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

Definition at line 63 of file tracktion_StepModifier.h.

◆ syncType

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

Definition at line 61 of file tracktion_StepModifier.h.

◆ syncTypeParam

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

Definition at line 63 of file tracktion_StepModifier.h.

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

tracktion_engine/model/automation/modifiers/tracktion_StepModifier.h
tracktion_engine/model/automation/modifiers/tracktion_StepModifier.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Array

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ StepModifier()

◆ ~StepModifier()

Member Function Documentation

◆ applyToBuffer()

◆ createAssignment()

◆ getCurrentStep()

◆ getCurrentValue()

◆ getName()

◆ getProcessingPosition()

◆ getSelectableDescription()

◆ getStep()

◆ initialise() [1/3]

◆ initialise() [2/3]

◆ initialise() [3/3]

◆ setStep()

Member Data Documentation

◆ depth

◆ depthParam

◆ numSteps

◆ numStepsParam

◆ rate

◆ rateParam

◆ rateType

◆ rateTypeParam

◆ syncType

◆ syncTypeParam