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

Create a subclass of UIBehaviour to custom UI elements created by the engine. More...

#include "tracktion_UIBehaviour.h"

Public Member Functions

virtual Edit * getCurrentlyFocusedEdit ()
 
virtual Edit * getLastFocusedEdit ()
 
virtual juce::Array< Edit * > getAllOpenEdits ()
 
virtual bool isEditVisibleOnScreen (const Edit &)
 
virtual bool closeAllEditsBelongingToProject (Project &)
 
virtual void editNamesMayHaveChanged ()
 
virtual SelectionManager * getCurrentlyFocusedSelectionManager ()
 
virtual SelectionManager * getSelectionManagerForRack (const RackType &)
 
virtual bool paste (const Clipboard &)
 
virtual Project::Ptr getCurrentlyFocusedProject ()
 
virtual void selectProjectInFocusedWindow (Project::Ptr)
 
virtual void updateAllProjectItemLists ()
 
virtual juce::ApplicationCommandManager * getApplicationCommandManager ()
 
virtual void getAllCommands (juce::Array< juce::CommandID > &)
 
virtual void getCommandInfo (juce::CommandID, juce::ApplicationCommandInfo &)
 
virtual bool perform (const juce::ApplicationCommandTarget::InvocationInfo &)
 
virtual Plugin::Ptr showMenuAndCreatePlugin (Plugin::Type, Edit &)
 Should show the new plugin window and creates the Plugin the user selects.
 
virtual std::unique_ptr< juce::Component > createPluginWindow (PluginWindowState &)
 Must create a suitable Component plugin window for the given PluginWindowState.
 
virtual void recreatePluginWindowContentAsync (Plugin &)
 Should trigger an asynchronous refresh of any editor components showing for this plugin.
 
virtual void newTrackCreated (Track &)
 Called when a new track is created from some kind of user action i.e.
 
virtual std::unique_ptr< juce::AudioThumbnailBase > createAudioThumbnail (int sourceSamplesPerThumbnailSample, juce::AudioFormatManager &formatManagerToUse, juce::AudioThumbnailCache &cacheToUse)
 Must create an AudioThumnail for displaying, usually in a SmartThumbnail.
 
virtual void showWarningAlert (const juce::String &title, const juce::String &message)
 Should display a dismissable alert window.
 
virtual bool showOkCancelAlertBox (const juce::String &title, const juce::String &message, const juce::String &ok={}, const juce::String &cancel={})
 Should display a dismissable alert window.
 
virtual int showYesNoCancelAlertBox (const juce::String &title, const juce::String &message, const juce::String &yes={}, const juce::String &no={}, const juce::String &cancel={})
 Should display a dismissable alert window.
 
virtual void showInfoMessage (const juce::String &message)
 Should display a temporary information message, usually in the same place.
 
virtual void showWarningMessage (const juce::String &message)
 Should display a temporary warning message.
 
virtual void showQuantisationLevel ()
 Should show the current quantisation level for a short period of time.
 
virtual void runTaskWithProgressBar (ThreadPoolJobWithProgress &)
 Should run this task in the current window, with a progress bar, blocking until the task is done.
 
virtual bool getBigInputMetersMode ()
 
virtual void setBigInputMetersMode (bool)
 
virtual bool shouldGenerateLiveWaveformsWhenRecording ()
 
virtual void showSafeRecordDialog (TransportControl &)
 
virtual void hideSafeRecordDialog (TransportControl &)
 
virtual void showProjectScreen ()
 
virtual void showSettingsScreen ()
 
virtual void showEditScreen ()
 
virtual void showHideVideo ()
 
virtual void showHideInputs ()
 
virtual void showHideOutputs ()
 
virtual void showHideMixer (bool fullscreen)
 
virtual void showHideMidiEditor (bool fullscreen)
 
virtual void showHideTrackEditor (bool zoom)
 
virtual void showHideBrowser ()
 
virtual void showHideActions ()
 
virtual void showHideAllPanes ()
 
virtual void toggleScroll ()
 
virtual bool isScrolling ()
 
virtual void performUserAction (int)
 
virtual void scrollTracksUp ()
 
virtual void scrollTracksDown ()
 
virtual void scrollTracksLeft ()
 
virtual void scrollTracksRight ()
 
