TracktionEngine
Public Types | Public Member Functions | List of all members
tracktion::engine::TempoTrack Class Reference

A track to represent the "global" items such as tempo, key changes etc. More...

Inheritance diagram for tracktion::engine::TempoTrack:

Public Types

using Ptr = juce::ReferenceCountedObjectPtr< TempoTrack >
 
- Public Types inherited from tracktion::engine::Track
enum  FreezeType { groupFreeze = 0 , individualFreeze , anyFreeze }
 Determines the type of freeze. More...
 
enum  MuteAndSoloLightState {
  soloLit = 1 , soloFlashing = 2 , soloIsolate = 4 , muteLit = 8 ,
  muteFlashing = 16
}
 Determines the status of the mute and solo indicators. More...
 
using Ptr = juce::ReferenceCountedObjectPtr< Track >
 
using Array = juce::ReferenceCountedArray< Track >
 
- Public Types inherited from tracktion::engine::Selectable
using WeakRef = juce::WeakReference< Selectable >
 

Public Member Functions

 TempoTrack (Edit &, const juce::ValueTree &)
 Create the TempoTrack for an Edit with a given state. More...
 
 ~TempoTrack () override
 Destructor. More...
 
bool isTempoTrack () const override
 
juce::String getName () const override
 
juce::String getSelectableDescription () override
 
int getNumTrackItems () const override
 
TrackItemgetTrackItem (int idx) const override
 
int indexOfTrackItem (TrackItem *) const override
 
int getIndexOfNextTrackItemAt (TimePosition) override
 
TrackItemgetNextTrackItemAt (TimePosition) override
 
bool canContainPlugin (Plugin *) const override
 
void insertSpaceIntoTrack (TimePosition, TimeDuration) override
 
- Public Member Functions inherited from tracktion::engine::Track
 Track (Edit &, const juce::ValueTree &, double defaultTrackHeight, double minTrackHeight, double maxTrackHeight)
 Creates a track with a given state. More...
 
 ~Track () override
 Destructor. More...
 
virtual void initialise ()
 Initialises the Track. More...
 
virtual void flushStateToValueTree ()
 Flushes all plugin states on the track to the state object. More...
 
void refreshCurrentAutoParam ()
 Updates the current parameter bases on the set IDs. More...
 
juce::String getName () const override
 Returns the name of the Track. More...
 
void setName (const juce::String &)
 Sets the name of the Track. More...
 
void resetName ()
 Sets the name of the Track to an empty string. More...
 
virtual void sanityCheckName ()
 Sub-classes can impliment this to avoid certain characters being used in a name. More...
 
virtual bool isAudioTrack () const
 Returns true if this is an AudioTrack. More...
 
virtual bool isAutomationTrack () const
 Returns true if this is an AutomationTrack. More...
 
virtual bool isFolderTrack () const
 Returns true if this is a FolderTrack. More...
 
virtual bool isMarkerTrack () const
 Returns true if this is a MarkerTrack. More...
 
virtual bool isChordTrack () const
 Returns true if this is a ChordTrack. More...
 
virtual bool isArrangerTrack () const
 Returns true if this is an ArrangerTrack. More...
 
virtual bool isMasterTrack () const
 Returns true if this is a MasterTrack. More...
 
bool canContainMarkers () const
 Returns true if this Track can contain MarkerClip[s]. More...
 
bool canContainMIDI () const
 Returns true if this Track can contain MidiClip[s]. More...
 
bool canContainAudio () const
 Returns true if this Track can contain WaveAudioClip[s]. More...
 
bool canContainEditClips () const
 Returns true if this Track can contain EditClip[s]. More...
 
bool canContainPlugins () const
 Returns true if this Track can contain Plugin[s]. More...
 
bool isMovable () const
 Returns true if this Track is movable. More...
 
bool acceptsInput () const
 Returns true if this track can have inputs assigned to it. More...
 
bool createsOutput () const
 Returns true if this track creates audible output. More...
 
bool wantsAutomation () const
 Returns true if this track can show automation. More...
 
virtual bool isFrozen (FreezeType) const
 Returns true if this track is frozen using the given type. More...
 
virtual void setFrozen (bool, FreezeType)
 Attempts to freeze or unfreeze the track using a given FreezeType. More...
 
bool isHidden () const
 Returns true if this track should be hidden from view. More...
 
void setHidden (bool h)
 Sets whether this track should be hidden from view. More...
 
bool isProcessing (bool includeParents) const
 Returns true if this track should be included in playback. More...
 
void setProcessing (bool p)
 Sets whether this track should be included in playback. More...
 
virtual bool processAudioNodesWhileMuted () const
 Subclasses can override this to ensure track contents are still played even when the track is muted. More...
 
