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::ClipSlot Class Reference

Represents a slot on a track that a Clip can live in to be played as a launched clip. More...

#include "tracktion_ClipSlot.h"

Inheritance diagram for tracktion::engine::ClipSlot:
tracktion::engine::EditItem tracktion::engine::Selectable tracktion::engine::ClipOwner

Public Member Functions

 ClipSlot (const juce::ValueTree &, Track &)
 Creates a ClipSlot for a given Track.
 
 ~ClipSlot () override
 Destructor.
 
void setClip (Clip *)
 Sets the Clip to be used within this slot.
 
ClipgetClip ()
 Returns the currently set clip.
 
int getIndex ()
 Returns slot index on track.
 
InputDeviceInstance::DestinationgetInputDestination ()
 
juce::String getName () const override
 
juce::String getSelectableDescription () override
 Subclasses must return a description of what they are.
 
juce::ValueTreegetClipOwnerState () override
 Must return the state of this ClipOwner.
 
EditItemID getClipOwnerID () override
 Must return the ID of this ClipOwner.
 
SelectablegetClipOwnerSelectable () override
 Must return the selectable if this ClipOwner is one.
 
EditgetClipOwnerEdit () override
 Must return the Edit this ClipOwner belongs to.
 
- Public Member Functions inherited from tracktion::engine::EditItem
 EditItem (EditItemID, Edit &)
 
- 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 Member Functions inherited from tracktion::engine::ClipOwner
 ClipOwner ()
 Constructs an empty ClipOwner.
 
virtual ~ClipOwner ()
 Destructor.
 
const juce::Array< Clip * > & getClips () const
 Returns the clips this owner contains.
 

Public Attributes

juce::ValueTree state
 The state of this ClipSlot.
 
Tracktrack
 The Track this ClipSlot belongs to.
 
- Public Attributes inherited from tracktion::engine::EditItem
Editedit
 
const EditItemID itemID
 Every EditItem has an ID which is unique within the edit.
 
- 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.
 
- Protected Member Functions inherited from tracktion::engine::ClipOwner
void initialiseClipOwner (Edit &, juce::ValueTree clipParentState)
 Must be called once from the subclass constructor to init the clip owner.
 

Detailed Description

Represents a slot on a track that a Clip can live in to be played as a launched clip.

Definition at line 18 of file tracktion_ClipSlot.h.

Constructor & Destructor Documentation

◆ ClipSlot()

tracktion::engine::ClipSlot::ClipSlot ( const juce::ValueTree v,
Track t 
)

Creates a ClipSlot for a given Track.

Definition at line 15 of file tracktion_ClipSlot.cpp.

◆ ~ClipSlot()

tracktion::engine::ClipSlot::~ClipSlot ( )
override

Destructor.

Definition at line 25 of file tracktion_ClipSlot.cpp.

Member Function Documentation

◆ getClip()

Clip * tracktion::engine::ClipSlot::getClip ( )

Returns the currently set clip.

Definition at line 47 of file tracktion_ClipSlot.cpp.

◆ getClipOwnerEdit()

Edit & tracktion::engine::ClipSlot::getClipOwnerEdit ( )
overridevirtual

Must return the Edit this ClipOwner belongs to.

Implements tracktion::engine::ClipOwner.

Definition at line 97 of file tracktion_ClipSlot.cpp.

◆ getClipOwnerID()

EditItemID tracktion::engine::ClipSlot::getClipOwnerID ( )
overridevirtual

Must return the ID of this ClipOwner.

Implements tracktion::engine::ClipOwner.

Definition at line 82 of file tracktion_ClipSlot.cpp.

◆ getClipOwnerSelectable()

Selectable * tracktion::engine::ClipSlot::getClipOwnerSelectable ( )
overridevirtual

Must return the selectable if this ClipOwner is one.

Implements tracktion::engine::ClipOwner.

Definition at line 92 of file tracktion_ClipSlot.cpp.

◆ getClipOwnerState()

juce::ValueTree & tracktion::engine::ClipSlot::getClipOwnerState ( )
overridevirtual

Must return the state of this ClipOwner.

Implements tracktion::engine::ClipOwner.

Definition at line 87 of file tracktion_ClipSlot.cpp.

◆ getIndex()

int tracktion::engine::ClipSlot::getIndex ( )

Returns slot index on track.

Definition at line 52 of file tracktion_ClipSlot.cpp.

◆ getInputDestination()

InputDeviceInstance::Destination * tracktion::engine::ClipSlot::getInputDestination ( )

Definition at line 61 of file tracktion_ClipSlot.cpp.

◆ getName()

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

Implements tracktion::engine::EditItem.

Definition at line 72 of file tracktion_ClipSlot.cpp.

◆ getSelectableDescription()

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

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 77 of file tracktion_ClipSlot.cpp.

◆ setClip()

void tracktion::engine::ClipSlot::setClip ( Clip c)

Sets the Clip to be used within this slot.

Definition at line 32 of file tracktion_ClipSlot.cpp.

Member Data Documentation

◆ state

juce::ValueTree tracktion::engine::ClipSlot::state

The state of this ClipSlot.

Definition at line 54 of file tracktion_ClipSlot.h.

◆ track

Track& tracktion::engine::ClipSlot::track

The Track this ClipSlot belongs to.

Definition at line 55 of file tracktion_ClipSlot.h.


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