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

Marker for the MarkerTrack. More...

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

Inheritance diagram for zrythm::structure::arrangement::Marker:
Collaboration diagram for zrythm::structure::arrangement::Marker:

Public Types

enum class  MarkerType : std::uint8_t { Start , End , Custom }
 Marker type. More...
Public Types inherited from zrythm::structure::arrangement::ArrangerObject
enum class  Type : basic_enum_base_type_t {
  MidiRegion , AudioRegion , ChordRegion , AutomationRegion ,
  MidiNote , ChordObject , ScaleObject , Marker ,
  AutomationPoint , AudioSourceObject , TempoObject , TimeSignatureObject
}
 The type of the object. More...

Public Member Functions

 Marker (const dsp::TempoMap &tempo_map, MarkerType type, QObject *parent=nullptr)
auto markerType () const
Q_INVOKABLE bool isStartMarker () const
Q_INVOKABLE bool isEndMarker () const
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::AtomicPositionQmlAdapterposition () const
ArrangerObjectBoundsbounds () const
ArrangerObjectLoopRangeloopRange () const
ArrangerObjectNamename () const
ArrangerObjectColorcolor () const
ArrangerObjectMuteFunctionalitymute () const
ArrangerObjectFadeRangefadeRange () const
Q_SIGNAL void propertiesChanged ()
 Emitted when any of the properties of the object changed.
ArrangerObjectparentObject () 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 & operator= (const UuidIdentifiableObject &other)=default
auto get_uuid () const

Properties

Marker::MarkerType markerType
Properties inherited from zrythm::structure::arrangement::ArrangerObject
QML_ELEMENT zrythm::structure::arrangement::ArrangerObjectparentObject
zrythm::structure::arrangement::ArrangerObject::Type type
zrythm::dsp::AtomicPositionQmlAdapterposition
zrythm::structure::arrangement::ArrangerObjectBoundsbounds
zrythm::structure::arrangement::ArrangerObjectLoopRangeloopRange
zrythm::structure::arrangement::ArrangerObjectNamename
zrythm::structure::arrangement::ArrangerObjectColorcolor
zrythm::structure::arrangement::ArrangerObjectMuteFunctionalitymute
zrythm::structure::arrangement::ArrangerObjectFadeRangefadeRange

Friends

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

Additional Inherited Members

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.

Detailed Description

Marker for the MarkerTrack.

Definition at line 15 of file marker.h.

Member Enumeration Documentation

◆ MarkerType

enum class zrythm::structure::arrangement::Marker::MarkerType : std::uint8_t
strong

Marker type.

Enumerator
Start 

Song start Marker that cannot be deleted.

End 

Song end Marker that cannot be deleted.

Custom 

Custom Marker.

Definition at line 26 of file marker.h.

Member Function Documentation

◆ isEndMarker()

Q_INVOKABLE bool zrythm::structure::arrangement::Marker::isEndMarker ( ) const
inline

Definition at line 52 of file marker.h.

◆ isStartMarker()

Q_INVOKABLE bool zrythm::structure::arrangement::Marker::isStartMarker ( ) const
inline

Definition at line 48 of file marker.h.

◆ markerType()

auto zrythm::structure::arrangement::Marker::markerType ( ) const
inline

Definition at line 46 of file marker.h.

◆ from_json

void from_json ( const nlohmann::json & j,
Marker & m )
friend

Definition at line 69 of file marker.h.

◆ to_json

void to_json ( nlohmann::json & j,
const Marker & m )
friend

Definition at line 64 of file marker.h.

Property Documentation

◆ markerType

Marker::MarkerType zrythm::structure::arrangement::Marker::markerType
read

Definition at line 18 of file marker.h.


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