marker.h

// SPDX-FileCopyrightText: © 2019-2021, 2024-2026 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "structure/arrangement/arranger_object.h"
#include "utils/icloneable.h"
 
#include <nlohmann/json_fwd.hpp>
 
namespace zrythm::structure::arrangement
{

class Marker final : public ArrangerObject
{
  Q_OBJECT
  Q_PROPERTY (Marker::MarkerType markerType READ markerType CONSTANT)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  enum class MarkerType : std::uint8_t
  {
    Start,
    End,
    Custom,
  };
  Q_ENUM (MarkerType)
 
  Marker (
    const dsp::TempoMapWrapper &tempo_map_wrapper,
    MarkerType                  type,
    QObject *                   parent = nullptr);
 
  dsp::TimelinePosition * position () const override
  {
    return static_cast<dsp::TimelinePosition *> (ArrangerObject::position ());
  }
 
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  auto markerType () const { return marker_type_; }
 
  Q_INVOKABLE bool isStartMarker () const
  {
    return marker_type_ == MarkerType::Start;
  }
  Q_INVOKABLE bool isEndMarker () const
  {
    return marker_type_ == MarkerType::End;
  }
 
  // ========================================================================
 
private:
  friend void
  init_from (Marker &obj, const Marker &other, utils::ObjectCloneType clone_type);
 
  static constexpr auto kMarkerTypeKey = "markerType"sv;
  friend void           to_json (nlohmann::json &j, const Marker &m);
  friend void           from_json (const nlohmann::json &j, Marker &m);
 
private:
  MarkerType marker_type_ = MarkerType::Custom;
 
  BOOST_DESCRIBE_CLASS (Marker, (ArrangerObject), (), (), (marker_type_))
};
 
} // namespace zrythm::structure::arrangement