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 | List of all members
tracktion::engine::ParameterChangeHandler Class Reference

Manages a set of AutomatableParameters for an Edit and notifies controllers and registered listeners when they change. More...

#include "tracktion_ParameterChangeHandler.h"

Inheritance diagram for tracktion::engine::ParameterChangeHandler:
juce::ChangeBroadcaster

Classes

struct  Disabler
 Temporarily disables change events e.g. More...
 

Public Member Functions

 ParameterChangeHandler (Edit &)
 Creates a ParameterChangeHandler for a given Edit.
 
bool isEventPending () const noexcept
 Returns true if there is either a parameter or action waiting to be assigned.
 
void parameterChanged (AutomatableParameter &parameter, bool fromAutomation)
 Called by parameters when they are changed.
 
bool isParameterPending () const noexcept
 Returns true if there is an AutomatableParameter waiting to be assigned.
 
AutomatableParameter::Ptr getPendingParam (bool consumeEvent) noexcept
 Returns the parameter waiting to be assigned if there is one, otherwise a nullptr.
 
void actionFunctionTriggered (int externalControllerID)
 Called by the accelerators when an assignable action is called.
 
bool isActionFunctionPending () const noexcept
 Returns true if there is an action function waiting to be assigned.
 
int getPendingActionFunctionId (bool consumeEvent) noexcept
 Returns the pending action function waiting to be assigned or a nullptr if none has been.
 
void setParameterLearnActive (bool a)
 Set true when UI up for learning parameters.
 
- Public Member Functions inherited from juce::ChangeBroadcaster
void addChangeListener (ChangeListener *listener)
 
void removeChangeListener (ChangeListener *listener)
 
void removeAllChangeListeners ()
 
void sendChangeMessage ()
 
void sendSynchronousChangeMessage ()
 
void dispatchPendingMessages ()
 

Detailed Description

Manages a set of AutomatableParameters for an Edit and notifies controllers and registered listeners when they change.

Definition at line 17 of file tracktion_ParameterChangeHandler.h.

Constructor & Destructor Documentation

◆ ParameterChangeHandler()

tracktion::engine::ParameterChangeHandler::ParameterChangeHandler ( Edit e)

Creates a ParameterChangeHandler for a given Edit.

Definition at line 14 of file tracktion_ParameterChangeHandler.cpp.

Member Function Documentation

◆ actionFunctionTriggered()

void tracktion::engine::ParameterChangeHandler::actionFunctionTriggered ( int  externalControllerID)

Called by the accelerators when an assignable action is called.

This gets added to the pending list which CustomControllerSurfaces can check when controllers are moved and they are in MIDI learn mode.

Definition at line 62 of file tracktion_ParameterChangeHandler.cpp.

◆ getPendingActionFunctionId()

int tracktion::engine::ParameterChangeHandler::getPendingActionFunctionId ( bool  consumeEvent)
noexcept

Returns the pending action function waiting to be assigned or a nullptr if none has been.

The object returned should be owned by the caller. Note that if consumeEvent is true this will consume the pending event so can't be reused for other controllers.

Definition at line 76 of file tracktion_ParameterChangeHandler.cpp.

◆ getPendingParam()

AutomatableParameter::Ptr tracktion::engine::ParameterChangeHandler::getPendingParam ( bool  consumeEvent)
noexcept

Returns the parameter waiting to be assigned if there is one, otherwise a nullptr.

Note that if consumeEvent is true this will consume the pending event so can't be reused for other controllers.

Definition at line 50 of file tracktion_ParameterChangeHandler.cpp.

◆ isActionFunctionPending()

bool tracktion::engine::ParameterChangeHandler::isActionFunctionPending ( ) const
noexcept

Returns true if there is an action function waiting to be assigned.

Definition at line 70 of file tracktion_ParameterChangeHandler.cpp.

◆ isEventPending()

bool tracktion::engine::ParameterChangeHandler::isEventPending ( ) const
noexcept

Returns true if there is either a parameter or action waiting to be assigned.

Definition at line 19 of file tracktion_ParameterChangeHandler.cpp.

◆ isParameterPending()

bool tracktion::engine::ParameterChangeHandler::isParameterPending ( ) const
noexcept

Returns true if there is an AutomatableParameter waiting to be assigned.

Definition at line 44 of file tracktion_ParameterChangeHandler.cpp.

◆ parameterChanged()

void tracktion::engine::ParameterChangeHandler::parameterChanged ( AutomatableParameter parameter,
bool  fromAutomation 
)

Called by parameters when they are changed.

This is internally called by each parameter and will forward the call on to appropriate controllers and mapping sets if required.

Definition at line 25 of file tracktion_ParameterChangeHandler.cpp.

◆ setParameterLearnActive()

void tracktion::engine::ParameterChangeHandler::setParameterLearnActive ( bool  a)

Set true when UI up for learning parameters.

Definition at line 73 of file tracktion_ParameterChangeHandler.h.


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