Zrythm v2.0.0-alpha.1
a highly automated and intuitive digital audio workstation
Loading...
Searching...
No Matches
zrythm::structure::arrangement::MidiRegion Class Referencefinal

A Region containing MIDI events. More...

#include <src/structure/arrangement/midi_region.h>

Inheritance diagram for zrythm::structure::arrangement::MidiRegion:
Inheritance graph
[legend]
Collaboration diagram for zrythm::structure::arrangement::MidiRegion:
Collaboration graph
[legend]

Public Member Functions

 MidiRegion (const dsp::TempoMap &tempo_map, utils::IObjectRegistry &object_registry, QObject *parent=nullptr)
Q_SIGNAL void contentChanged ()
std::string get_field_name_for_serialization (const MidiNote *) const override
std::string get_field_name_for_serialization (const MidiControlEvent *) const override
std::vector< ArrangerObjectListModel * > get_child_list_models () const override
Public Member Functions inherited from zrythm::structure::arrangement::ArrangerObject
bool is_start_hit_by_range (const units::sample_t frames_start, const units::sample_t frames_end, bool range_start_inclusive=true, bool range_end_inclusive=false) const
auto type () const
dsp::AtomicPositionQmlAdapter * position () const
ArrangerObjectBounds * bounds () const
ArrangerObjectLoopRange * loopRange () const
ArrangerObjectName * name () const
ArrangerObjectColor * color () const
ArrangerObjectMuteFunctionality * mute () const
ArrangerObjectFadeRange * fadeRange () const
Q_SIGNAL void propertiesChanged ()
 Emitted when any of the properties of the object changed.
ArrangerObject * parentObject () const
void setParentObject (ArrangerObject *object)
Q_SIGNAL void parentObjectChanged (QObject *parentObject)
auto & get_tempo_map () const
Public Member Functions inherited from zrythm::utils::UuidIdentifiableObject< ArrangerObject >
 UuidIdentifiableObject (QObject *parent=nullptr)
auto get_uuid () const
Public Member Functions inherited from zrythm::utils::UuidIdentifiableBase
 UuidIdentifiableBase (QObject *parent=nullptr)
 UuidIdentifiableBase (const QUuid &id, QObject *parent=nullptr)
QUuid raw_uuid () const
Public Member Functions inherited from zrythm::structure::arrangement::ArrangerObjectOwner< MidiNote >
 ArrangerObjectOwner (utils::IObjectRegistry &registry, T &derived)
auto & get_children_vector () const
auto get_children_view () const
auto get_sorted_children_view () const
void add_ticks_to_children (double ticks)
bool contains_object (const ArrangerObject::Uuid &id) const
 O(1) lookup if an object with the given ID exists.
ArrangerObjectListModel * get_model () const
ArrangerObjectUuidReference remove_object (const ArrangerObject::Uuid &id)
void insert_object (const ArrangerObjectUuidReference &obj_ref, int idx)
void add_object (const ArrangerObjectUuidReference &obj_ref)
void clear_objects ()
virtual std::string get_field_name_for_serialization (const ChildT *) const=0
 Get the children field name to be used during serialization/deserialization.
Public Member Functions inherited from zrythm::structure::arrangement::ArrangerObjectOwner< MidiControlEvent >
 ArrangerObjectOwner (utils::IObjectRegistry &registry, T &derived)
auto & get_children_vector () const
auto get_children_view () const
auto get_sorted_children_view () const
void add_ticks_to_children (double ticks)
bool contains_object (const ArrangerObject::Uuid &id) const
 O(1) lookup if an object with the given ID exists.
ArrangerObjectListModel * get_model () const
ArrangerObjectUuidReference remove_object (const ArrangerObject::Uuid &id)
void insert_object (const ArrangerObjectUuidReference &obj_ref, int idx)
void add_object (const ArrangerObjectUuidReference &obj_ref)
void clear_objects ()
virtual std::string get_field_name_for_serialization (const ChildT *) const=0
 Get the children field name to be used during serialization/deserialization.

