tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
tracktion::engine::Scene Class Reference

A Scene is a collection of ClipSlots across tracks. More...

#include "tracktion_Scene.h"

Inheritance diagram for tracktion::engine::Scene:
tracktion::engine::Selectable juce::ValueTree::Listener

Public Member Functions

 Scene (const juce::ValueTree &, SceneList &)
 Creates a Scene for a given state.
 
 ~Scene () override
 Destructor.
 
int getIndex ()
 
juce::String getSelectableDescription () override
 Subclasses must return a description of what they are.
 
- 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

juce::ValueTree state
 
Editedit
 
juce::CachedValue< juce::Stringname
 
juce::CachedValue< juce::Colourcolour
 
SceneListsceneList
 
- Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master masterReference
 

Additional Inherited Members

- Public Types inherited from tracktion::engine::Selectable
using WeakRef = juce::WeakReference< Selectable >
 
- 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.
 

Detailed Description

A Scene is a collection of ClipSlots across tracks.

This class provides an interface to interact with them all rather than having to iterate through each Track's SlotList finding the relevant ClipSlot index.

Definition at line 22 of file tracktion_Scene.h.

Constructor & Destructor Documentation

◆ Scene()

tracktion::engine::Scene::Scene ( const juce::ValueTree v,
SceneList sl 
)

Creates a Scene for a given state.

Definition at line 14 of file tracktion_Scene.cpp.

◆ ~Scene()

tracktion::engine::Scene::~Scene ( )
override

Destructor.

Definition at line 26 of file tracktion_Scene.cpp.

Member Function Documentation

◆ getIndex()

int tracktion::engine::Scene::getIndex ( )

Definition at line 31 of file tracktion_Scene.cpp.

◆ getSelectableDescription()

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

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 36 of file tracktion_Scene.cpp.

Member Data Documentation

◆ colour

juce::CachedValue<juce::Colour> tracktion::engine::Scene::colour

Definition at line 38 of file tracktion_Scene.h.

◆ edit

Edit& tracktion::engine::Scene::edit

Definition at line 35 of file tracktion_Scene.h.

◆ name

juce::CachedValue<juce::String> tracktion::engine::Scene::name

Definition at line 37 of file tracktion_Scene.h.

◆ sceneList

SceneList& tracktion::engine::Scene::sceneList

Definition at line 40 of file tracktion_Scene.h.

◆ state

juce::ValueTree tracktion::engine::Scene::state

Definition at line 34 of file tracktion_Scene.h.


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