MuseScore  3.4
Music composition and notation
Public Member Functions | Protected Attributes | Properties | List of all members
Ms::PluginAPI::PlayEvent Class Reference

#include <playevent.h>

Inheritance diagram for Ms::PluginAPI::PlayEvent:
Inheritance graph
[legend]
Collaboration diagram for Ms::PluginAPI::PlayEvent:
Collaboration graph
[legend]

Public Member Functions

 PlayEvent (Ms::NoteEvent *_ne=new Ms::NoteEvent(), Note *_parent=nullptr)
 
virtual ~PlayEvent ()
 
const Ms::NoteEventgetNoteEvent ()
 
void setParentNote (Note *parent)
 
Notenote ()
 
int pitch () const
 
int ontime () const
 
int offtime () const
 
int len () const
 
void setPitch (int v)
 
void setOntime (int v)
 
void setLen (int v)
 

Protected Attributes

Ms::NoteEventne
 
NoteparentNote
 

Properties

int pitch
 The relative pitch to the note pitch. More...
 
int ontime
 Time to turn on the note event. More...
 
int len
 The length of time for the event. More...
 
int offtime
 Time note will turn off. More...
 

Detailed Description

Since
MuseScore 3.3

Constructor & Destructor Documentation

◆ PlayEvent()

Ms::PluginAPI::PlayEvent::PlayEvent ( Ms::NoteEvent _ne = new Ms::NoteEvent(),
Note _parent = nullptr 
)
inline

◆ ~PlayEvent()

virtual Ms::PluginAPI::PlayEvent::~PlayEvent ( )
inlinevirtual

Member Function Documentation

◆ getNoteEvent()

const Ms::NoteEvent& Ms::PluginAPI::PlayEvent::getNoteEvent ( )
inline

◆ len()

int Ms::PluginAPI::PlayEvent::len ( ) const
inline

◆ note()

Note* Ms::PluginAPI::PlayEvent::note ( )
inline

◆ offtime()

int Ms::PluginAPI::PlayEvent::offtime ( ) const
inline

◆ ontime()

int Ms::PluginAPI::PlayEvent::ontime ( ) const
inline

◆ pitch()

int Ms::PluginAPI::PlayEvent::pitch ( ) const
inline

◆ setLen()

void Ms::PluginAPI::PlayEvent::setLen ( int  v)

◆ setOntime()

void Ms::PluginAPI::PlayEvent::setOntime ( int  v)

◆ setParentNote()

void Ms::PluginAPI::PlayEvent::setParentNote ( Note parent)
inline

◆ setPitch()

void Ms::PluginAPI::PlayEvent::setPitch ( int  v)

Member Data Documentation

◆ ne

Ms::NoteEvent* Ms::PluginAPI::PlayEvent::ne
protected

◆ parentNote

Note* Ms::PluginAPI::PlayEvent::parentNote
protected

Property Documentation

◆ len

int Ms::PluginAPI::PlayEvent::len
readwrite

The length of time for the event.

This value is expressed in 1/1000 of the nominal note length.

Since
MuseScore 3.3

◆ offtime

int Ms::PluginAPI::PlayEvent::offtime
read

Time note will turn off.

This value derived from onTime and len. This value is expressed in 1/1000 of the nominal note length.

Since
MuseScore 3.3

◆ ontime

int Ms::PluginAPI::PlayEvent::ontime
readwrite

Time to turn on the note event.

This value is expressed in 1/1000 of the nominal note length.

Since
MuseScore 3.3

◆ pitch

int Ms::PluginAPI::PlayEvent::pitch
readwrite

The relative pitch to the note pitch.

This is added to the parent note's actual pitch.

Since
MuseScore 3.3

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