virtual void nudgeSelectedClips (TimecodeSnapType, const juce::String &commandDesc, SelectionManager &, const juce::Array< Clip * > &, bool automationLocked)
 
virtual void nudgeSelected (TimecodeSnapType, const juce::String &commandDesc, bool automationLocked)
 
virtual void nudgeSelected (const juce::String &commandDesc)
 
virtual void stopPreviewPlayback ()
 
virtual void resetOverloads ()
 
virtual void resetPeaks ()
 
virtual void zoomHorizontal (float)
 
virtual void zoomVertical (float)
 
virtual void zoomToSelection ()
 
virtual void zoomToFitHorizontally ()
 
virtual void zoomToFitVertically ()
 
virtual TimePosition getEditingPosition (Edit &)
 Should return the position which used be used for edit operations such as splitting.
 
virtual TimeRange getEditingRange (Edit &)
 Should return the range which used be used for edit operations such as coping or deleting.
 
virtual juce::Array< Track * > getEditingTracks (Edit &)
 Can return a range of tracks which used be used for edit operations such as coping or deleting.
 
virtual SelectableList getAssociatedClipsToEdit (const SelectableList &items)
 If your UI has the concept of edit groups, you should return an expanded list of selected items that includes all clips that should be edited with the selected clip.
 

Detailed Description

Create a subclass of UIBehaviour to custom UI elements created by the engine.

Definition at line 17 of file tracktion_UIBehaviour.h.

Member Function Documentation

◆ closeAllEditsBelongingToProject()

virtual bool tracktion::engine::UIBehaviour::closeAllEditsBelongingToProject ( Project &  )
virtual

Definition at line 28 of file tracktion_UIBehaviour.h.

◆ createAudioThumbnail()

virtual std::unique_ptr< juce::AudioThumbnailBase > tracktion::engine::UIBehaviour::createAudioThumbnail ( int  sourceSamplesPerThumbnailSample,
juce::AudioFormatManager &  formatManagerToUse,
juce::AudioThumbnailCache &  cacheToUse 
)
virtual

Must create an AudioThumnail for displaying, usually in a SmartThumbnail.

Definition at line 63 of file tracktion_UIBehaviour.h.

◆ createPluginWindow()

virtual std::unique_ptr< juce::Component > tracktion::engine::UIBehaviour::createPluginWindow ( PluginWindowState &  )
virtual

Must create a suitable Component plugin window for the given PluginWindowState.

The type of state should be checked and used accordingly e.g. Plugin::WindowState or RackType::WindowsState

Definition at line 52 of file tracktion_UIBehaviour.h.

◆ editNamesMayHaveChanged()

virtual void tracktion::engine::UIBehaviour::editNamesMayHaveChanged ( )
virtual

Definition at line 29 of file tracktion_UIBehaviour.h.

◆ getAllCommands()

virtual void tracktion::engine::UIBehaviour::getAllCommands ( juce::Array< juce::CommandID > &  )
virtual

Definition at line 40 of file tracktion_UIBehaviour.h.

◆ getAllOpenEdits()

virtual juce::Array< Edit * > tracktion::engine::UIBehaviour::getAllOpenEdits ( )
virtual

Definition at line 26 of file tracktion_UIBehaviour.h.

◆ getApplicationCommandManager()

virtual juce::ApplicationCommandManager * tracktion::engine::UIBehaviour::getApplicationCommandManager ( )
virtual

Definition at line 39 of file tracktion_UIBehaviour.h.

◆ getAssociatedClipsToEdit()

virtual SelectableList tracktion::engine::UIBehaviour::getAssociatedClipsToEdit ( const SelectableList &  items)
virtual

If your UI has the concept of edit groups, you should return an expanded list of selected items that includes all clips that should be edited with the selected clip.

Definition at line 171 of file tracktion_UIBehaviour.h.

◆ getBigInputMetersMode()

virtual bool tracktion::engine::UIBehaviour::getBigInputMetersMode ( )
virtual

Definition at line 106 of file tracktion_UIBehaviour.h.

◆ getCommandInfo()

virtual void tracktion::engine::UIBehaviour::getCommandInfo ( juce::CommandID  ,
juce::ApplicationCommandInfo &   
)
virtual

Definition at line 41 of file tracktion_UIBehaviour.h.

◆ getCurrentlyFocusedEdit()

virtual Edit * tracktion::engine::UIBehaviour::getCurrentlyFocusedEdit ( )
virtual

