Inheritance diagram for tracktion::engine::CollectionClip:

Public Types
using	Ptr = juce::ReferenceCountedObjectPtr< CollectionClip >

using	Array = juce::ReferenceCountedArray< CollectionClip >

Public Types inherited from tracktion::engine::TrackItem
enum class	Type { unknown , wave , midi , edit , step , marker , pitch , timeSig , collection , video , recording , chord , arranger , container }
	Defines the types of item that can live on Track[s]. More...

Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	CollectionClip (Track &)

void	addClip (Clip *)

void	removeClip (Clip *)

bool	removeClip (EditItemID)

bool	containsClip (Clip *clip) const noexcept

juce::String	getName () const override

ClipPosition	getPosition () const override
	Must return the position of this item.

Track *	getTrack () const override
	Must return the track this item lives on.

bool	moveToTrack (Track &)

void	updateStartAndEnd ()

FolderTrack *	getFolderTrack () const noexcept

juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.

int	getNumClips () const noexcept

Clip::Ptr	getClip (int index) const

const Clip::Array &	getClips () const noexcept

void	setDragging (bool nowDragging) noexcept

bool	isDragging () const noexcept

EditItemID	getGroupID () const noexcept

void	setGroupID (EditItemID newGroupID)

bool	isGroupCollection () const

Public Member Functions inherited from tracktion::engine::TrackItem
	TrackItem (Edit &, EditItemID, Type)
	Creates a TrackItem with an ID and type.

	~TrackItem ()
	Destructor.

virtual bool	isGrouped () const
	Should return true if this clip is part of a group.

virtual TrackItem *	getGroupParent () const
	If this clip is part of a group, this should return the parent item it belongs to.

TimeRange	getEditTimeRange () const
	Returns the time range of this item.

BeatRange	getEditBeatRange () const
	Returns the beat range of this item.

BeatPosition	getStartBeat () const
	Returns the start beat in the Edit of this item.

BeatPosition	getContentStartBeat () const
	Returns the start beat of the content in the Edit of this item.

BeatPosition	getEndBeat () const
	Returns the end beat in the Edit of this item.

BeatDuration	getLengthInBeats () const
	Returns the duration in beats the of this item.

TimePosition	getTimeOfRelativeBeat (BeatDuration) const
	Returns an Edit time point for a given number of beats from the start of this item.

BeatPosition	getBeatOfRelativeTime (TimeDuration) const
	Returns an Edit beat point for a given number of seconds from the start of this item.

BeatDuration	getOffsetInBeats () const
	Returns an the offset of this item in beats.

EditItemID	getTrackID () const
	Returns the ID of the Track this item lives on.

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 juce::ReferenceCountedObject
void	incReferenceCount () noexcept

void	decReferenceCount () noexcept

bool	decReferenceCountWithoutDeleting () noexcept

int	getReferenceCount () const noexcept

Public Attributes
TimeRange	range

Public Attributes inherited from tracktion::engine::TrackItem
const Type	type
	The type of this item.

Public Attributes inherited from tracktion::engine::EditItem
Edit &	edit

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
Static Public Member Functions inherited from tracktion::engine::TrackItem
static const char *	typeToString (Type)
	Returns the string version of a TrackItem::Type.

static juce::Identifier	clipTypeToXMLType (Type)
	Returns an Identifier version of a TrackItem::Type.

static TrackItem::Type	xmlTagToType (juce::StringRef)
	Returns the TrackItem::Type of a type string.

static TrackItem::Type	stringToType (const juce::String &)
	Returns the TrackItem::Type of a type string.

static juce::String	getSuggestedNameForNewItem (Type)
	Returns a text string for a new clip of the given type.

template<typename ArrayType >
static void	sortByTime (ArrayType &items)
	Helper function to sort an array of TrackItem[s] by their start time.

template<typename ArrayType >
static void	stableSortByTime (ArrayType &items)
	Helper function to sort an array of TrackItem[s] by their start time without changing the order of items at the same time.

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 juce::ReferenceCountedObject
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept

	ReferenceCountedObject (ReferenceCountedObject &&) noexcept

ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept

ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept

void	resetReferenceCount () noexcept

Detailed Description

Definition at line 17 of file tracktion_CollectionClip.h.

Member Typedef Documentation

◆ Array

using tracktion::engine::CollectionClip::Array = juce::ReferenceCountedArray<CollectionClip>

Definition at line 24 of file tracktion_CollectionClip.h.

◆ Ptr

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

Definition at line 23 of file tracktion_CollectionClip.h.

Constructor & Destructor Documentation

◆ CollectionClip()

tracktion::engine::CollectionClip::CollectionClip ( Track & t )

Definition at line 14 of file tracktion_CollectionClip.cpp.

