A higher level wrapper over a track collection that serves as the project's only tracklist. More...

#include <src/structure/tracks/tracklist.h>

Inheritance diagram for zrythm::structure::tracks::Tracklist:

Collaboration diagram for zrythm::structure::tracks::Tracklist:

Public Types
using	ArrangerObjectPtrVariant = arrangement::ArrangerObjectPtrVariant
using	ArrangerObject = arrangement::ArrangerObject

Public Member Functions
	Tracklist (TrackRegistry &track_registry, QObject *parent=nullptr)
TrackCollection *	collection () const
SingletonTracks *	singletonTracks () const
Q_INVOKABLE Track *	getTrackForTimelineObject (const arrangement::ArrangerObject *timelineObject) const
Q_INVOKABLE TrackLane *	getTrackLaneForObject (const arrangement::ArrangerObject *timelineObject) const
Q_INVOKABLE bool	isTrackPinned (const Track *track) const
Q_INVOKABLE bool	shouldBeVisible (const Track *track) const
Q_INVOKABLE bool	hasChannel (const Track *track) const
TrackRouting *	trackRouting () const
int	pinnedTracksCutoff () const
void	setPinnedTracksCutoff (int index)
Q_SIGNAL void	pinnedTracksCutoffChanged (int index)
std::optional< TrackPtrVariant >	get_track (const TrackUuid &id) const
std::optional< TrackPtrVariant >	get_visible_track_after_delta (Track::Uuid track_id, int delta) const
	Returns the Track after delta visible Track's.
bool	multiply_track_heights (double multiplier, bool visible_only, bool check_only, bool fire_events)
	Multiplies all tracks' heights and returns if the operation was valid.
void	handle_click (TrackUuid track_id, bool ctrl, bool shift, bool dragged)
	Handle a click selection.
std::vector< ArrangerObjectPtrVariant >	get_timeline_objects () const
void	clear_selections_for_object_siblings (const ArrangerObject::Uuid &object_id)
	Clears either the timeline selections or the clip editor selections.
std::optional< TrackUuidReference >	get_track_for_plugin (const plugins::Plugin::Uuid &plugin_id) const
bool	should_be_visible (const Track::Uuid &track_id) const
	Returns whether the track should be visible.
bool	is_track_pinned (int index) const
	Returns whether the track at `index` is pinned.
bool	is_track_pinned (Track::Uuid track_id) const
auto	get_track_route_target (const TrackUuid &source_track) const
void	mark_track_for_bounce (TrackPtrVariant track_var, bool bounce, bool mark_regions, bool mark_children, bool mark_parents)
	Marks the track for bouncing.

Properties
QML_ELEMENT zrythm::structure::tracks::TrackRouting *	trackRouting
zrythm::structure::tracks::SingletonTracks *	singletonTracks
zrythm::structure::tracks::TrackCollection *	collection
int	pinnedTracksCutoff

Friends
void	init_from (Tracklist &obj, const Tracklist &other, utils::ObjectCloneType clone_type)
void	to_json (nlohmann::json &j, const Tracklist &t)
void	from_json (const nlohmann::json &j, Tracklist &t)

Detailed Description

A higher level wrapper over a track collection that serves as the project's only tracklist.

Definition at line 22 of file tracklist.h.

Member Typedef Documentation

◆ ArrangerObject

using zrythm::structure::tracks::Tracklist::ArrangerObject = arrangement::ArrangerObject

Definition at line 36 of file tracklist.h.

◆ ArrangerObjectPtrVariant

using zrythm::structure::tracks::Tracklist::ArrangerObjectPtrVariant = arrangement::ArrangerObjectPtrVariant

Definition at line 35 of file tracklist.h.

Member Function Documentation

◆ clear_selections_for_object_siblings()

void zrythm::structure::tracks::Tracklist::clear_selections_for_object_siblings ( const ArrangerObject::Uuid & object_id )

Clears either the timeline selections or the clip editor selections.

Parameters

object_id The object that is part of the target selections.

◆ collection()

TrackCollection * zrythm::structure::tracks::Tracklist::collection ( ) const

inline

Definition at line 47 of file tracklist.h.

◆ get_track()

std::optional< TrackPtrVariant > zrythm::structure::tracks::Tracklist::get_track ( const TrackUuid & id ) const

inline

Definition at line 94 of file tracklist.h.

◆ get_track_route_target()

auto zrythm::structure::tracks::Tracklist::get_track_route_target ( const TrackUuid & source_track ) const

inline

Definition at line 167 of file tracklist.h.

◆ get_visible_track_after_delta()

std::optional< TrackPtrVariant > zrythm::structure::tracks::Tracklist::get_visible_track_after_delta	(	Track::Uuid	track_id,
		int	delta ) const

