bounded_object.h

// SPDX-FileCopyrightText: © 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <string_view>
 
#include "dsp/atomic_position_qml_adapter.h"
#include "utils/icloneable.h"
 
#include <boost/describe/class.hpp>
#include <nlohmann/json_fwd.hpp>
 
using std::literals::string_view_literals::operator""sv;
 
namespace zrythm::structure::arrangement
{
 
using namespace std::string_view_literals;

class ArrangerObjectBounds : public QObject
{
  Q_OBJECT
  Q_PROPERTY (
    zrythm::dsp::AtomicPositionQmlAdapter * length READ length CONSTANT)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  ArrangerObjectBounds (
    const dsp::AtomicPositionQmlAdapter &start_position,
    QObject *                            parent = nullptr);
  ~ArrangerObjectBounds () override = default;
  Q_DISABLE_COPY_MOVE (ArrangerObjectBounds)
 
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  dsp::AtomicPositionQmlAdapter * length () const
  {
    return length_adapter_.get ();
  }
 
  // Convenience method
  Q_INVOKABLE void setLengthTicks (double ticks)
  {
    length ()->setTicks (ticks);
  }
 
  // ========================================================================
 
  units::sample_t get_end_position_samples (bool end_position_inclusive) const;

  [[nodicard]] bool
  is_hit (const units::sample_t frames, bool object_end_pos_inclusive = false)
    const;

  bool is_hit_by_range (
    std::pair<units::sample_t, units::sample_t> global_frames,
    bool                                        range_start_inclusive = true,
    bool                                        range_end_inclusive = true,
    bool object_end_pos_inclusive = false) const;
 
private:
  friend void init_from (
    ArrangerObjectBounds       &obj,
    const ArrangerObjectBounds &other,
    utils::ObjectCloneType      clone_type);
 
  static constexpr auto kLengthKey = "length"sv;
  friend void to_json (nlohmann::json &j, const ArrangerObjectBounds &object);
  friend void from_json (const nlohmann::json &j, ArrangerObjectBounds &object);
 
  auto position () const -> const dsp::AtomicPositionQmlAdapter *
  {
    return std::addressof (position_);
  }
 
private:
  const dsp::AtomicPositionQmlAdapter &position_;

  dsp::AtomicPosition                                    length_;
  utils::QObjectUniquePtr<dsp::AtomicPositionQmlAdapter> length_adapter_;
 
  BOOST_DESCRIBE_CLASS (ArrangerObjectBounds, (), (), (), (length_))
};
 
} // namespace zrythm::structure::arrangement