Definition at line 24 of file tracktion_UIBehaviour.h.

◆ getCurrentlyFocusedProject()

virtual Project::Ptr tracktion::engine::UIBehaviour::getCurrentlyFocusedProject ( )
virtual

Definition at line 35 of file tracktion_UIBehaviour.h.

◆ getCurrentlyFocusedSelectionManager()

virtual SelectionManager * tracktion::engine::UIBehaviour::getCurrentlyFocusedSelectionManager ( )
virtual

Definition at line 31 of file tracktion_UIBehaviour.h.

◆ getEditingPosition()

TimePosition tracktion::engine::UIBehaviour::getEditingPosition ( Edit &  e)
virtual

Should return the position which used be used for edit operations such as splitting.

By default this returns the transport position.

Definition at line 216 of file tracktion_UIBehaviour.cpp.

◆ getEditingRange()

TimeRange tracktion::engine::UIBehaviour::getEditingRange ( Edit &  e)
virtual

Should return the range which used be used for edit operations such as coping or deleting.

By default this returns the loop range.

Definition at line 221 of file tracktion_UIBehaviour.cpp.

◆ getEditingTracks()

virtual juce::Array< Track * > tracktion::engine::UIBehaviour::getEditingTracks ( Edit &  )
virtual

Can return a range of tracks which used be used for edit operations such as coping or deleting.

Definition at line 165 of file tracktion_UIBehaviour.h.

◆ getLastFocusedEdit()

virtual Edit * tracktion::engine::UIBehaviour::getLastFocusedEdit ( )
virtual

Definition at line 25 of file tracktion_UIBehaviour.h.

◆ getSelectionManagerForRack()

virtual SelectionManager * tracktion::engine::UIBehaviour::getSelectionManagerForRack ( const RackType &  )
virtual

Definition at line 32 of file tracktion_UIBehaviour.h.

◆ hideSafeRecordDialog()

virtual void tracktion::engine::UIBehaviour::hideSafeRecordDialog ( TransportControl &  )
virtual

Definition at line 112 of file tracktion_UIBehaviour.h.

◆ isEditVisibleOnScreen()

virtual bool tracktion::engine::UIBehaviour::isEditVisibleOnScreen ( const Edit &  )
virtual

Definition at line 27 of file tracktion_UIBehaviour.h.

◆ isScrolling()

virtual bool tracktion::engine::UIBehaviour::isScrolling ( )
virtual

Definition at line 128 of file tracktion_UIBehaviour.h.

◆ newTrackCreated()

virtual void tracktion::engine::UIBehaviour::newTrackCreated ( Track &  )
virtual

Called when a new track is created from some kind of user action i.e.

not from an Edit load.

Definition at line 60 of file tracktion_UIBehaviour.h.

◆ nudgeSelected() [1/2]

void tracktion::engine::UIBehaviour::nudgeSelected ( const juce::String &  commandDesc)
virtual

Definition at line 209 of file tracktion_UIBehaviour.cpp.

◆ nudgeSelected() [2/2]

void tracktion::engine::UIBehaviour::nudgeSelected ( TimecodeSnapType  snapType,
const juce::String &  commandDesc,
bool  automationLocked 
)
virtual

Definition at line 177 of file tracktion_UIBehaviour.cpp.

◆ nudgeSelectedClips()

void tracktion::engine::UIBehaviour::nudgeSelectedClips ( TimecodeSnapType  snapType,
const juce::String &  commandDesc,
SelectionManager &  sm,
const juce::Array< Clip * > &  clips,
bool  automationLocked 
)
virtual

Definition at line 75 of file tracktion_UIBehaviour.cpp.

◆ paste()

bool tracktion::engine::UIBehaviour::paste ( const Clipboard &  clipboard)
virtual

Definition at line 14 of file tracktion_UIBehaviour.cpp.

◆ perform()

virtual bool tracktion::engine::UIBehaviour::perform ( const juce::ApplicationCommandTarget::InvocationInfo &  )
virtual

Definition at line 42 of file tracktion_UIBehaviour.h.

◆ performUserAction()

virtual void tracktion::engine::UIBehaviour::performUserAction ( int  )
virtual

Definition at line 130 of file tracktion_UIBehaviour.h.

◆ recreatePluginWindowContentAsync()