virtual juce::Array< Track * > getInputTracks () const
 Should return any tracks which feed into this track. More...
 
juce::Array< Track * > getAllSubTracks (bool recursive) const
 Returns all nested tracks. More...
 
juce::Array< AudioTrack * > getAllAudioSubTracks (bool recursive) const
 Returns all nested AudioTrack[s]. More...
 
TrackListgetSubTrackList () const
 Returns the TrackList if this Track has any sub-tracks. More...
 
bool hasSubTracks () const
 Returns true if this track has any subtracks. More...
 
virtual ClipfindClipForID (EditItemID) const
 Returns a clip one with a matching ID can be found on this Track. More...
 
TrackgetSiblingTrack (int delta, bool keepWithinSameParent) const
 Returns a sibling Track to this one. More...
 
juce::ValueTree getParentTrackTree () const
 Returns the state of the parent Track. More...
 
TrackgetParentTrack () const
 Returns the parent Track if this is a nested track. More...
 
FolderTrackgetParentFolderTrack () const
 Returns the parent FolderTrack if this is nested in one. More...
 
bool isAChildOf (const Track &possibleParent) const
 Tests whether this is a child of a given Track. More...
 
bool isPartOfSubmix () const
 Tests whether this nested within a submix FolderTrack. More...
 
int getIndexInEditTrackList () const
 Returns the index of this track in a flat list of tracks contained in an Edit. More...
 
int getTrackDepth () const
 Returns the number of parents within which this track is nested. More...
 
virtual bool isMuted (bool) const
 Returns true if this track is muted. More...
 
virtual bool isSolo (bool) const
 Returns true if this track is soloed. More...
 
virtual bool isSoloIsolate (bool) const
 Returns true if this track is solo isolated. More...
 
virtual void setMute (bool)
 Subclasses should implement this to mute themselves. More...
 
virtual void setSolo (bool)
 Subclasses should implement this to solo themselves. More...
 
virtual void setSoloIsolate (bool)
 Subclasses should implement this to solo isolate themselves. More...
 
MuteAndSoloLightState getMuteAndSoloLightState () const
 Returns the mute a solo status. More...
 
bool shouldBePlayed () const noexcept
 Tests whether this track should be audible in the playback graph i.e. More...
 
void updateAudibility (bool areAnyTracksSolo)
 Updates the audibility state of the Track. More...
 
juce::Array< AutomatableParameter * > getAllAutomatableParams () const
 Returns all the parameteres for this track's Plugin[s] and Modifier[s]. More...
 
AutomatableParametergetCurrentlyShownAutoParam () const noexcept
 Returns the parameter whos curve should be shown on this Track. More...
 
void setCurrentlyShownAutoParam (const AutomatableParameter::Ptr &)
 Sets a parameter to display on this Track. More...
 
void hideAutomatableParametersForSource (EditItemID pluginOrParameterID)
 Hides a shown parameter if it matches the given ID. More...
 
virtual bool containsPlugin (const Plugin *) const
 Tests whether this Track or a clip on it contains the given plugin. More...
 
bool hasFreezePointPlugin () const
 Tests whether this Track contains a FreezePointPlugin. More...
 
juce::Array< AutomatableEditItem * > getAllAutomatableEditItems () const
 Returns all AutomatableEditItem[s] on this Track. More...
 
virtual Plugin::Array getAllPlugins () const
 Returns all pugins on this Track. More...
 
virtual void sendMirrorUpdateToAllPlugins (Plugin &changedPlugin) const
 Sends a message to all plugins that the given plugin has changed. More...
 
void flipAllPluginsEnablement ()
 Toggles the Plugin::isEnabled state for all Plugin[s] on this Track. More...
 
ModifierListgetModifierList () const
 Returns the ModifierList for this Track. More...
 
void setColour (juce::Colour newColour)
 Sets a colour for this track to use. More...
 
juce::Colour getColour () const
 Returns the the of this. More...
 
bool canShowImage () const
 Tests whether this Track can show an image. More...
 
void setTrackImage (const juce::String &idOrData)
 Sets some image data to use. More...
 
juce::String getTrackImage () const
 Returns previously set image data. More...
 
bool imageHasChanged ()
 Tests and resets a flag internally kept when the image changes. More...
 
void setTags (const juce::StringArray &)
 Sets an array of Strings to use as tags. More...
 
juce::String getTags () const
 Returns the tags as a pipe-separated single String. More...
 
const juce::StringArray & getTagsArray () const noexcept
 Returns the array of tags. More...
 
- Public Member Functions inherited from tracktion::engine::EditItem
 EditItem (EditItemID, Edit &)
 
