1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
//=============================================================================
// MuseScore
// Music Composition & Notation
//
// Copyright (C) 2002-2011 Werner Schweer
//
// 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 __LYRICS_H__
#define __LYRICS_H__
#include "line.h"
#include "text.h"
// uncomment the following line to use the actual metrics of
// the font used by each lyrics rather than conventional values
//
// NOTE: CURRENTLY DOES NOT WORK (Font::tightBoundingBox() returns unusable values for glyphs not on base line)
//
//#define USE_FONT_DASH_METRIC
#if defined(USE_FONT_DASH_METRIC)
// the following line is used to turn the single font dash thickness value on or off
// when the other font dash parameters are on;
// the rationale is that the dash thickness is the most unreliable of the dash parameters
// retrievable from font metrics and it may make sense to use the other values but ignore this one.
// #define USE_FONT_DASH_TICKNESS
#endif
//class QPainter;
namespace Ms {
//---------------------------------------------------------
// @@ Lyrics
// @P syllabic enum (Lyrics.SINGLE, Lyrics.BEGIN, Lyrics.END, Lyrics.MIDDLE)
//---------------------------------------------------------
class LyricsLine;
class Lyrics : public Text {
Q_OBJECT
Q_PROPERTY(Ms::Lyrics::Syllabic syllabic READ syllabic WRITE setSyllabic)
Q_ENUMS(Syllabic)
public:
enum class Syllabic : char { SINGLE, BEGIN, END, MIDDLE };
// MELISMA FIRST UNDERSCORE:
// used as_ticks value to mark a melisma for which only the first chord has been spanned so far
// and to give the user a visible feedback that the undercore has been actually entered;
// it should be cleared to 0 at some point, so that it will not be carried over
// if the melisma is not extended beyond a single chord, but no suitable place to do this
// has been identified yet.
static const int TEMP_MELISMA_TICKS = 1;
// metrics for dashes and melisma; all in sp. units:
static constexpr qreal MELISMA_DEFAULT_LINE_THICKNESS = 0.10; // for melisma line only;
static constexpr qreal MELISMA_DEFAULT_PAD = 0.10; // the empty space before a melisma line
static constexpr qreal LYRICS_DASH_DEFAULT_STEP = 16.0; // the max. distance between dashes
static constexpr qreal LYRICS_DASH_DEFAULT_PAD = 0.05; // the min. empty space before and after a dash
static constexpr qreal LYRICS_DASH_MIN_LENGTH = 0.25; // below this length, the dash is skipped
static constexpr qreal LYRICS_WORD_MIN_DISTANCE = 0.33; // min. distance between lyrics from different words
// These values are used when USE_FONT_DASH_METRIC is not defined
#if !defined(USE_FONT_DASH_METRIC)
static constexpr qreal LYRICS_DASH_DEFAULT_LENGTH = 0.80; // in sp. units
static constexpr qreal LYRICS_DASH_DEFAULT_LINE_THICKNESS = 0.15; // in sp. units
static constexpr qreal LYRICS_DASH_Y_POS_RATIO = 0.25; // the fraction of lyrics font tot. height to
// raise the dashes above text base line;
#endif // this usually raises at about 2/3 of x-height
private:
int _ticks; ///< if > 0 then draw an underline to tick() + _ticks
///< (melisma)
Syllabic _syllabic;
LyricsLine* _separator;
protected:
int _no; ///< row index
#if defined(USE_FONT_DASH_METRIC)
qreal _dashY; // dash dimensions for lyrics line dashes
qreal _dashLength;
#if defined (USE_FONT_DASH_TICKNESS)
qreal _dashThickness;
#endif
#endif
public:
Lyrics(Score* = 0);
Lyrics(const Lyrics&);
~Lyrics();
virtual Lyrics* clone() const override { return new Lyrics(*this); }
virtual Element::Type type() const override { return Element::Type::LYRICS; }
virtual void scanElements(void* data, void (*func)(void*, Element*), bool all=true) override;
virtual bool acceptDrop(const DropData&) const override;
virtual Element* drop(const DropData&) override;
Segment* segment() const { return (Segment*)parent()->parent(); }
Measure* measure() const { return (Measure*)parent()->parent()->parent(); }
ChordRest* chordRest() const { return (ChordRest*)parent(); }
virtual void layout() override;
virtual void layout1() override;
virtual void write(Xml& xml) const override;
virtual void read(XmlReader&) override;
virtual int subtype() const override { return _no; }
virtual QString subtypeName() const override { return tr("Verse %1").arg(_no + 1); }
void setNo(int n);
int no() const { return _no; }
void setSyllabic(Syllabic s) { _syllabic = s; }
Syllabic syllabic() const { return _syllabic; }
virtual void add(Element*) override;
virtual void remove(Element*) override;
// virtual void draw(QPainter*) const override;
virtual void endEdit() override;
int ticks() const { return _ticks; }
void setTicks(int tick) { _ticks = tick; }
int endTick() const;
bool isMelisma() const;
void removeFromScore();
#if defined(USE_FONT_DASH_METRIC)
qreal dashLength() const { return _dashLength; }
qreal dashY() const { return _dashY; }
#if defined (USE_FONT_DASH_TICKNESS)
qreal dashThickness() const { return _dashThickness; }
#endif
#endif
using Text::paste;
void paste(MuseScoreView * scoreview);
virtual QVariant getProperty(P_ID propertyId) const override;
virtual bool setProperty(P_ID propertyId, const QVariant&) override;
virtual QVariant propertyDefault(P_ID id) const override;
};
//---------------------------------------------------------
// LyricsLine
//---------------------------------------------------------
class LyricsLine : public SLine {
Q_OBJECT
protected:
Lyrics* _nextLyrics;
public:
LyricsLine(Score* s);
LyricsLine(const LyricsLine&);
virtual LyricsLine* clone() const override { return new LyricsLine(*this); }
virtual Element::Type type() const override { return Element::Type::LYRICSLINE; }
virtual void layout() override;
virtual LineSegment* createLineSegment() override;
virtual void removeUnmanaged() override;
Lyrics* lyrics() const { return (Lyrics*)parent(); }
Lyrics* nextLyrics() const { return _nextLyrics; }
virtual bool setProperty(P_ID propertyId, const QVariant& v) override;
};
//---------------------------------------------------------
// LyricsLineSegment
//---------------------------------------------------------
class LyricsLineSegment : public LineSegment {
Q_OBJECT
protected:
int _numOfDashes;
qreal _dashLength;
public:
LyricsLineSegment(Score* s);
virtual LyricsLineSegment* clone() const override { return new LyricsLineSegment(*this); }
virtual Element::Type type() const override { return Element::Type::LYRICSLINE_SEGMENT; }
LyricsLine* lyricsLine() const { return (LyricsLine*)spanner(); }
virtual void draw(QPainter*) const override;
virtual void layout() override;
};
} // namespace Ms
Q_DECLARE_METATYPE(Ms::Lyrics::Syllabic);
#endif
|