void tracktion::engine::UIBehaviour::recreatePluginWindowContentAsync ( Plugin &  p)
virtual

Should trigger an asynchronous refresh of any editor components showing for this plugin.

The default implementation just causes a new instance of the whole window to be created.

Definition at line 226 of file tracktion_UIBehaviour.cpp.

◆ resetOverloads()

virtual void tracktion::engine::UIBehaviour::resetOverloads ( )
virtual

Definition at line 143 of file tracktion_UIBehaviour.h.

◆ resetPeaks()

virtual void tracktion::engine::UIBehaviour::resetPeaks ( )
virtual

Definition at line 144 of file tracktion_UIBehaviour.h.

◆ runTaskWithProgressBar()

virtual void tracktion::engine::UIBehaviour::runTaskWithProgressBar ( ThreadPoolJobWithProgress &  )
virtual

Should run this task in the current window, with a progress bar, blocking until the task is done.

Definition at line 104 of file tracktion_UIBehaviour.h.

◆ scrollTracksDown()

virtual void tracktion::engine::UIBehaviour::scrollTracksDown ( )
virtual

Definition at line 133 of file tracktion_UIBehaviour.h.

◆ scrollTracksLeft()

virtual void tracktion::engine::UIBehaviour::scrollTracksLeft ( )
virtual

Definition at line 134 of file tracktion_UIBehaviour.h.

◆ scrollTracksRight()

virtual void tracktion::engine::UIBehaviour::scrollTracksRight ( )
virtual

Definition at line 135 of file tracktion_UIBehaviour.h.

◆ scrollTracksUp()

virtual void tracktion::engine::UIBehaviour::scrollTracksUp ( )
virtual

Definition at line 132 of file tracktion_UIBehaviour.h.

◆ selectProjectInFocusedWindow()

virtual void tracktion::engine::UIBehaviour::selectProjectInFocusedWindow ( Project::Ptr  )
virtual

Definition at line 36 of file tracktion_UIBehaviour.h.

◆ setBigInputMetersMode()

virtual void tracktion::engine::UIBehaviour::setBigInputMetersMode ( bool  )
virtual

Definition at line 107 of file tracktion_UIBehaviour.h.

◆ shouldGenerateLiveWaveformsWhenRecording()

virtual bool tracktion::engine::UIBehaviour::shouldGenerateLiveWaveformsWhenRecording ( )
virtual

Definition at line 109 of file tracktion_UIBehaviour.h.

◆ showEditScreen()

virtual void tracktion::engine::UIBehaviour::showEditScreen ( )
virtual

Definition at line 116 of file tracktion_UIBehaviour.h.

◆ showHideActions()

virtual void tracktion::engine::UIBehaviour::showHideActions ( )
virtual

Definition at line 125 of file tracktion_UIBehaviour.h.

◆ showHideAllPanes()

virtual void tracktion::engine::UIBehaviour::showHideAllPanes ( )
virtual

Definition at line 126 of file tracktion_UIBehaviour.h.

◆ showHideBrowser()

virtual void tracktion::engine::UIBehaviour::showHideBrowser ( )
virtual

Definition at line 124 of file tracktion_UIBehaviour.h.

◆ showHideInputs()

virtual void tracktion::engine::UIBehaviour::showHideInputs ( )
virtual

Definition at line 119 of file tracktion_UIBehaviour.h.

◆ showHideMidiEditor()

virtual void tracktion::engine::UIBehaviour::showHideMidiEditor ( bool  fullscreen)
virtual

Definition at line 122 of file tracktion_UIBehaviour.h.

◆ showHideMixer()

virtual void tracktion::engine::UIBehaviour::showHideMixer ( bool  fullscreen)
virtual

Definition at line 121 of file tracktion_UIBehaviour.h.

◆ showHideOutputs()

virtual void tracktion::engine::UIBehaviour::showHideOutputs ( )
virtual

Definition at line 120 of file tracktion_UIBehaviour.h.

◆ showHideTrackEditor()

virtual void tracktion::engine::UIBehaviour::showHideTrackEditor ( bool  zoom)
virtual

Definition at line 123 of file tracktion_UIBehaviour.h.

◆ showHideVideo()

virtual void tracktion::engine::UIBehaviour::showHideVideo ( )
virtual

Definition at line 118 of file tracktion_UIBehaviour.h.

◆ showInfoMessage()