virtual ~EditItem ()=default
 
- Public Member Functions inherited from tracktion::engine::Selectable
 Selectable ()
 
virtual ~Selectable ()
 
virtual void selectionStatusChanged (bool isNowSelected)
 Can be overridden to tell this object that it has just been selected or deselected. More...
 
virtual void changed ()
 This should be called to send a change notification to any SelectableListeners that are registered with this object. More...
 
virtual void selectableAboutToBeDeleted ()
 Called just before the selectable is about to be deleted so any subclasses should still be valid at this point. More...
 
void addSelectableListener (SelectableListener *)
 
void removeSelectableListener (SelectableListener *)
 
void cancelAnyPendingUpdates ()
 If changed() has been called, this will cancel any pending async change notificaions. More...
 
void deselect ()
 
void propertiesChanged ()
 
void notifyListenersOfDeletion ()
 
WeakRef getWeakRef ()
 
- Public Member Functions inherited from tracktion::engine::MacroParameterElement
 MacroParameterElement (Edit &, const juce::ValueTree &)
 Constructor. More...
 
virtual ~MacroParameterElement ()=default
 Destructor. More...
 
int getNumMacroParameters () const
 Returns the number of macro parameters for this object. More...
 

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. More...
 
- Public Attributes inherited from tracktion::engine::Track
const double defaultTrackHeight
 The default height of this Track. More...
 
const double minTrackHeight
 The minimum height of this Track. More...
 
const double maxTrackHeight
 The maximum height of this Track. More...
 
juce::ValueTree state
 The state of this Track. More...
 
PluginList pluginList
 The Track's PluginList. More...
 
- Public Attributes inherited from tracktion::engine::EditItem
Editedit
 
const EditItemID itemID
 Every EditItem has an ID which is unique within the edit. More...
 
- Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master masterReference
 
- Public Attributes inherited from tracktion::engine::MacroParameterElement
MacroParameterList macroParameterList
 
- Static Public Attributes inherited from tracktion::engine::Track
static const int minTrackHeightForDetail = 10
 The minimim height to show track contents at. More...
 
static const int trackHeightForEditor = 180
 The height at which inline editors should be shown. More...
 
static const int frozenTrackHeight = 15
 The height to show group frozen tracks. More...
 
- Protected Member Functions inherited from tracktion::engine::Track
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 handleAsyncUpdate () override
 
virtual bool isTrackAudible (bool areAnyTracksSolo) const
 Returns whether this Track should be audible. More...
 

Detailed Description

A track to represent the "global" items such as tempo, key changes etc.

This isn't a "real" track, it wraps the TempoSequence and PitchSequence.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ TempoTrack()

tracktion::engine::TempoTrack::TempoTrack ( Edit ,
const juce::ValueTree &   
)

Create the TempoTrack for an Edit with a given state.

◆ ~TempoTrack()

tracktion::engine::TempoTrack::~TempoTrack ( )
override

Destructor.

Member Function Documentation

◆ isTempoTrack()

bool tracktion::engine::TempoTrack::isTempoTrack ( ) const
overridevirtual

Reimplemented from tracktion::engine::Track.

◆ getName()

juce::String tracktion::engine::TempoTrack::getName ( ) const
overridevirtual

◆ getSelectableDescription()

juce::String tracktion::engine::TempoTrack::getSelectableDescription ( )
overridevirtual

◆ getNumTrackItems()

int tracktion::engine::TempoTrack::getNumTrackItems ( ) const
overridevirtual

Reimplemented from tracktion::engine::Track.

◆ getTrackItem()

TrackItem* tracktion::engine::TempoTrack::getTrackItem ( int  idx) const
overridevirtual

Reimplemented from tracktion::engine::Track.

◆ indexOfTrackItem()

int tracktion::engine::TempoTrack::indexOfTrackItem ( TrackItem ) const
overridevirtual

Reimplemented from tracktion::engine::Track.

◆ getIndexOfNextTrackItemAt()

int tracktion::engine::TempoTrack::getIndexOfNextTrackItemAt ( TimePosition  )
overridevirtual

Reimplemented from tracktion::engine::Track.

◆ getNextTrackItemAt()

TrackItem* tracktion::engine::TempoTrack::getNextTrackItemAt ( TimePosition  )
overridevirtual

Reimplemented from tracktion::engine::Track.

◆ canContainPlugin()

bool tracktion::engine::TempoTrack::canContainPlugin ( Plugin ) const
overridevirtual

◆ insertSpaceIntoTrack()

void tracktion::engine::TempoTrack::insertSpaceIntoTrack ( TimePosition  ,
TimeDuration   
)
overridevirtual

Reimplemented from tracktion::engine::Track.


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