tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
tracktion::engine::AutomatableEditItem Class Reference

Base class for elements that have some kind of automatable parameters. More...

#include "tracktion_AutomatableEditItem.h"

Inheritance diagram for tracktion::engine::AutomatableEditItem:
tracktion::engine::EditItem tracktion::engine::MacroParameterList tracktion::engine::Modifier tracktion::engine::Plugin tracktion::engine::BreakpointOscillatorModifier tracktion::engine::EnvelopeFollowerModifier tracktion::engine::LFOModifier tracktion::engine::MIDITrackerModifier tracktion::engine::RandomModifier tracktion::engine::StepModifier tracktion::engine::AuxReturnPlugin tracktion::engine::AuxSendPlugin tracktion::engine::ChorusPlugin tracktion::engine::CompressorPlugin tracktion::engine::DelayPlugin tracktion::engine::EqualiserPlugin tracktion::engine::ExternalPlugin tracktion::engine::FourOscPlugin tracktion::engine::FreezePointPlugin tracktion::engine::ImpulseResponsePlugin tracktion::engine::InsertPlugin tracktion::engine::LatencyPlugin tracktion::engine::LevelMeterPlugin tracktion::engine::LowPassPlugin tracktion::engine::MidiModifierPlugin tracktion::engine::MidiPatchBayPlugin tracktion::engine::PatchBayPlugin tracktion::engine::PhaserPlugin tracktion::engine::PitchShiftPlugin tracktion::engine::RackInstance tracktion::engine::ReverbPlugin tracktion::engine::SamplerPlugin tracktion::engine::TextPlugin tracktion::engine::ToneGeneratorPlugin tracktion::engine::VCAPlugin tracktion::engine::VolumeAndPanPlugin

Classes

struct  ParameterListChangeListener
 

Public Member Functions

 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 &)
 
virtual juce::String getName () const =0
 

Public Attributes

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.
 

Protected Member Functions

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.
 

Detailed Description

Base class for elements that have some kind of automatable parameters.

Definition at line 17 of file tracktion_AutomatableEditItem.h.

Constructor & Destructor Documentation

◆ AutomatableEditItem()

tracktion::engine::AutomatableEditItem::AutomatableEditItem ( Edit &  ed,
const juce::ValueTree &  v 
)

Definition at line 14 of file tracktion_AutomatableEditItem.cpp.

◆ ~AutomatableEditItem()

tracktion::engine::AutomatableEditItem::~AutomatableEditItem ( )
override

Definition at line 21 of file tracktion_AutomatableEditItem.cpp.

Member Function Documentation

◆ addAutomatableParameter()

void tracktion::engine::AutomatableEditItem::addAutomatableParameter ( const AutomatableParameter::Ptr &  param)
protected

Definition at line 182 of file tracktion_AutomatableEditItem.cpp.

◆ addParameterListChangeListener()

void tracktion::engine::AutomatableEditItem::addParameterListChangeListener ( ParameterListChangeListener *  l)

Definition at line 281 of file tracktion_AutomatableEditItem.cpp.

◆ buildParameterTree()

void tracktion::engine::AutomatableEditItem::buildParameterTree ( ) const
protectedvirtual

Definition at line 165 of file tracktion_AutomatableEditItem.cpp.

◆ clearParameterList()

void tracktion::engine::AutomatableEditItem::clearParameterList ( )
protected

Definition at line 176 of file tracktion_AutomatableEditItem.cpp.

◆ deleteAutomatableParameters()

void tracktion::engine::AutomatableEditItem::deleteAutomatableParameters ( )

Definition at line 65 of file tracktion_AutomatableEditItem.cpp.

◆ deleteParameter()

void tracktion::engine::AutomatableEditItem::deleteParameter ( AutomatableParameter *  p)

Definition at line 59 of file tracktion_AutomatableEditItem.cpp.

◆ flushPluginStateToValueTree()

void tracktion::engine::AutomatableEditItem::flushPluginStateToValueTree ( )
virtual

Definition at line 26 of file tracktion_AutomatableEditItem.cpp.

◆ getAutomatableParameter()

AutomatableParameter::Ptr tracktion::engine::AutomatableEditItem::getAutomatableParameter ( int  index) const

Definition at line 30 of file tracktion_AutomatableEditItem.h.

◆ getAutomatableParameterByID()

AutomatableParameter::Ptr tracktion::engine::AutomatableEditItem::getAutomatableParameterByID ( const juce::String &  paramID) const

Definition at line 50 of file tracktion_AutomatableEditItem.cpp.

◆ getAutomatableParameters()

juce::Array< AutomatableParameter * > tracktion::engine::AutomatableEditItem::getAutomatableParameters ( ) const

Definition at line 32 of file tracktion_AutomatableEditItem.cpp.

