Loading...
Searching...
No Matches
zrythm::structure::tracks::FoldableTrack Class Reference
Abstract base for a foldable track. More...
#include <src/structure/tracks/foldable_track.h>
Inheritance diagram for zrythm::structure::tracks::FoldableTrack:
Collaboration diagram for zrythm::structure::tracks::FoldableTrack:
Public Types | |
| enum class | MixerStatus { Muted , Soloed , ImpliedSoloed , Listened } |
| Public Types inherited from zrythm::structure::tracks::Track | |
| using | Plugin = plugins::Plugin |
| using | PluginUuid = Plugin::Uuid |
| using | PortType = dsp::PortType |
| using | PluginRegistry = plugins::PluginRegistry |
| using | PluginPtrVariant = PluginRegistry::VariantType |
| using | PluginSlot = plugins::PluginSlot |
| using | ArrangerObject = structure::arrangement::ArrangerObject |
| using | ArrangerObjectPtrVariant |
| using | ArrangerObjectRegistry = structure::arrangement::ArrangerObjectRegistry |
| using | Type = ::TrackTypeWrapper::TrackType |
| using | TrackSelectionStatusGetter = std::function<bool (const Track::Uuid &)> |
| using | Color = utils::Color |
Public Member Functions | |
| bool | is_status (MixerStatus status) const |
| Used to check if soloed/muted/etc. | |
| void | set_folded (bool folded, bool trigger_undo, bool auto_select, bool fire_events) |
| Sets track folded and optionally adds the action to the undo stack. | |
| Public Member Functions inherited from zrythm::structure::tracks::Track | |
| bool | has_piano_roll () const |
| bool | is_folder () const |
| bool | is_audio_group () const |
| bool | is_midi_group () const |
| bool | is_audio_bus () const |
| bool | is_midi_bus () const |
| bool | is_modulator () const |
| bool | is_chord () const |
| bool | is_marker () const |
| bool | is_audio () const |
| bool | is_instrument () const |
| bool | is_midi () const |
| bool | is_master () const |
| bool | is_deletable () const |
| bool | is_copyable () const |
| template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>> | |
| double | get_full_visible_height (this DerivedT &&self) |
| Returns the full visible height (main height + height of all visible automation tracks + height of all visible lanes). | |
| template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>> | |
| bool | multiply_heights (this DerivedT &&self, double multiplier, bool visible_only, bool check_only) |
| bool | can_be_group_target () const |
| bool | is_frozen () const |
| template<arrangement::RegionObject RegionT, FinalClass SelfT> | |
| void | insert_region (this SelfT &self, arrangement::ArrangerObjectUuidReference region_ref, AutomationTrack *at, std::optional< int > lane_pos, std::optional< int > idx, bool gen_name) |
| Inserts a Region to the given lane or AutomationTrack of the track, at the given index. | |
| template<arrangement::RegionObject RegionT> | |
| void | add_region (this auto &self, auto region_ref, AutomationTrack *at, std::optional< int > lane_pos, bool gen_name) |
| Appends a Region to the given lane or AutomationTrack of the track. | |
| void | append_objects (std::vector< ArrangerObjectPtrVariant > &objects) const |
Appends all the objects in the track to objects. | |
| void | unselect_all () |
| Unselects all arranger objects in the track. | |
| template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>> | |
| bool | contains_uninstantiated_plugin (this DerivedT &&self) |
| virtual void | clear_objects () |
| Removes all objects recursively from the track. | |
| virtual void | temporary_virtual_method_hack () const =0 |
| utils::Utf8String | get_name () const |
| Getter for the track name. | |
| bool | set_name_with_action_full (const utils::Utf8String &name) |
| Internally called by set_name_with_action(). | |
| void | set_name_with_action (const utils::Utf8String &name) |
| Setter to be used by the UI to create an undoable action. | |
| void | set_name (const Tracklist &tracklist, const utils::Utf8String &name, bool pub_events) |
| Setter for the track name. | |
| utils::Utf8String | get_unique_name (const Tracklist &tracklist, const utils::Utf8String &name) |
| Returns a unique name for a new track based on the given name. | |
| virtual void | get_regions_in_range (std::vector< arrangement::ArrangerObjectUuidReference > ®ions, std::optional< signed_frame_t > p1, std::optional< signed_frame_t > p2) |
| Returns all the regions inside the given range, or all the regions if both p1 and p2 are NULL. | |
| auto | get_input_signal_type () const |
| auto | get_output_signal_type () const |
| template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>> | |
| void | get_plugins (this DerivedT &&self, std::vector< zrythm::plugins::Plugin * > &arr) |
| Fills in the given array with all plugins in the track. | |
| void | track_freeze (bool freeze) |
| Freezes or unfreezes the track. | |
| bool | is_enabled () const |
| bool | enabled () const |
| bool | disabled () const |
| int | get_total_bars (const engine::session::Transport &transport, int total_bars) const |
| void | set_caches (CacheType types) |
| Set various caches (snapshots, track name hash, plugin input/output ports, etc). | |
| utils::Utf8String | generate_window_name_for_plugin (const plugins::Plugin &plugin) const |
| utils::Utf8String | get_full_designation_for_port (const dsp::Port &port) const |
| virtual bool | currently_muted () const |
| virtual bool | currently_listened () const |
| virtual bool | get_implied_soloed () const |
| Returns whether the track is not soloed on its own but its direct out (or its direct out's direct out, etc.) is soloed. | |
| virtual bool | currently_soloed () const |
| void | set_selection_status_getter (TrackSelectionStatusGetter getter) |
| void | unset_selection_status_getter () |
| auto & | get_plugin_registry () const |
| auto & | get_plugin_registry () |
| auto & | get_port_registry () const |
| auto & | get_port_registry () |
| auto & | get_param_registry () const |
| auto & | get_param_registry () |
| auto & | get_object_registry () const |
| auto & | get_object_registry () |
| auto | get_type () const |
| auto | get_icon_name () const |
| Public Member Functions inherited from zrythm::utils::UuidIdentifiableObject< Track > | |
| UuidIdentifiableObject & | operator= (const UuidIdentifiableObject &other)=default |
| auto | get_uuid () const |
Data Fields | |
| int | size_ = 1 |
| Number of tracks inside this track. | |
| bool | folded_ = false |
| Whether currently folded. | |
Friends | |
| void | to_json (nlohmann::json &j, const FoldableTrack &track) |
| void | from_json (const nlohmann::json &j, FoldableTrack &track) |
Additional Inherited Members | |
| Static Public Member Functions inherited from zrythm::structure::tracks::Track | |
| static constexpr bool | type_can_have_direct_out (Type type) |
| static bool | type_can_have_region_type (Type type, ArrangerObject::Type region_type) |
| static constexpr bool | type_is_copyable (Type type) |
| static constexpr bool | type_is_deletable (Type type) |
| Returns whether a track of the given type should be deletable by the user. | |
| static Type | type_get_from_plugin_descriptor (const zrythm::plugins::PluginDescriptor &descr) |
| static consteval bool | type_has_mono_compat_switch (const Type tt) |
| static constexpr bool | type_is_compatible_for_moving (const Type type1, const Type type2) |
Returns if regions in tracks from type1 can be moved to type2. | |
| static constexpr bool | type_has_piano_roll (const Type type) |
| Returns if the Track should have a piano roll. | |
| static constexpr bool | type_has_inputs (const Type type) |
| Returns if the Track should have an inputs selector. | |
| static bool | type_can_be_group_target (const Type type) |
| Returns if the Track can be a direct route target. | |
| template<typename T> | |
| static consteval Type | get_type_for_class () |
| static Track * | from_variant (const TrackPtrVariant &variant) |
| static bool | is_plugin_descriptor_valid_for_slot_type (const plugins::PluginDescriptor &descr, zrythm::plugins::PluginSlotType slot_type, Track::Type track_type) |
Returns if descr can be dropped at slot_type in a track of type track_type. | |
| Static Public Attributes inherited from zrythm::structure::tracks::Track | |
| static constexpr int | MIN_HEIGHT = 26 |
| static constexpr int | DEF_HEIGHT = 52 |
| Protected Member Functions inherited from zrythm::structure::tracks::Track | |
| Track (Type type, PortType in_signal_type, PortType out_signal_type, BaseTrackDependencies dependencies) | |
| Constructor to be used by subclasses. | |
| virtual void | set_playback_caches () |
| Set the playback caches for a track. | |
| void | add_region_if_in_range (std::optional< signed_frame_t > p1, std::optional< signed_frame_t > p2, std::vector< arrangement::ArrangerObjectUuidReference > ®ions, arrangement::ArrangerObjectUuidReference region) |
| Protected Attributes inherited from zrythm::structure::tracks::Track | |
| BaseTrackDependencies | base_dependencies_ |
| Type | type_ {} |
| The type of track this is. | |
| utils::Utf8String | name_ |
| Track name, used in channel too. | |
| utils::Utf8String | icon_name_ |
| Icon name of the track. | |
| bool | visible_ = true |
| Whole Track is visible or not. | |
| bool | filtered_ = false |
| Track will be hidden if true (temporary and not serializable). | |
| double | main_height_ { DEF_HEIGHT } |
| Height of the main part (without lanes). | |
| bool | enabled_ = true |
| Active (enabled) or not. | |
| Color | color_ |
| Track color. | |
| PortType | in_signal_type_ = {} |
| The input signal type (eg audio bus tracks have audio input signals). | |
| PortType | out_signal_type_ = {} |
| The output signal type (eg midi tracks have MIDI output signals). | |
| utils::Utf8String | comment_ |
| User comments. | |
| std::optional< dsp::FileAudioSourceUuidReference > | frozen_clip_id_ |
| Pool ID of the clip if track is frozen (unset if not frozen). | |
| std::optional< TrackSelectionStatusGetter > | track_selection_status_getter_ |
| Track selection status getter. | |
Detailed Description
Abstract base for a foldable track.
Definition at line 13 of file foldable_track.h.
Member Enumeration Documentation
◆ MixerStatus
|
strong |
Definition at line 16 of file foldable_track.h.
Constructor & Destructor Documentation
◆ FoldableTrack()
|
inlinenoexcept |
Definition at line 25 of file foldable_track.h.
Friends And Related Symbol Documentation
◆ from_json
|
friend |
Definition at line 48 of file foldable_track.h.
◆ to_json
|
friend |
Definition at line 43 of file foldable_track.h.
Field Documentation
◆ folded_
| bool zrythm::structure::tracks::FoldableTrack::folded_ = false |
Whether currently folded.
Definition at line 63 of file foldable_track.h.
◆ size_
| int zrythm::structure::tracks::FoldableTrack::size_ = 1 |
Number of tracks inside this track.
1 means no other tracks inside.
Definition at line 60 of file foldable_track.h.
The documentation for this class was generated from the following file:
- src/structure/tracks/foldable_track.h