Friends

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

Additional Inherited Members

Public Types inherited from zrythm::structure::arrangement::ArrangerObject
enum class  Type : std::uint8_t {
  MidiRegion , AudioRegion , ChordRegion , AutomationRegion ,
  MidiControlEvent , MidiNote , ChordObject , ScaleObject ,
  Marker , AutomationPoint , AudioSourceObject , TempoObject ,
  TimeSignatureObject
}
 The type of the object. More...
Public Types inherited from zrythm::utils::UuidIdentifiableObject< ArrangerObject >
using uuid_base_type
 Exposes the CRTP parameter for concept checking.
Public Types inherited from zrythm::structure::arrangement::ArrangerObjectOwner< MidiNote >
using ArrangerObjectChildType
Public Types inherited from zrythm::structure::arrangement::ArrangerObjectOwner< MidiControlEvent >
using ArrangerObjectChildType
Protected Types inherited from zrythm::structure::arrangement::ArrangerObject
enum class  ArrangerObjectFeatures : std::uint8_t {
  Bounds = 1 << 0 , LoopingBit = 1 << 1 , Name = 1 << 2 , Color = 1 << 3 ,
  Mute = 1 << 4 , Fading = 1 << 5 , Looping = LoopingBit | Bounds , Region = Looping | Name | Color | Mute
}
Protected Member Functions inherited from zrythm::structure::arrangement::ArrangerObject
 ArrangerObject (Type type, const dsp::TempoMap &tempo_map, ArrangerObjectFeatures features, QObject *parent=nullptr) noexcept
 Construct a new ArrangerObject.
Protected Member Functions inherited from zrythm::utils::UuidIdentifiableBase
void set_raw_uuid (const QUuid &id)
Properties inherited from zrythm::structure::arrangement::ArrangerObject
QML_ELEMENT zrythm::structure::arrangement::ArrangerObject * parentObject
zrythm::structure::arrangement::ArrangerObject::Type type
zrythm::dsp::AtomicPositionQmlAdapter * position
zrythm::structure::arrangement::ArrangerObjectBounds * bounds
zrythm::structure::arrangement::ArrangerObjectLoopRange * loopRange
zrythm::structure::arrangement::ArrangerObjectName * name
zrythm::structure::arrangement::ArrangerObjectColor * color
zrythm::structure::arrangement::ArrangerObjectMuteFunctionality * mute
zrythm::structure::arrangement::ArrangerObjectFadeRange * fadeRange

Detailed Description

A Region containing MIDI events.

MidiRegion represents a region in the timeline that holds MIDI note and controller data. It is specific to instrument/MIDI tracks and can be constructed from a MIDI file or a chord descriptor.

Definition at line 20 of file midi_region.h.

Member Function Documentation

◆ get_child_list_models()

std::vector< ArrangerObjectListModel * > zrythm::structure::arrangement::MidiRegion::get_child_list_models ( ) const
inlineoverridevirtual

Reimplemented from zrythm::structure::arrangement::ArrangerObject.

Definition at line 60 of file midi_region.h.

◆ get_field_name_for_serialization() [1/2]

std::string zrythm::structure::arrangement::MidiRegion::get_field_name_for_serialization ( const MidiControlEvent * ) const
inlineoverride

Definition at line 55 of file midi_region.h.

◆ get_field_name_for_serialization() [2/2]

std::string zrythm::structure::arrangement::MidiRegion::get_field_name_for_serialization ( const MidiNote * ) const
inlineoverride

Definition at line 50 of file midi_region.h.

◆ from_json

void from_json ( const nlohmann::json & j,
MidiRegion & region )
friend

Definition at line 81 of file midi_region.h.

◆ to_json

void to_json ( nlohmann::json & j,
const MidiRegion & region )
friend

Definition at line 74 of file midi_region.h.

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