◆ getFlattenedParameterTree()

juce::ReferenceCountedArray< AutomatableParameter > tracktion::engine::AutomatableEditItem::getFlattenedParameterTree ( ) const

Definition at line 113 of file tracktion_AutomatableEditItem.cpp.

◆ getNumAutomatableParameters()

int tracktion::engine::AutomatableEditItem::getNumAutomatableParameters ( ) const

Definition at line 39 of file tracktion_AutomatableEditItem.cpp.

◆ getParameterTree()

AutomatableParameterTree & tracktion::engine::AutomatableEditItem::getParameterTree ( ) const

Definition at line 101 of file tracktion_AutomatableEditItem.cpp.

◆ indexOfAutomatableParameter()

int tracktion::engine::AutomatableEditItem::indexOfAutomatableParameter ( const AutomatableParameter::Ptr &  param) const

Definition at line 96 of file tracktion_AutomatableEditItem.cpp.

◆ isAutomationNeeded()

bool tracktion::engine::AutomatableEditItem::isAutomationNeeded ( ) const
noexcept

Definition at line 53 of file tracktion_AutomatableEditItem.h.

◆ isBeingActivelyPlayed()

bool tracktion::engine::AutomatableEditItem::isBeingActivelyPlayed ( ) const

Definition at line 138 of file tracktion_AutomatableEditItem.cpp.

◆ rebuildParameterTree()

void tracktion::engine::AutomatableEditItem::rebuildParameterTree ( )
protected

Definition at line 189 of file tracktion_AutomatableEditItem.cpp.

◆ removeParameterListChangeListener()

void tracktion::engine::AutomatableEditItem::removeParameterListChangeListener ( ParameterListChangeListener *  l)

Definition at line 289 of file tracktion_AutomatableEditItem.cpp.

◆ resetRecordingStatus()

void tracktion::engine::AutomatableEditItem::resetRecordingStatus ( )

Marks the end of an automation recording stream.

Call this when play stops or starts.

Definition at line 158 of file tracktion_AutomatableEditItem.cpp.

◆ restoreChangedParametersFromState()

void tracktion::engine::AutomatableEditItem::restoreChangedParametersFromState ( )
protected

Restores the value of any explicitly set parameters.

Definition at line 250 of file tracktion_AutomatableEditItem.cpp.

◆ restorePluginStateFromValueTree()

virtual void tracktion::engine::AutomatableEditItem::restorePluginStateFromValueTree ( const juce::ValueTree &  )
virtual

Definition at line 25 of file tracktion_AutomatableEditItem.h.

◆ saveChangedParametersToState()

void tracktion::engine::AutomatableEditItem::saveChangedParametersToState ( )
protected

Saves the explicit value of any parameters that have deviated to the state.

Definition at line 228 of file tracktion_AutomatableEditItem.cpp.

◆ setAutomatableParamPosition()

void tracktion::engine::AutomatableEditItem::setAutomatableParamPosition ( TimePosition  time)

Definition at line 131 of file tracktion_AutomatableEditItem.cpp.

◆ updateActiveParameters()

void tracktion::engine::AutomatableEditItem::updateActiveParameters ( )

Iterates all the parameters to find out which ones need to be automated.

Definition at line 210 of file tracktion_AutomatableEditItem.cpp.

◆ updateAutomatableParamPosition()

void tracktion::engine::AutomatableEditItem::updateAutomatableParamPosition ( TimePosition  time)
virtual

Updates all the auto params to their positions at this time.

Reimplemented in tracktion::engine::RackInstance.

Definition at line 143 of file tracktion_AutomatableEditItem.cpp.

◆ updateLastPlaybackTime()

void tracktion::engine::AutomatableEditItem::updateLastPlaybackTime ( )
protected

Definition at line 171 of file tracktion_AutomatableEditItem.cpp.

◆ updateParameterStreams()

void tracktion::engine::AutomatableEditItem::updateParameterStreams ( TimePosition  time)

Updates all the parameter streams to their positions at this time.

This should be used during real time processing as it's a lot quicker than the above method.

Definition at line 150 of file tracktion_AutomatableEditItem.cpp.

◆ visitAllAutomatableParams()

void tracktion::engine::AutomatableEditItem::visitAllAutomatableParams ( const std::function< void(AutomatableParameter &)> &  visit) const

Definition at line 44 of file tracktion_AutomatableEditItem.cpp.

Member Data Documentation

◆ elementState

juce::ValueTree tracktion::engine::AutomatableEditItem::elementState

Definition at line 76 of file tracktion_AutomatableEditItem.h.

◆ remapOnTempoChange

juce::CachedValue<bool> tracktion::engine::AutomatableEditItem::remapOnTempoChange

Definition at line 77 of file tracktion_AutomatableEditItem.h.

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