|
tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation |
Classes | |
| struct | AttachedBoolValue |
| struct | AttachedFloatValue |
| struct | AttachedIntValue |
| struct | AttachedValue |
| struct | AutomationSourceList |
| struct | Listener |
| struct | ModifierAssignment |
| Connects a modifier source to an AutomatableParameter. More... | |
| struct | ModifierSource |
| Base class for things that can be used to modify parameters. More... | |
Public Types | |
| using | Ptr = juce::ReferenceCountedObjectPtr< AutomatableParameter > |
| using | Array = juce::ReferenceCountedArray< AutomatableParameter > |
Public Types inherited from tracktion::engine::Selectable | |
| using | WeakRef = juce::WeakReference< Selectable > |
Public Member Functions | |
| AutomatableParameter (const juce::String ¶mID, const juce::String &name, AutomatableEditItem &, juce::NormalisableRange< float > valueRange) | |
| juce::Range< float > | getValueRange () const |
| Plugin * | getPlugin () const |
| Engine & | getEngine () const noexcept |
| Edit & | getEdit () const noexcept |
| Track * | getTrack () const noexcept |
| AutomationCurve & | getCurve () const noexcept |
| void | attachToCurrentValue (juce::CachedValue< float > &) |
| void | attachToCurrentValue (juce::CachedValue< int > &) |
| void | attachToCurrentValue (juce::CachedValue< bool > &) |
| void | updateFromAttachedValue () |
| void | detachFromCurrentValue () |
| virtual juce::String | getParameterName () const |
| virtual juce::String | getParameterShortName (int) const |
| virtual juce::String | getLabel () |
| virtual juce::String | getPluginAndParamName () const |
| virtual juce::String | getFullName () const |
| Selectable * | getOwnerSelectable () const |
| Returns the thing that you'd select if you wanted to show this param. | |
| EditItemID | getOwnerID () const |
| Returns the thing that you'd select if you wanted to show this param. | |
| float | getCurrentValue () const noexcept |
| float | getCurrentNormalisedValue () const noexcept |
| virtual juce::String | valueToString (float value) |
| virtual float | stringToValue (const juce::String &s) |
| virtual juce::String | getCurrentValueAsString () |
| juce::String | getCurrentValueAsStringWithLabel () |
| virtual void | beginParameterChangeGesture () |
| virtual void | endParameterChangeGesture () |
| void | setParameter (float value, juce::NotificationType) |
| void | setNormalisedParameter (float value, juce::NotificationType) |
| void | updateToFollowCurve (TimePosition) |
| void | parameterChangeGestureBegin () |
| Call to indicate this parameter is about to be changed. | |
| void | parameterChangeGestureEnd () |
| Call to indicate this parameter has stopped being to be changed. | |
| bool | hasAutomationPoints () const noexcept |
| ModifierAssignment::Ptr | addModifier (ModifierSource &, float value=1.0f, float offset=0.0f, float curve=0.5f) |
| Creates an assignment for a given source. | |
| void | removeModifier (ModifierAssignment &) |
| Removes an assignment. | |
| void | removeModifier (ModifierSource &) |
| Removes assignments for a ModifierSource. | |
| bool | hasActiveModifierAssignments () const |
| Returns true if any ModifierSources are currently in use by assignments. | |
| juce::ReferenceCountedArray< ModifierAssignment > | getAssignments () const |
| Returns all the current ModifierAssignments. | |
| juce::Array< ModifierSource * > | getModifiers () const |
| Returns all the current ModifierSources currently in use by assignments. | |
| float | getCurrentExplicitValue () const |
| This is the value that has been set explicity, either by calling setParameter or the plugin telling us one if its parameters has changed. | |
| float | getCurrentBaseValue () const |
| This is the current base value of the parameter i.e. | |
| float | getCurrentModifierValue () const |
| This is the ammount of the modifier that has been applied to the base value to give the current parameter value. | |
| bool | isAutomationActive () const |
| Returns true if the parameter is being dynamically changed somehow, either through automation or a ModifierAssignment. | |
| void | updateStream () |
| Forces the parameter to update its automation stream for reading automation. | |
| void | updateFromAutomationSources (TimePosition) |
| Updates the parameter and modifier values from its current automation sources. | |
| virtual bool | isParameterActive () const |
| virtual bool | isDiscrete () const |
| virtual int | getNumberOfStates () const |
| virtual float | getValueForState (int) const |
| virtual int | getStateForValue (float) const |
| virtual std::optional< float > | getDefaultValue () const |
| virtual bool | hasLabels () const |
| virtual juce::String | getLabelForValue (float) const |
| virtual float | snapToState (float val) const |
| virtual juce::StringArray | getAllLabels () const |
| bool | isCurrentlyRecording () const |
| true if the parameter been moved while in an automation record mode. | |
| void | resetRecordingStatus () |
| this is called before and after playback or recording. | |
| void | midiControllerMoved (float newPosition) |
| void | midiControllerPressed () |
| void | curveHasChanged () |
| juce::String | getSelectableDescription () override |
| Subclasses must return a description of what they are. | |
| void | addListener (Listener *l) |
| void | removeListener (Listener *l) |
Public Member Functions inherited from juce::ReferenceCountedObject | |
| void | incReferenceCount () noexcept |
| void | decReferenceCount () noexcept |
| bool | decReferenceCountWithoutDeleting () noexcept |
| int | getReferenceCount () const noexcept |
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. | |
| virtual void | selectableAboutToBeDeleted () |
| Called just before the selectable is about to be deleted so any subclasses should still be valid at this point. | |
| 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 Attributes | |
| const juce::String | paramID |
| const juce::NormalisableRange< float > | valueRange |
| AutomatableEditItem & | automatableEditElement |
| std::function< juce::String(float)> | valueToStringFunction |
| std::function< float(const juce::String &)> | stringToValueFunction |
| const juce::String | paramName |
| juce::ValueTree | parentState |
Public Attributes inherited from tracktion::engine::Selectable | |
| WeakRef::Master | masterReference |
Protected Member Functions | |
| AutomationSourceList & | getAutomationSourceList () const |
| void | setParameterValue (float value, bool isFollowingCurve) |
| void | valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override |
| void | valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &) override |
| void | valueTreeChildRemoved (juce::ValueTree &, juce::ValueTree &, int) override |
| void | valueTreeChildOrderChanged (juce::ValueTree &, int, int) override |
| void | valueTreeParentChanged (juce::ValueTree &) override |
| void | valueTreeRedirected (juce::ValueTree &) override |
| virtual void | parameterChanged (float, bool) |
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 |
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. | |
Definition at line 14 of file tracktion_AutomatableParameter.h.
| using tracktion::engine::AutomatableParameter::Array = juce::ReferenceCountedArray<AutomatableParameter> |
Definition at line 27 of file tracktion_AutomatableParameter.h.
| using tracktion::engine::AutomatableParameter::Ptr = juce::ReferenceCountedObjectPtr<AutomatableParameter> |
Definition at line 26 of file tracktion_AutomatableParameter.h.
| tracktion::engine::AutomatableParameter::AutomatableParameter | ( | const juce::String & | paramID, |
| const juce::String & | name, | ||
| AutomatableEditItem & | owner, | ||
| juce::NormalisableRange< float > | valueRange | ||
| ) |
Definition at line 649 of file tracktion_AutomatableParameter.cpp.
|
override |
Definition at line 688 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::addListener | ( | Listener * | l | ) |
Definition at line 226 of file tracktion_AutomatableParameter.h.
| AutomatableParameter::ModifierAssignment::Ptr tracktion::engine::AutomatableParameter::addModifier | ( | ModifierSource & | source, |
| float | value = 1.0f, |
||
| float | offset = 0.0f, |
||
| float | curve = 0.5f |
||
| ) |
Creates an assignment for a given source.
| value | the value of the assignment 0 - 1 |
| offset | the offset of the assignment 0 - 1 |
| curve | the curve of the assignment 0 - 1 where 0.5 is a linear mapping |
Definition at line 713 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::attachToCurrentValue | ( | juce::CachedValue< bool > & | v | ) |
Definition at line 926 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::attachToCurrentValue | ( | juce::CachedValue< float > & | v | ) |
Definition at line 910 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::attachToCurrentValue | ( | juce::CachedValue< int > & | v | ) |
Definition at line 918 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 78 of file tracktion_AutomatableParameter.h.
| void tracktion::engine::AutomatableParameter::curveHasChanged | ( | ) |
Definition at line 1217 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::detachFromCurrentValue | ( | ) |
Definition at line 940 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 79 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 183 of file tracktion_AutomatableParameter.h.
| juce::ReferenceCountedArray< AutomatableParameter::ModifierAssignment > tracktion::engine::AutomatableParameter::getAssignments | ( | ) | const |
Returns all the current ModifierAssignments.
Definition at line 780 of file tracktion_AutomatableParameter.cpp.
|
protected |
Definition at line 1140 of file tracktion_AutomatableParameter.cpp.
| float tracktion::engine::AutomatableParameter::getCurrentBaseValue | ( | ) | const |
This is the current base value of the parameter i.e.
either the explicit value or the automation curve value.
Definition at line 153 of file tracktion_AutomatableParameter.h.
| float tracktion::engine::AutomatableParameter::getCurrentExplicitValue | ( | ) | const |
This is the value that has been set explicity, either by calling setParameter or the plugin telling us one if its parameters has changed.
Definition at line 148 of file tracktion_AutomatableParameter.h.
| float tracktion::engine::AutomatableParameter::getCurrentModifierValue | ( | ) | const |
This is the ammount of the modifier that has been applied to the base value to give the current parameter value.
Definition at line 158 of file tracktion_AutomatableParameter.h.
|
noexcept |
Definition at line 67 of file tracktion_AutomatableParameter.h.
|
noexcept |
Definition at line 66 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 72 of file tracktion_AutomatableParameter.h.
| juce::String tracktion::engine::AutomatableParameter::getCurrentValueAsStringWithLabel | ( | ) |
Definition at line 1129 of file tracktion_AutomatableParameter.cpp.
|
noexcept |
Definition at line 966 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 807 of file tracktion_AutomatableParameter.cpp.
|
noexcept |
Definition at line 954 of file tracktion_AutomatableParameter.cpp.
|
noexcept |
Definition at line 949 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 1014 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 51 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 181 of file tracktion_AutomatableParameter.h.
| juce::Array< AutomatableParameter::ModifierSource * > tracktion::engine::AutomatableParameter::getModifiers | ( | ) | const |
Returns all the current ModifierSources currently in use by assignments.
Definition at line 791 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 175 of file tracktion_AutomatableParameter.h.
| EditItemID tracktion::engine::AutomatableParameter::getOwnerID | ( | ) | const |
Returns the thing that you'd select if you wanted to show this param.
Definition at line 982 of file tracktion_AutomatableParameter.cpp.
| Selectable * tracktion::engine::AutomatableParameter::getOwnerSelectable | ( | ) | const |
Returns the thing that you'd select if you wanted to show this param.
Definition at line 971 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 49 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 50 of file tracktion_AutomatableParameter.h.
| Plugin * tracktion::engine::AutomatableParameter::getPlugin | ( | ) | const |
Definition at line 34 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 1000 of file tracktion_AutomatableParameter.cpp.
|
overridevirtual |
Subclasses must return a description of what they are.
Implements tracktion::engine::Selectable.
Definition at line 201 of file tracktion_AutomatableParameter.h.
Definition at line 177 of file tracktion_AutomatableParameter.h.
|
noexcept |
Definition at line 959 of file tracktion_AutomatableParameter.cpp.
Definition at line 176 of file tracktion_AutomatableParameter.h.
| juce::Range< float > tracktion::engine::AutomatableParameter::getValueRange | ( | ) | const |
Definition at line 33 of file tracktion_AutomatableParameter.h.
| bool tracktion::engine::AutomatableParameter::hasActiveModifierAssignments | ( | ) | const |
Returns true if any ModifierSources are currently in use by assignments.
Definition at line 774 of file tracktion_AutomatableParameter.cpp.
|
noexcept |
Definition at line 92 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 180 of file tracktion_AutomatableParameter.h.
| bool tracktion::engine::AutomatableParameter::isAutomationActive | ( | ) | const |
Returns true if the parameter is being dynamically changed somehow, either through automation or a ModifierAssignment.
Definition at line 802 of file tracktion_AutomatableParameter.cpp.
| bool tracktion::engine::AutomatableParameter::isCurrentlyRecording | ( | ) | const |
true if the parameter been moved while in an automation record mode.
Definition at line 187 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 174 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 173 of file tracktion_AutomatableParameter.h.
| void tracktion::engine::AutomatableParameter::midiControllerMoved | ( | float | newPosition | ) |
Definition at line 1198 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::midiControllerPressed | ( | ) |
Definition at line 1203 of file tracktion_AutomatableParameter.cpp.
|
protectedvirtual |
Definition at line 262 of file tracktion_AutomatableParameter.h.
| void tracktion::engine::AutomatableParameter::parameterChangeGestureBegin | ( | ) |
Call to indicate this parameter is about to be changed.
Definition at line 1185 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::parameterChangeGestureEnd | ( | ) |
Call to indicate this parameter has stopped being to be changed.
Definition at line 1191 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::removeListener | ( | Listener * | l | ) |
Definition at line 227 of file tracktion_AutomatableParameter.h.
| void tracktion::engine::AutomatableParameter::removeModifier | ( | ModifierAssignment & | assignment | ) |
Removes an assignment.
N.B. the passed in assignment is likely to be deleted after this call.
Definition at line 754 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::removeModifier | ( | ModifierSource & | source | ) |
Removes assignments for a ModifierSource.
Definition at line 764 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::resetRecordingStatus | ( | ) |
this is called before and after playback or recording.
Definition at line 1025 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::setNormalisedParameter | ( | float | value, |
| juce::NotificationType | nt | ||
| ) |
Definition at line 1124 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::setParameter | ( | float | value, |
| juce::NotificationType | nt | ||
| ) |
Definition at line 1105 of file tracktion_AutomatableParameter.cpp.
|
protected |
Definition at line 1031 of file tracktion_AutomatableParameter.cpp.
Definition at line 182 of file tracktion_AutomatableParameter.h.
|
virtual |
Definition at line 70 of file tracktion_AutomatableParameter.h.
| void tracktion::engine::AutomatableParameter::updateFromAttachedValue | ( | ) |
Definition at line 934 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::updateFromAutomationSources | ( | TimePosition | time | ) |
Updates the parameter and modifier values from its current automation sources.
Definition at line 820 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::updateStream | ( | ) |
Forces the parameter to update its automation stream for reading automation.
Definition at line 815 of file tracktion_AutomatableParameter.cpp.
| void tracktion::engine::AutomatableParameter::updateToFollowCurve | ( | TimePosition | time | ) |
Definition at line 1148 of file tracktion_AutomatableParameter.cpp.
|
virtual |
Definition at line 69 of file tracktion_AutomatableParameter.h.
|
overrideprotectedvirtual |
Reimplemented from juce::ValueTree::Listener.
Definition at line 886 of file tracktion_AutomatableParameter.cpp.
|
overrideprotectedvirtual |
Reimplemented from juce::ValueTree::Listener.
Definition at line 900 of file tracktion_AutomatableParameter.cpp.
|
overrideprotectedvirtual |
Reimplemented from juce::ValueTree::Listener.
Definition at line 894 of file tracktion_AutomatableParameter.cpp.
|
overrideprotectedvirtual |
Reimplemented from juce::ValueTree::Listener.
Definition at line 906 of file tracktion_AutomatableParameter.cpp.
|
overrideprotectedvirtual |
Reimplemented from juce::ValueTree::Listener.
Definition at line 866 of file tracktion_AutomatableParameter.cpp.
|
overrideprotectedvirtual |
Reimplemented from juce::ValueTree::Listener.
Definition at line 907 of file tracktion_AutomatableParameter.cpp.
|
protected |
Definition at line 234 of file tracktion_AutomatableParameter.h.
| AutomatableEditItem& tracktion::engine::AutomatableParameter::automatableEditElement |
Definition at line 31 of file tracktion_AutomatableParameter.h.
|
mutableprotected |
Definition at line 249 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 242 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 242 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 242 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 242 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 241 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 237 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 243 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 235 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 240 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 239 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 247 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 245 of file tracktion_AutomatableParameter.h.
| const juce::String tracktion::engine::AutomatableParameter::paramID |
Definition at line 29 of file tracktion_AutomatableParameter.h.
| const juce::String tracktion::engine::AutomatableParameter::paramName |
Definition at line 203 of file tracktion_AutomatableParameter.h.
| juce::ValueTree tracktion::engine::AutomatableParameter::parentState |
Definition at line 204 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 238 of file tracktion_AutomatableParameter.h.
| std::function<float(const juce::String&)> tracktion::engine::AutomatableParameter::stringToValueFunction |
Definition at line 76 of file tracktion_AutomatableParameter.h.
|
protected |
Definition at line 244 of file tracktion_AutomatableParameter.h.
| const juce::NormalisableRange<float> tracktion::engine::AutomatableParameter::valueRange |
Definition at line 30 of file tracktion_AutomatableParameter.h.
| std::function<juce::String(float)> tracktion::engine::AutomatableParameter::valueToStringFunction |
Definition at line 75 of file tracktion_AutomatableParameter.h.