◆ ~CollectionClip()

tracktion::engine::CollectionClip::~CollectionClip ( )

override

Definition at line 20 of file tracktion_CollectionClip.cpp.

Member Function Documentation

◆ addClip()

void tracktion::engine::CollectionClip::addClip ( Clip * clip )

Definition at line 25 of file tracktion_CollectionClip.cpp.

◆ containsClip()

bool tracktion::engine::CollectionClip::containsClip ( Clip * clip ) const

noexcept

Definition at line 29 of file tracktion_CollectionClip.h.

◆ getClip()

Clip::Ptr tracktion::engine::CollectionClip::getClip ( int index ) const

Definition at line 43 of file tracktion_CollectionClip.h.

◆ getClips()

const Clip::Array & tracktion::engine::CollectionClip::getClips ( ) const

noexcept

Definition at line 44 of file tracktion_CollectionClip.h.

◆ getFolderTrack()

FolderTrack * tracktion::engine::CollectionClip::getFolderTrack ( ) const

noexcept

Definition at line 85 of file tracktion_CollectionClip.cpp.

◆ getGroupID()

EditItemID tracktion::engine::CollectionClip::getGroupID ( ) const

noexcept

Definition at line 50 of file tracktion_CollectionClip.h.

◆ getName()

juce::String tracktion::engine::CollectionClip::getName ( ) const

overridevirtual

Implements tracktion::engine::EditItem.

Definition at line 96 of file tracktion_CollectionClip.cpp.

◆ getNumClips()

int tracktion::engine::CollectionClip::getNumClips ( ) const

noexcept

Definition at line 42 of file tracktion_CollectionClip.h.

◆ getPosition()

ClipPosition tracktion::engine::CollectionClip::getPosition ( ) const

overridevirtual

Must return the position of this item.

Implements tracktion::engine::TrackItem.

Definition at line 33 of file tracktion_CollectionClip.h.

◆ getSelectableDescription()

juce::String tracktion::engine::CollectionClip::getSelectableDescription ( )

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 41 of file tracktion_CollectionClip.h.

◆ getTrack()

Track * tracktion::engine::CollectionClip::getTrack ( ) const

overridevirtual

Must return the track this item lives on.

Implements tracktion::engine::TrackItem.

Definition at line 34 of file tracktion_CollectionClip.h.

◆ isDragging()

bool tracktion::engine::CollectionClip::isDragging ( ) const

noexcept

Definition at line 47 of file tracktion_CollectionClip.h.

◆ isGroupCollection()

bool tracktion::engine::CollectionClip::isGroupCollection ( ) const

Definition at line 53 of file tracktion_CollectionClip.h.

◆ moveToTrack()

bool tracktion::engine::CollectionClip::moveToTrack ( Track & newTrack )

Definition at line 62 of file tracktion_CollectionClip.cpp.

◆ removeClip() [1/2]

void tracktion::engine::CollectionClip::removeClip ( Clip * clip )

Definition at line 38 of file tracktion_CollectionClip.cpp.

◆ removeClip() [2/2]

bool tracktion::engine::CollectionClip::removeClip ( EditItemID clipID )

Definition at line 45 of file tracktion_CollectionClip.cpp.

◆ setDragging()

void tracktion::engine::CollectionClip::setDragging ( bool nowDragging )

noexcept

Definition at line 46 of file tracktion_CollectionClip.h.

◆ setGroupID()

void tracktion::engine::CollectionClip::setGroupID ( EditItemID newGroupID )

Definition at line 51 of file tracktion_CollectionClip.h.

◆ updateStartAndEnd()

void tracktion::engine::CollectionClip::updateStartAndEnd ( )

Definition at line 90 of file tracktion_CollectionClip.cpp.

Member Data Documentation

◆ range

TimeRange tracktion::engine::CollectionClip::range

Definition at line 55 of file tracktion_CollectionClip.h.

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

tracktion_engine/model/clips/tracktion_CollectionClip.h
tracktion_engine/model/clips/tracktion_CollectionClip.cpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Array

◆ Ptr

Constructor & Destructor Documentation

◆ CollectionClip()

◆ ~CollectionClip()

Member Function Documentation

◆ addClip()

◆ containsClip()

◆ getClip()

◆ getClips()

◆ getFolderTrack()

◆ getGroupID()

◆ getName()

◆ getNumClips()

◆ getPosition()

◆ getSelectableDescription()

◆ getTrack()

◆ isDragging()

◆ isGroupCollection()

◆ moveToTrack()

◆ removeClip() [1/2]

◆ removeClip() [2/2]

◆ setDragging()

◆ setGroupID()

◆ updateStartAndEnd()

Member Data Documentation

◆ range