Zrythm v2.0.0-DEV
a highly automated and intuitive digital audio workstation
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Properties | Friends
ClipEditor Class Referencefinal
GUI Backend

Backend for the clip editor part of the UI. More...

#include <src/gui/backend/backend/clip_editor.h>

Inheritance diagram for ClipEditor:
Inheritance graph
[legend]
Collaboration diagram for ClipEditor:
Collaboration graph
[legend]

Public Member Functions

 ClipEditor (ArrangerObjectRegistry &reg, TrackResolver track_resolver, QObject *parent=nullptr)
 
PianoRoll * getPianoRoll () const
 
ChordEditor * getChordEditor () const
 
AudioClipEditor * getAudioClipEditor () const
 
AutomationEditor * getAutomationEditor () const
 
QVariant getRegion () const
 
void setRegion (QVariant region)
 
Q_INVOKABLE void unsetRegion ()
 
Q_SIGNAL void regionChanged (QVariant region)
 
QVariant getTrack () const
 
Q_SIGNAL void trackChanged (QVariant track)
 
void init_loaded ()
 Inits the ClipEditor after a Project is loaded.
 
void init ()
 Inits the clip editor.
 
void set_region (Region::Uuid region_id)
 Sets the track and refreshes the piano roll widgets.
 
bool has_region () const
 
std::optional< RegionPtrVariant > get_region () const
 
std::optional< Region::Uuid > get_region_id () const
 
std::optional< TrackPtrVariant > get_track () const
 
std::optional< TrackUuid > get_track_id () const
 
void unset_region_if_belongs_to_track (const TrackUuid &track_id)
 Unsets the region if it belongs to the given track.
 
void set_caches ()
 To be called when recalculating the graph.
 

Data Fields

ArrangerObjectRegistry & object_registry_
 
TrackResolver track_resolver_
 
std::optional< ArrangerObject::Uuid > region_id_
 Region currently attached to the clip editor.
 
PianoRoll * piano_roll_ {}
 
AudioClipEditor * audio_clip_editor_ {}
 
AutomationEditor * automation_editor_ {}
 
ChordEditor * chord_editor_ {}
 
std::optional< TrackPtrVariant > track_
 

Properties

QML_ELEMENT QVariant region
 
QVariant track
 
PianoRoll * pianoRoll
 
ChordEditor * chordEditor
 
AudioClipEditor * audioEditor
 
AutomationEditor * automationEditor
 

Friends

void init_from (ClipEditor &obj, const ClipEditor &other, utils::ObjectCloneType clone_type)
 
void to_json (nlohmann::json &j, const ClipEditor &editor)
 
void from_json (const nlohmann::json &j, ClipEditor &editor)
 

Detailed Description

Backend for the clip editor part of the UI.

Definition at line 26 of file clip_editor.h.

Member Function Documentation

◆ get_region_id()

std::optional< Region::Uuid > ClipEditor::get_region_id ( ) const
inline

Definition at line 106 of file clip_editor.h.

◆ getAudioClipEditor()

AudioClipEditor * ClipEditor::getAudioClipEditor ( ) const
inline

Definition at line 60 of file clip_editor.h.

◆ getAutomationEditor()

AutomationEditor * ClipEditor::getAutomationEditor ( ) const
inline

Definition at line 61 of file clip_editor.h.

◆ getChordEditor()

ChordEditor * ClipEditor::getChordEditor ( ) const
inline

Definition at line 59 of file clip_editor.h.

◆ getPianoRoll()

PianoRoll * ClipEditor::getPianoRoll ( ) const
inline

Definition at line 58 of file clip_editor.h.

◆ getRegion()

QVariant ClipEditor::getRegion ( ) const
inline

Definition at line 63 of file clip_editor.h.

◆ has_region()

bool ClipEditor::has_region ( ) const
inline

Definition at line 103 of file clip_editor.h.

◆ set_region()

void ClipEditor::set_region ( Region::Uuid region_id)
inline

Sets the track and refreshes the piano roll widgets.

Definition at line 94 of file clip_editor.h.

Friends And Related Symbol Documentation

◆ from_json

void from_json ( const nlohmann::json & j,
ClipEditor & editor )
friend

Definition at line 150 of file clip_editor.h.

◆ init_from

void init_from ( ClipEditor & obj,
const ClipEditor & other,
utils::ObjectCloneType clone_type )
friend

Definition at line 123 of file clip_editor.h.

◆ to_json

void to_json ( nlohmann::json & j,
const ClipEditor & editor )
friend

Definition at line 142 of file clip_editor.h.

Field Documentation

◆ audio_clip_editor_

AudioClipEditor* ClipEditor::audio_clip_editor_ {}

Definition at line 171 of file clip_editor.h.

◆ automation_editor_

AutomationEditor* ClipEditor::automation_editor_ {}

Definition at line 172 of file clip_editor.h.

◆ chord_editor_

ChordEditor* ClipEditor::chord_editor_ {}

Definition at line 173 of file clip_editor.h.

◆ object_registry_

ArrangerObjectRegistry& ClipEditor::object_registry_

Definition at line 164 of file clip_editor.h.

◆ piano_roll_

PianoRoll* ClipEditor::piano_roll_ {}

Definition at line 170 of file clip_editor.h.

◆ region_id_

std::optional<ArrangerObject::Uuid> ClipEditor::region_id_

Region currently attached to the clip editor.

Definition at line 168 of file clip_editor.h.

◆ track_

std::optional<TrackPtrVariant> ClipEditor::track_

Definition at line 178 of file clip_editor.h.

◆ track_resolver_

TrackResolver ClipEditor::track_resolver_

Definition at line 165 of file clip_editor.h.

Property Documentation

◆ audioEditor

AudioClipEditor * ClipEditor::audioEditor
read

Definition at line 35 of file clip_editor.h.

◆ automationEditor

AutomationEditor * ClipEditor::automationEditor
read

Definition at line 37 of file clip_editor.h.

◆ chordEditor

ChordEditor * ClipEditor::chordEditor
read

Definition at line 34 of file clip_editor.h.

◆ pianoRoll

PianoRoll * ClipEditor::pianoRoll
read

Definition at line 33 of file clip_editor.h.

◆ region

QML_ELEMENT QVariant ClipEditor::region
readwrite

Definition at line 30 of file clip_editor.h.

◆ track

QVariant ClipEditor::track
read

Definition at line 32 of file clip_editor.h.

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