void tracktion::engine::UIBehaviour::showInfoMessage ( const juce::String &  message)
virtual

Should display a temporary information message, usually in the same place.

Definition at line 59 of file tracktion_UIBehaviour.cpp.

◆ showMenuAndCreatePlugin()

virtual Plugin::Ptr tracktion::engine::UIBehaviour::showMenuAndCreatePlugin ( Plugin::Type  ,
Edit &   
)
virtual

Should show the new plugin window and creates the Plugin the user selects.

Definition at line 46 of file tracktion_UIBehaviour.h.

◆ showOkCancelAlertBox()

bool tracktion::engine::UIBehaviour::showOkCancelAlertBox ( const juce::String &  title,
const juce::String &  message,
const juce::String &  ok = {},
const juce::String &  cancel = {} 
)
virtual

Should display a dismissable alert window.

Returns true for OK. N.B. this is blocking.

Definition at line 37 of file tracktion_UIBehaviour.cpp.

◆ showProjectScreen()

virtual void tracktion::engine::UIBehaviour::showProjectScreen ( )
virtual

Definition at line 114 of file tracktion_UIBehaviour.h.

◆ showQuantisationLevel()

virtual void tracktion::engine::UIBehaviour::showQuantisationLevel ( )
virtual

Should show the current quantisation level for a short period of time.

Definition at line 99 of file tracktion_UIBehaviour.h.

◆ showSafeRecordDialog()

virtual void tracktion::engine::UIBehaviour::showSafeRecordDialog ( TransportControl &  )
virtual

Definition at line 111 of file tracktion_UIBehaviour.h.

◆ showSettingsScreen()

virtual void tracktion::engine::UIBehaviour::showSettingsScreen ( )
virtual

Definition at line 115 of file tracktion_UIBehaviour.h.

◆ showWarningAlert()

void tracktion::engine::UIBehaviour::showWarningAlert ( const juce::String &  title,
const juce::String &  message 
)
virtual

Should display a dismissable alert window.

N.B. this should be non-blocking.

Definition at line 32 of file tracktion_UIBehaviour.cpp.

◆ showWarningMessage()

void tracktion::engine::UIBehaviour::showWarningMessage ( const juce::String &  message)
virtual

Should display a temporary warning message.

Definition at line 69 of file tracktion_UIBehaviour.cpp.

◆ showYesNoCancelAlertBox()

int tracktion::engine::UIBehaviour::showYesNoCancelAlertBox ( const juce::String &  title,
const juce::String &  message,
const juce::String &  yes = {},
const juce::String &  no = {},
const juce::String &  cancel = {} 
)
virtual

Should display a dismissable alert window.

Returns 1 = yes, 2 = no, 0 = cancel N.B. this is blocking.

Definition at line 48 of file tracktion_UIBehaviour.cpp.

◆ stopPreviewPlayback()

virtual void tracktion::engine::UIBehaviour::stopPreviewPlayback ( )
virtual

Definition at line 142 of file tracktion_UIBehaviour.h.

◆ toggleScroll()

virtual void tracktion::engine::UIBehaviour::toggleScroll ( )
virtual

Definition at line 127 of file tracktion_UIBehaviour.h.

◆ updateAllProjectItemLists()

virtual void tracktion::engine::UIBehaviour::updateAllProjectItemLists ( )
virtual

Definition at line 37 of file tracktion_UIBehaviour.h.

◆ zoomHorizontal()

virtual void tracktion::engine::UIBehaviour::zoomHorizontal ( float  )
virtual

Definition at line 146 of file tracktion_UIBehaviour.h.

◆ zoomToFitHorizontally()

virtual void tracktion::engine::UIBehaviour::zoomToFitHorizontally ( )
virtual

Definition at line 149 of file tracktion_UIBehaviour.h.

◆ zoomToFitVertically()

virtual void tracktion::engine::UIBehaviour::zoomToFitVertically ( )
virtual

Definition at line 150 of file tracktion_UIBehaviour.h.

◆ zoomToSelection()

virtual void tracktion::engine::UIBehaviour::zoomToSelection ( )
virtual

Definition at line 148 of file tracktion_UIBehaviour.h.

◆ zoomVertical()

virtual void tracktion::engine::UIBehaviour::zoomVertical ( float  )
virtual

Definition at line 147 of file tracktion_UIBehaviour.h.

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