playevent.h

Go to the documentation of this file.

//=============================================================================
//  MuseScore
//  Music Composition & Notation
//
//  Copyright (C) 2019 Werner Schweer and others
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License version 2
//  as published by the Free Software Foundation and appearing in
//  the file LICENCE.GPL
//=============================================================================

#ifndef __PLUGIN_API_PLAYEVENT_H__
#define __PLUGIN_API_PLAYEVENT_H__

#include "libmscore/noteevent.h"
#include "elements.h"

namespace Ms {
namespace PluginAPI {

class Note;

//---------------------------------------------------------
//   PlayEvent
//    Wrapper class for internal Ms::NoteEvent
//
//   This is based on the wrapper in excerpt.h.
//---------------------------------------------------------

class PlayEvent : public QObject {
      Q_OBJECT
      Q_PROPERTY(int pitch READ pitch WRITE setPitch)
      Q_PROPERTY(int ontime READ ontime WRITE setOntime)
      Q_PROPERTY(int len READ len WRITE setLen)
      Q_PROPERTY(int offtime READ offtime)

   protected:
      Ms::NoteEvent* ne;
      Note* parentNote;

   public:

      PlayEvent(Ms::NoteEvent* _ne = new Ms::NoteEvent(), Note* _parent = nullptr)
         : QObject(), ne(_ne), parentNote(_parent) {}
      // Delete the NoteEvent if parentless.
      virtual ~PlayEvent() { if (parentNote == nullptr) delete ne; }

      const Ms::NoteEvent& getNoteEvent() { return *ne; }
      void setParentNote(Note* parent) { this->parentNote = parent; }
      Note* note() { return parentNote; }

      int pitch() const { return ne->pitch(); }
      int ontime() const { return ne->ontime(); }
      int offtime() const { return ne->offtime(); }
      int len() const { return ne->len(); }
      void setPitch(int v);
      void setOntime(int v);
      void setLen(int v);
};

//---------------------------------------------------------
//   wrap
//---------------------------------------------------------

inline PlayEvent* playEventWrap(Ms::NoteEvent* t, Note* parent)
      {
      PlayEvent* w = t ? new PlayEvent(t, parent) : nullptr;
      // All wrapper objects should belong to JavaScript code.
      QQmlEngine::setObjectOwnership(w, QQmlEngine::JavaScriptOwnership);
      return w;
      }

//---------------------------------------------------------
//   QML access to containers of NoteEvent
//
//   QmlNoteEventsListAccess provides a convenience interface
//   for QQmlListProperty providing access to plugins for NoteEvent
//   Containers.
//
//   Based on QmlListAccess in excerpt.h
//---------------------------------------------------------


class QmlPlayEventsListAccess : public QQmlListProperty<PlayEvent> {
   public:
   QmlPlayEventsListAccess(QObject* obj, NoteEventList& container)
         : QQmlListProperty<PlayEvent>(obj, &container, &append, &count, &at, &clear) {};

   static int count(QQmlListProperty<PlayEvent>* l)  { return int(static_cast<NoteEventList*>(l->data)->size()); }
   static PlayEvent* at(QQmlListProperty<PlayEvent>* l, int i) { return playEventWrap(&(*(static_cast<NoteEventList*>(l->data)))[i], reinterpret_cast<Note*>(l->object)); }
   static void clear(QQmlListProperty<PlayEvent>* l);
   static void append(QQmlListProperty<PlayEvent>* l, PlayEvent *v);
};

inline QmlPlayEventsListAccess wrapPlayEventsContainerProperty(QObject* obj, NoteEventList& c)
      {
      return QmlPlayEventsListAccess(obj, c);
      }

} // namespace PluginAPI
} // namespace Ms
#endif