Returns the Track after delta visible Track's.

Negative delta searches backwards.

This function searches tracks only in the same Tracklist as the given one (ie, pinned or not).

◆ hasChannel()

Q_INVOKABLE bool zrythm::structure::tracks::Tracklist::hasChannel ( const Track * track ) const

inline

Definition at line 69 of file tracklist.h.

◆ is_track_pinned() [1/2]

bool zrythm::structure::tracks::Tracklist::is_track_pinned ( int index ) const

inline

Returns whether the track at index is pinned.

Definition at line 156 of file tracklist.h.

◆ is_track_pinned() [2/2]

bool zrythm::structure::tracks::Tracklist::is_track_pinned ( Track::Uuid track_id ) const

inline

Definition at line 161 of file tracklist.h.

◆ isTrackPinned()

Q_INVOKABLE bool zrythm::structure::tracks::Tracklist::isTrackPinned ( const Track * track ) const

inline

Definition at line 59 of file tracklist.h.

◆ mark_track_for_bounce()

void zrythm::structure::tracks::Tracklist::mark_track_for_bounce	(	TrackPtrVariant	track_var,
		bool	bounce,
		bool	mark_regions,
		bool	mark_children,
		bool	mark_parents )

Marks the track for bouncing.

Parameters

mark_children	Whether to mark all children tracks as well. Used when exporting stems on the specific track stem only. IMPORTANT: Track.bounce_to_master must be set beforehand if this is true.
mark_parents	Whether to mark all parent tracks as well.

◆ multiply_track_heights()

bool zrythm::structure::tracks::Tracklist::multiply_track_heights	(	double	multiplier,
		bool	visible_only,
		bool	check_only,
		bool	fire_events )

Multiplies all tracks' heights and returns if the operation was valid.

Parameters

visible_only Only apply to visible tracks.

◆ pinnedTracksCutoff()

int zrythm::structure::tracks::Tracklist::pinnedTracksCutoff ( ) const

inline

Definition at line 76 of file tracklist.h.

◆ setPinnedTracksCutoff()

void zrythm::structure::tracks::Tracklist::setPinnedTracksCutoff ( int index )

inline

Definition at line 77 of file tracklist.h.

◆ should_be_visible()

bool zrythm::structure::tracks::Tracklist::should_be_visible ( const Track::Uuid & track_id ) const

Returns whether the track should be visible.

Takes into account Track.visible and whether any of the track's foldable parents are folded.

◆ shouldBeVisible()

Q_INVOKABLE bool zrythm::structure::tracks::Tracklist::shouldBeVisible ( const Track * track ) const

inline

Definition at line 64 of file tracklist.h.

◆ singletonTracks()

SingletonTracks * zrythm::structure::tracks::Tracklist::singletonTracks ( ) const

inline

Definition at line 49 of file tracklist.h.

◆ trackRouting()

TrackRouting * zrythm::structure::tracks::Tracklist::trackRouting ( ) const

inline

Definition at line 74 of file tracklist.h.

Property Documentation

◆ collection

zrythm::structure::tracks::TrackCollection * zrythm::structure::tracks::Tracklist::collection

read

Definition at line 29 of file tracklist.h.

◆ pinnedTracksCutoff

int zrythm::structure::tracks::Tracklist::pinnedTracksCutoff

readwrite

Definition at line 31 of file tracklist.h.

◆ singletonTracks

zrythm::structure::tracks::SingletonTracks * zrythm::structure::tracks::Tracklist::singletonTracks

read

Definition at line 28 of file tracklist.h.

◆ trackRouting

QML_ELEMENT zrythm::structure::tracks::TrackRouting * zrythm::structure::tracks::Tracklist::trackRouting

read

Definition at line 26 of file tracklist.h.

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

src/structure/tracks/tracklist.h

Public Types

Public Member Functions

Properties

Friends

Detailed Description

Member Typedef Documentation

◆ ArrangerObject

◆ ArrangerObjectPtrVariant

Member Function Documentation

◆ clear_selections_for_object_siblings()

◆ collection()

◆ get_track()

◆ get_track_route_target()

◆ get_visible_track_after_delta()

◆ hasChannel()

◆ is_track_pinned() [1/2]

◆ is_track_pinned() [2/2]

◆ isTrackPinned()

◆ mark_track_for_bounce()

◆ multiply_track_heights()

◆ pinnedTracksCutoff()

◆ setPinnedTracksCutoff()

◆ should_be_visible()

◆ shouldBeVisible()

◆ singletonTracks()

◆ trackRouting()

Property Documentation

◆ collection

◆ pinnedTracksCutoff

◆ singletonTracks

◆ trackRouting