MUSX Document Model
Loading...
Searching...
No Matches
Details.h
1/*
2 * Copyright (C) 2025, Robert Patterson
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22#pragma once
23#include <functional>
24#include <vector>
25#include <unordered_set>
26#include <cmath>
27#include <map>
28
29#include "music_theory/music_theory.hpp"
30
31#include "musx/util/EnigmaString.h"
32#include "musx/util/PseudoTieUtils.h"
33#include "MusxInstance.h"
34#include "BaseClasses.h"
35#include "CommonClasses.h"
36#include "Options.h"
37#include "Others.h"
38#include "Staff.h"
39 // do not add other dom class dependencies. Use Implementations.h for implementations that need total class access.
40
41namespace musx {
42namespace dom {
43
44class EntryInfoPtr;
45class EntryFrame;
46class EntryInfo;
47
48namespace others {
49class ChordSuffixElement;
50class FretboardGroup;
51class FretInstrument;
52class FretboardStyle;
53class StaffUsed;
54class Measure;
55class MultiStaffInstrumentGroup;
56class TextBlock;
57} // namespace others
58
59namespace texts {
60class ExpressionText;
61class LyricsChorus;
62class LyricsSection;
63class LyricsVerse;
64} // namespace others
65
70namespace details {
71
81{
82public:
84 explicit AccidentalAlterations(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
85 : NoteDetailsBase(document, partId, shareMode, entnum, inci), customFont(std::make_shared<FontInfo>(document))
86 {
87 }
88
90 int percent{};
93 char32_t altChar{};
94 std::shared_ptr<FontInfo> customFont;
95 bool useOwnFont{};
96 bool allowVertPos{};
97
98 NoteNumber getNoteId() const override { return noteId; }
99
100 constexpr static std::string_view XmlNodeName = "acciAlter";
102};
103
111{
112public:
124
125private:
126 struct PseudoTieShapeContext
127 {
131 };
132
133public:
142 explicit ArticulationAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
143 : EntryDetailsBase(document, partId, shareMode, entnum, inci) {}
144
151 bool aboveEntry{};
152 bool hide{};
153 bool neverStack{};
154 bool avoidSlur{};
156
170 [[nodiscard]] NoteInfoPtr calcAssociatedNote(const EntryInfoPtr& entryInfo) const;
171
174 [[nodiscard]] std::optional<utils::PseudoTieShapeInfo> calcIsPseudoTie(utils::PseudoTieMode mode,
175 const EntryInfoPtr& forStartEntry) const;
176
183 [[nodiscard]] std::optional<SelectedSymbolContext> calcSelectedSymbolContext(const EntryInfoPtr& entryInfo) const;
184
186 constexpr static std::string_view XmlNodeName = "articAssign";
187
188private:
194 [[nodiscard]] bool calcPlacementAbove(const MusxInstance<others::ArticulationDef>& definition,
195 const EntryInfoPtr& entryInfo) const;
199 [[nodiscard]] VerticalPlacement calcVerticalPlacement(const MusxInstance<others::ArticulationDef>& definition,
200 const EntryInfoPtr& entryInfo) const;
201 [[nodiscard]] std::optional<PseudoTieShapeContext> calcPseudoTieShapeContext(const EntryInfoPtr& forStartEntry) const;
202};
203
217class Baseline : public DetailsBase
218{
219public:
229 explicit Baseline(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff, std::optional<Inci> inci)
230 : DetailsBase(document, partId, shareMode, system, staff, inci) {}
231
235 std::optional<Cmper> lyricNumber{};
236
238};
239
245{
246public:
255 explicit BaselineNoInci(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff)
256 : Baseline(document, partId, shareMode, system, staff, std::nullopt) {}
257};
258
264{
265public:
267
268 constexpr static std::string_view XmlNodeName = "baselinesSysChords";
269};
270
276{
277public:
279
280 constexpr static std::string_view XmlNodeName = "baselinesSysExprAboveStaff";
281};
282
288{
289public:
291
292 constexpr static std::string_view XmlNodeName = "baselinesSysExprBelowStaff";
293};
294
300{
301public:
303
304 constexpr static std::string_view XmlNodeName = "baselinesSysFingerboards";
305};
306
312{
313public:
314 using Baseline::Baseline;
315
316 constexpr static std::string_view XmlNodeName = "baselinesSysLyricsChorus";
317};
318
324{
325public:
326 using Baseline::Baseline;
327
328 constexpr static std::string_view XmlNodeName = "baselinesSysLyricsSection";
329};
330
336{
337public:
338 using Baseline::Baseline;
339
340 constexpr static std::string_view XmlNodeName = "baselinesSysLyricsVerse";
341};
342
350{
351public:
353
355 constexpr static std::string_view XmlNodeName = "baselinesChords";
356};
357
365{
366public:
368
370 constexpr static std::string_view XmlNodeName = "baselinesExprAboveStaff";
371};
372
380{
381public:
383
385 constexpr static std::string_view XmlNodeName = "baselinesExprBelowStaff";
386};
387
395{
396public:
398
400 constexpr static std::string_view XmlNodeName = "baselinesFingerboards";
401};
402
410{
411public:
412 using Baseline::Baseline;
413
416 constexpr static std::string_view XmlNodeName = "baselinesLyricsChorus";
417};
418
426{
427public:
428 using Baseline::Baseline;
429
432 constexpr static std::string_view XmlNodeName = "baselinesLyricsSection";
433};
434
442{
443public:
444 using Baseline::Baseline;
445
448 constexpr static std::string_view XmlNodeName = "baselinesLyricsVerse";
449};
450
458{
459private:
460 bool m_active = true; // this value is set by the factory.
461
462protected:
464 template <typename SecondaryBeamType>
465 static bool calcIsFeatheredBeamImpl(const EntryInfoPtr& entryInfo, Evpu& outLeftY, Evpu& outRightY);
466
468 template <typename SecondaryBeamType>
470
471public:
480 explicit BeamAlterations(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional<Inci> inci = std::nullopt)
481 : EntryDetailsBase(document, partId, shareMode, entnum, inci) {}
482
485
494
499
502 bool isActive() const { return m_active; }
503
505 template <typename T,
506 std::enable_if_t<std::is_base_of_v<BeamAlterations, T>, int> = 0>
507 static void calcAllActiveFlags(const DocumentPtr& document);
508
512 static MusxInstance<BeamAlterations> getPrimaryForStem(const EntryInfoPtr& entryInfo, StemSelection stemSelection = StemSelection::MatchEntry); // must be defined in Details.cpp
513
518 static MusxInstance<BeamAlterations> getSecondaryForStem(const EntryInfoPtr& entryInfo, Edu dura, StemSelection stemSelection = StemSelection::MatchEntry); // must be defined in Details.cpp
519
521};
522
530{
531public:
539 explicit BeamAlterationsDownStem(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
540 : BeamAlterations(document, partId, shareMode, entnum) {}
541
542 constexpr static std::string_view XmlNodeName = "beamAltPrimDownStem";
543};
544
552{
553public:
561 explicit BeamAlterationsUpStem(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
562 : BeamAlterations(document, partId, shareMode, entnum) {}
563
564 constexpr static std::string_view XmlNodeName = "beamAltPrimUpStem";
565};
566
575{
576public:
584 explicit BeamExtension(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
585 : EntryDetailsBase(document, partId, shareMode, entnum) {}
586
589 unsigned mask{};
596
599 unsigned calcMaxExtension() const;
600
604 static MusxInstance<BeamExtension> getForStem(const EntryInfoPtr& entryInfo, StemSelection stemSelection = StemSelection::MatchEntry); // must be defined in Details.cpp
605
607};
608
614{
615public:
617
618 constexpr static std::string_view XmlNodeName = "beamExtendDownStem";
619};
620
626{
627public:
629
630 constexpr static std::string_view XmlNodeName = "beamExtendUpStem";
631};
632
642{
643public:
645 explicit BeamStubDirection(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
646 : EntryDetailsBase(document, partId, shareMode, entnum)
647 {
648 }
649
650 unsigned mask{};
653
655 bool isLeft() const { return mask != 0; }
656
657 constexpr static std::string_view XmlNodeName = "beamStub";
659};
660
673class Bracket : public DetailsBase
674{
675public:
677 explicit Bracket(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, Inci inci)
678 : DetailsBase(document, partId, shareMode, cmper1, cmper2, inci)
679 {
680 }
681
683 explicit Bracket(const DocumentWeakPtr& document)
685 {
686 }
687
692 enum class BracketStyle : int
693 {
694 None = 0,
695 ThickLine = 1,
697 PianoBrace = 3,
698 Unknown4,
699 Unknown5,
701 Unknown7,
702 DeskBracket = 8
703 };
704
710
711 constexpr static std::string_view XmlNodeName = "brackSpec";
713};
714
723{
724 Cmper calcFretboardGroupCmper() const;
725
726public:
736 explicit ChordAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
737 : DetailsBase(document, partId, shareMode, staffId, meas, inci)
738 {
739 }
740
745 enum class BassPosition
746 {
747 AfterRoot, // default value may not appear in xml (but text appears in Finale binary)
748 UnderRoot,
749 Subtext
750 };
751
758 int rootAlter{};
760 bool playSuffix{};
761 bool showRoot{};
762 bool playRoot{};
764 bool showSuffix{};
767 int bassAlter{};
770 bool showAltBass{};
771 bool playAltBass{};
772 int capoValue{};
784 int chPercent{};
785 int fbPercent{};
786
789
793
797
798 constexpr static std::string_view XmlNodeName = "chordAssign";
800};
801
816class ClefOctaveFlats : public DetailsArray<int, 7>
817{
818 std::string_view xmlTag() const override { return XmlNodeName; }
819
820public:
822
823 constexpr static std::string_view XmlNodeName = "clefOctvFlats";
825};
826
845class ClefOctaveSharps : public DetailsArray<int, 7>
846{
847 std::string_view xmlTag() const override { return XmlNodeName; }
848
849public:
851
852 constexpr static std::string_view XmlNodeName = "clefOctvSharps";
854};
855
865{
866public:
868 explicit CrossStaff(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
869 : NoteDetailsBase(document, partId, shareMode, entnum, inci)
870 {
871 }
872
875
876 NoteNumber getNoteId() const override { return noteId; }
877
878 constexpr static std::string_view XmlNodeName = "crossStaff";
880};
881
891{
892public:
900 explicit CustomStem(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
901 : EntryDetailsBase(document, partId, shareMode, entnum) {}
902
906
913 bool calcIsHiddenStem() const;
914
918 static MusxInstance<CustomStem> getForStem(const EntryInfoPtr& entryInfo, StemSelection stemSelection = StemSelection::MatchEntry); // must be defined in Details.cpp
919
921};
922
930{
931public:
933
934 constexpr static std::string_view XmlNodeName = "stemDefDown";
935};
936
944{
945public:
947
948 constexpr static std::string_view XmlNodeName = "stemDefUp";
949};
950
960{
961public:
963 explicit DotAlterations(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
964 : NoteDetailsBase(document, partId, shareMode, entnum, inci)
965 {
966 }
967
972
973 NoteNumber getNoteId() const override { return noteId; }
974
975 constexpr static std::string_view XmlNodeName = "dotOffset";
977};
978
990{
991public:
999 explicit EntryPartFieldDetail(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
1000 : EntryDetailsBase(document, partId, shareMode, entnum) {}
1001
1003 bool freezeStem{};
1004 bool upStem{};
1005
1007 constexpr static std::string_view XmlNodeName = "entryPartFieldDetail";
1008};
1009
1019{
1020public:
1028 explicit EntrySize(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
1029 : EntryDetailsBase(document, partId, shareMode, entnum) {}
1030
1031 int percent{};
1032
1034 constexpr static std::string_view XmlNodeName = "entrySize";
1035};
1036
1050{
1051public:
1055 explicit FretboardDiagram(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
1056 : DetailsBase(document, partId, shareMode, cmper1, cmper2)
1057 {}
1058
1066 enum class Shape
1067 {
1068 None,
1069 Closed,
1070 Open,
1071 Muted,
1072 Custom
1073 };
1074
1079 class Cell
1080 {
1081 public:
1082 int string{};
1083 int fret{};
1086
1088 };
1089
1094 class Barre
1095 {
1096 public:
1097 int fret{};
1100
1102 };
1103
1104 int numFrets{};
1106 bool lock{};
1107 bool showNum{};
1110
1111 std::vector<std::shared_ptr<Cell>> cells;
1112 std::vector<std::shared_ptr<Barre>> barres;
1113
1114 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1115 {
1116 this->DetailsBase::integrityCheck(ptrToThis);
1117 if (numFretCells != int(cells.size())) {
1118 const int oldVal = numFretCells;
1119 numFretCells = int(cells.size());
1120 MUSX_INTEGRITY_ERROR("FretboardDiagram " + std::to_string(getCmper1()) + ", " + std::to_string(getCmper2())
1121 + " specifies the wrong number of cells (" + std::to_string(oldVal) + ").");
1122 }
1123 if (numFretBarres != int(barres.size())) {
1124 const int oldVal = numFretBarres;
1125 numFretBarres = int(barres.size());
1126 MUSX_INTEGRITY_ERROR("FretboardDiagram " + std::to_string(getCmper1()) + ", " + std::to_string(getCmper2())
1127 + " specifies the wrong number of barres (" + std::to_string(oldVal) + ").");
1128 }
1129 }
1130
1131 constexpr static std::string_view XmlNodeName = "fretboard";
1133};
1134
1143{
1144public:
1153 explicit GFrameHold(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas)
1154 : DetailsBase(document, partId, shareMode, staffId, meas), frames(MAX_LAYERS) {}
1155
1156 // Public properties corresponding to the XML structure
1157 std::optional<ClefIndex> clefId;
1163 std::vector<Cmper> frames;
1164
1167
1170
1172 bool calcIsMultiLayer() const
1173 {
1174 return std::count_if(frames.begin(), frames.end(), [](Cmper frameId) { return frameId != 0; }) > 1;
1175 }
1176
1179 {
1180 return std::find_if(frames.begin(), frames.end(), [](Cmper frameId) { return frameId != 0; }) != frames.end();
1181 }
1182
1186 std::pair<MusxInstance<others::Frame>, Edu> findLayerFrame(LayerIndex layerIndex) const;
1187
1191 bool iterateRawEntries(std::function<bool(const MusxInstance<Entry>&, LayerIndex)> iterator) const;
1192
1193 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1194 {
1195 this->DetailsBase::integrityCheck(ptrToThis);
1196 if (clefListId && clefId.has_value()) {
1197 MUSX_INTEGRITY_ERROR("GFrameHold for staff " + std::to_string(getCmper1()) + " and measure " + std::to_string(getCmper2()) + " has both clef and clef list.");
1198 }
1199 if (!clefListId && !clefId.has_value()) {
1200 MUSX_INTEGRITY_ERROR("GFrameHold for staff " + std::to_string(getCmper1()) + " and measure " + std::to_string(getCmper2()) + " has neither clef nor clef list.");
1201 }
1202 }
1203
1204 constexpr static std::string_view XmlNodeName = "gfhold";
1206};
1207
1216{
1217public:
1226 explicit IndependentStaffDetails(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas)
1227 : DetailsBase(document, partId, shareMode, staffId, meas)
1228 {
1229 }
1230
1231 // Key signature info
1232 std::shared_ptr<KeySignature> keySig;
1233 bool hasKey{};
1234
1235 // Time signature info
1240
1243 bool altNumTsig{};
1244 bool altDenTsig{};
1247 bool hasTime{};
1248
1251
1255
1256 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1257 {
1258 DetailsBase::integrityCheck(ptrToThis);
1259 if (hasKey && !keySig) {
1260 keySig = std::make_shared<KeySignature>(getDocument());
1261 }
1262 }
1263
1264 constexpr static std::string_view XmlNodeName = "floats";
1266};
1267
1276public:
1278 explicit KeySymbolListElement(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
1279 : DetailsBase(document, partId, shareMode, cmper1, cmper2) {}
1280
1281 std::string accidentalString;
1283
1286 return static_cast<int16_t>(getCmper2());
1287 }
1288
1289 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1290 {
1291 DetailsBase::integrityCheck(ptrToThis);
1292 if (std::abs(getAlterationValue()) > MAX_ALTERATIONS) {
1294 "KeySymbolListElement for list " + std::to_string(getCmper1()) + " has invalid value " + std::to_string(getAlterationValue()));
1295 }
1296 }
1297
1298 constexpr static std::string_view XmlNodeName = "keySymList";
1300};
1301
1307{
1308public:
1317 explicit LyricAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
1318 : EntryDetailsBase(document, partId, shareMode, entnum, inci) {}
1319
1321 unsigned syllable{};
1329
1332
1334 virtual LyricTextType getLyricTextType() const = 0;
1335
1340
1345
1347};
1348
1356{
1357public:
1359
1361 LyricTextType getLyricTextType() const override;
1362
1365 constexpr static std::string_view XmlNodeName = "lyrDataChorus";
1366};
1367
1375{
1376public:
1378
1380 LyricTextType getLyricTextType() const override;
1381
1384 constexpr static std::string_view XmlNodeName = "lyrDataSection";
1385};
1386
1394{
1395public:
1397
1399 LyricTextType getLyricTextType() const override;
1400
1403 constexpr static std::string_view XmlNodeName = "lyrDataVerse";
1404};
1405
1414{
1415public:
1424 explicit LyricEntryInfo(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional<Inci> inci = std::nullopt)
1425 : EntryDetailsBase(document, partId, shareMode, entnum, inci) {}
1426
1427 std::optional<AlignJustify> justify{};
1428 std::optional<AlignJustify> align{};
1429
1431 constexpr static std::string_view XmlNodeName = "lyricEntryInfo";
1432};
1433
1442{
1443public:
1453 explicit MeasureNumberIndividualPositioning(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
1454 : DetailsBase(document, partId, shareMode, staffId, meas, inci)
1455 {
1456 }
1457
1463 {
1464 None,
1465 Show,
1466 Hide
1467 };
1468
1475 std::shared_ptr<others::Enclosure> enclosure;
1476
1477 constexpr static std::string_view XmlNodeName = "measNumbIndivPos";
1479};
1480
1497{
1498public:
1508 explicit MeasureTextAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
1509 : DetailsBase(document, partId, shareMode, staffId, meas, inci)
1510 {
1511 }
1512
1518 bool hidden{};
1519
1522
1525
1526 constexpr static std::string_view XmlNodeName = "measTextAssign";
1528};
1529
1539{
1540public:
1542 explicit NoteAlterations(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
1543 : NoteDetailsBase(document, partId, shareMode, entnum, inci), customFont(new FontInfo(document))
1544 {
1545 }
1546
1548 int percent{};
1550 char32_t altNhead{};
1551 bool useOwnFont{};
1552 std::shared_ptr<FontInfo> customFont{};
1555 bool enharmonic{};
1557
1558 NoteNumber getNoteId() const override { return noteId; }
1559
1560 constexpr static std::string_view XmlNodeName = "noteAlter";
1562};
1563
1573{
1574public:
1576 explicit PercussionNoteCode(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
1577 : NoteDetailsBase(document, partId, shareMode, entnum, inci)
1578 {
1579 }
1580
1583
1584 NoteNumber getNoteId() const override { return noteId; }
1585
1586 constexpr static std::string_view XmlNodeName = "percussionNoteCode";
1588};
1589
1597{
1598public:
1608 explicit SecondaryBeamAlterationsDownStem(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
1609 : BeamAlterations(document, partId, shareMode, entnum, inci) {}
1610
1617 static bool calcIsFeatheredBeam(const EntryInfoPtr& entryInfo, Evpu& outLeftY, Evpu& outRightY)
1618 { return calcIsFeatheredBeamImpl<SecondaryBeamAlterationsDownStem>(entryInfo, outLeftY, outRightY); }
1619
1620 constexpr static std::string_view XmlNodeName = "beamAltSecDownStem";
1621};
1622
1630{
1631public:
1641 explicit SecondaryBeamAlterationsUpStem(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
1642 : BeamAlterations(document, partId, shareMode, entnum, inci) {}
1643
1650 static bool calcIsFeatheredBeam(const EntryInfoPtr& entryInfo, Evpu& outLeftY, Evpu& outRightY)
1651 { return calcIsFeatheredBeamImpl<SecondaryBeamAlterationsUpStem>(entryInfo, outLeftY, outRightY); }
1652
1653 constexpr static std::string_view XmlNodeName = "beamAltSecUpStem";
1654};
1655
1665{
1666public:
1668 explicit SecondaryBeamBreak(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
1669 : EntryDetailsBase(document, partId, shareMode, entnum)
1670 {
1671 }
1672
1673 unsigned mask{};
1675
1683 {
1684 MUSX_ASSERT_IF(!mask || mask >= unsigned(NoteType::Eighth)) {
1685 return 0; // invalid mask values have already been flagged and supposedly corrected by #integrityCheck.
1686 }
1687 for (unsigned shift = 0; true; shift++) {
1688 if (mask & (unsigned(NoteType::Note16th) >> shift)) {
1689 return shift + 2; // the 2nd beam is the 16th beam and the first one we checked.
1690 }
1691 }
1692 assert(false); // should not be able to get here
1693 return 0;
1694 }
1695
1696 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1697 {
1699 if (!mask) {
1700 mask = unsigned(NoteType::Note4096th);
1701 MUSX_INTEGRITY_ERROR("Secondary beam break for entry" + std::to_string(getEntryNumber()) + " has no breaks.");
1702 }
1703 if (mask >= unsigned(NoteType::Eighth)) {
1704 mask = unsigned(NoteType::Eighth) - 1;
1705 MUSX_INTEGRITY_ERROR("Secondary beam break for entry" + std::to_string(getEntryNumber()) + " specifies a value that cannot be a secondary beam.");
1706 }
1707 }
1708
1709 constexpr static std::string_view XmlNodeName = "secBeamBreak";
1711};
1712
1723{
1724public:
1727 explicit ShapeNoteBase(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
1728 : DetailsBase(document, partId, shareMode, cmper1, cmper2)
1729 {}
1730
1735 {
1736 public:
1737 char32_t doubleWhole{};
1738 char32_t whole{};
1739 char32_t half{};
1740 char32_t quarter{};
1741
1743 };
1744
1745 std::vector<std::shared_ptr<NoteShapes>> noteShapes;
1748
1749 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1750 {
1751 this->DetailsBase::integrityCheck(ptrToThis);
1752 const size_t currentSize = noteShapes.size();
1753 if (currentSize < music_theory::STANDARD_DIATONIC_STEPS) {
1754 for (size_t x = currentSize; x < music_theory::STANDARD_DIATONIC_STEPS; x++) {
1755 noteShapes.emplace_back(std::make_shared<NoteShapes>());
1756 }
1757 MUSX_INTEGRITY_ERROR("For ShapeNoteBase cmper " + std::to_string(getCmper1()) + ", only " + std::to_string(currentSize)
1758 + " note shapes were provided but at least " + std::to_string(music_theory::STANDARD_DIATONIC_STEPS) + " were expected.");
1759 }
1760 }
1761
1763};
1764
1773{
1774public:
1776
1777 constexpr static std::string_view XmlNodeName = "shapeNote";
1778};
1779
1788{
1789public:
1791
1792 constexpr static std::string_view XmlNodeName = "shapeNoteStyle";
1793};
1794
1801class StaffGroup : public DetailsBase {
1802public:
1811 StaffGroup(const DocumentWeakPtr& document, Cmper partId, EnigmaBase::ShareMode shareMode, Cmper cmper1, Cmper cmper2)
1812 : DetailsBase(document, partId, shareMode, cmper1, cmper2) {}
1813
1816
1822 {
1823 OnlyOnStaves,
1826 };
1827
1832 enum class HideStaves
1833 {
1834 Normally,
1835 AsGroup,
1836 None
1837 };
1838
1839 // Public properties corresponding to the XML structure, ordered as they appear in the XML
1847 std::shared_ptr<Bracket> bracket{};
1852 bool ownBarline{};
1855 bool hideName{};
1864
1870 std::unordered_set<StaffCmper> staves;
1871
1874
1878
1881
1885
1888
1892
1898
1902
1908
1910 bool isAllMeasures() const
1911 { return (startMeas == 1 && endMeas == (std::numeric_limits<MeasCmper>::max)()); }
1912
1913 void integrityCheck(const std::shared_ptr<EnigmaBase>& ptrToThis) override
1914 {
1915 this->DetailsBase::integrityCheck(ptrToThis);
1916 if (endMeas <= startMeas || startMeas <= 0) {
1917 MUSX_INTEGRITY_ERROR("Staff group " + std::to_string(getCmper2()) + " for part " + std::to_string(getSourcePartId())
1918 + " starts at measure " + std::to_string(startMeas) + " and ends at measure " + std::to_string(endMeas));
1919 }
1920 if (!bracket) {
1921 // this is not an error. Finale omits the bracket node for groups with entirely default bracket info.
1922 bracket = std::make_shared<Bracket>(getDocument());
1923 }
1924 }
1925
1926 constexpr static std::string_view XmlNodeName = "staffGroup";
1928};
1929
1935{
1936public:
1937 std::optional<size_t> startSlot;
1938 std::optional<size_t> endSlot;
1941
1945 StaffGroupInfo(const MusxInstance<StaffGroup>& staffGroup,
1946 const MusxInstanceList<others::StaffUsed>& inpSysStaves);
1947
1949 std::optional<size_t> numStaves() const
1950 {
1951 if (startSlot && endSlot) {
1952 return endSlot.value() - startSlot.value() + 1;
1953 }
1954 return std::nullopt;
1955 }
1956
1961 void iterateStaves(MeasCmper measId, Edu eduPosition, std::function<bool(const MusxInstance<others::StaffComposite>&)> iterator) const;
1962
1966 bool calcIsSingleInstrumentSection(MeasCmper measureId) const;
1967
1972 static std::vector<StaffGroupInfo> getGroupsAtMeasure(MeasCmper measureId, Cmper linkedPartId,
1974};
1975
1985{
1986public:
1995 explicit StaffSize(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staffId)
1996 : DetailsBase(document, partId, shareMode, system, staffId)
1997 {
1998 }
1999
2001
2005
2006 constexpr static std::string_view XmlNodeName = "staffSize";
2008};
2009
2019{
2020public:
2022 explicit StemAlterations(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
2023 : EntryDetailsBase(document, partId, shareMode, entnum)
2024 {
2025 }
2026
2031
2032 constexpr static std::string_view XmlNodeName = "stemAdjust";
2034};
2035
2045{
2046public:
2048
2049 constexpr static std::string_view XmlNodeName = "beamStemAdjust";
2050};
2051
2062{
2063public:
2065 explicit TablatureNoteMods(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
2066 : NoteDetailsBase(document, partId, shareMode, entnum, inci)
2067 {
2068 }
2069
2073
2074 NoteNumber getNoteId() const override { return noteId; }
2075
2076 constexpr static std::string_view XmlNodeName = "tabAlter";
2078};
2079
2085{
2086public:
2088 explicit TieAlterBase(const DocumentWeakPtr& document, Cmper partId, EnigmaBase::ShareMode shareMode, EntryNumber entnum, Inci inci)
2089 : NoteDetailsBase(document, partId, shareMode, entnum, inci)
2090 {
2091 }
2092
2096 static MusxInstance<TieAlterBase> fromNoteInfo(const NoteInfoPtr& noteInfoPtr, bool forTieEnd = false);
2097
2125
2131 {
2132 None,
2133 Under,
2134 Over
2135 };
2136
2142 bool outerLocal{};
2143 bool outerOn{};
2152 bool down{};
2156 bool breakKeyOn{};
2159 bool stPtAdjOn{};
2162 bool enPtAdjOn{};
2169 bool ctlPtAdjOn{};
2170 bool ctlPtFixed{};
2172
2173 NoteNumber getNoteId() const override { return noteId; }
2174
2176};
2177
2187{
2188public:
2190
2191 constexpr static std::string_view XmlNodeName = "tieAlterEnd";
2193};
2194
2204{
2205public:
2207
2208 constexpr static std::string_view XmlNodeName = "tieAlterStart";
2210};
2211
2221{
2222public:
2224 explicit TupletDef(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
2225 : EntryDetailsBase(document, partId, shareMode, entnum, inci)
2226 {
2227 }
2228
2237
2242 bool alwaysFlat{};
2243 bool fullDura{};
2245 bool avoidStaff{};
2247 bool hidden{};
2254 bool allowHorz{};
2257 bool matchHooks{};
2266
2269
2272
2275
2276 constexpr static std::string_view XmlNodeName = "tupletDef";
2278};
2279
2280} // namespace details
2281
2282#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2283template <>
2284struct PartContextRebinder<details::MeasureNumberIndividualPositioning>
2285{
2286 static void rebind(const std::shared_ptr<details::MeasureNumberIndividualPositioning>& positioning);
2287};
2288#endif
2289
2290} // namespace dom
2291} // namespace entries
Template pattern for DetailsBase items consisting of an array of a single item.
Definition BaseClasses.h:529
DetailsArray(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition BaseClasses.h:535
EnigmaBase class for all "details" types.
Definition BaseClasses.h:406
Cmper getCmper1() const
Gets the cmper1 key value.
Definition BaseClasses.h:450
Cmper getCmper2() const
Gets the cmper2 key value.
Definition BaseClasses.h:455
DocumentPtr getDocument() const
Gets a reference to the Document.
Definition DocumentElement.h:58
Base for DOM classes that are represented in EnigmaData.
Definition BaseClasses.h:88
ShareMode
Describes how this instance is shared between part and score.
Definition BaseClasses.h:98
Cmper getSourcePartId() const
Gets the source partId for this instance. If an instance is fully shared with the score,...
Definition BaseClasses.h:111
virtual void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis)
Performs a final consistency check after population.
Definition BaseClasses.h:132
EnigmaBase class for all "details" types that use entnum rather than cmper and cmper.
Definition BaseClasses.h:478
EntryNumber getEntryNumber() const
Gets the entnum key value.
Definition BaseClasses.h:517
StemSelection
The options for choosing which version to retrieve for stem-specific details.
Definition BaseClasses.h:483
@ MatchEntry
match entry's stem direction
Wraps a frame of shared_ptr<const EntryInfo> and an index for per entry access. This class manages ow...
Definition Entries.h:534
Represents the default font settings for a particular element type.
Definition CommonClasses.h:104
Provides optional per-type extension methods for MusxInstanceList.
Definition MusxInstance.h:118
EnigmaBase class note details. Note details are entry details associated with a note ID.
Definition BaseClasses.h:560
Wraps an EntryInfo instance and a note index.
Definition Entries.h:1587
Represents display alterations to an accidental for a specific note.
Definition Details.h:81
Evpu hOffset
Horizontal offset: positive is right. (XML node: <axDisp>)
Definition Details.h:92
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:98
bool useOwnFont
Whether to use customFont.
Definition Details.h:95
std::shared_ptr< FontInfo > customFont
Font settings for the accidental (populated from <fontID>, <fontSize>, and <efx>)
Definition Details.h:94
NoteNumber noteId
The ID of the note being altered.
Definition Details.h:89
AccidentalAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor.
Definition Details.h:84
Evpu vOffset
Vertical offset: positive is up. (XML node: <ayDisp>)
Definition Details.h:91
char32_t altChar
If non-zero, the character to use for the accidental. (Utf-32 if the font is a Unicode font....
Definition Details.h:93
bool allowVertPos
Whether to use vOffset.
Definition Details.h:96
int percent
The percentage size for the accidental, where 100 is 100%.
Definition Details.h:90
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:100
static const xml::XmlElementArray< AccidentalAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Assigns an articulation to an entry.
Definition Details.h:111
ArticulationAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:142
Cmper articDef
The articulation definition ID.
Definition Details.h:145
bool hide
Inverse of "Show" option.
Definition Details.h:152
bool neverStack
Whether the articulation should never stack relative to others.
Definition Details.h:153
int numSlursAvoided
Number of slurs avoided. Used internally by Finale's stacking algorithm.
Definition Details.h:155
bool avoidSlur
Whether the articulation should avoid slurs.
Definition Details.h:154
std::optional< SelectedSymbolContext > calcSelectedSymbolContext(const EntryInfoPtr &entryInfo) const
Resolves the symbol information used by this articulation assignment on the specified entry.
Definition Details.cpp:156
bool aboveEntry
When overridePlacement is true: whether the articulation is forced above or below the entry.
Definition Details.h:151
Evpu horzOffset
Horizontal offset from the default position.
Definition Details.h:146
bool overridePlacement
Whether the default placement is overridden.
Definition Details.h:150
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:186
static const xml::XmlElementArray< ArticulationAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
std::optional< utils::PseudoTieShapeInfo > calcIsPseudoTie(utils::PseudoTieMode mode, const EntryInfoPtr &forStartEntry) const
Calculates the pseudo-tie shape info if this articulation is acting as a pseudo tie for the specified...
Definition Details.cpp:251
NoteInfoPtr calcAssociatedNote(const EntryInfoPtr &entryInfo) const
Heuristically finds the note in the entry that this articulation assignment appears to be associated ...
Definition Details.cpp:174
Evpu vertOffset
Vertical offset from the default position.
Definition Details.h:148
Evpu vertAdd
Vertical displacement for character copying. (E.g., arpeggiated chord lines)
Definition Details.h:149
Evpu horzAdd
Horizontal displacement for character copying. (E.g., trill lines)
Definition Details.h:147
Contains the baseline offsets for chords.
Definition Details.h:350
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:355
Contains the baseline offsets for expressions above the staff.
Definition Details.h:365
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:370
Contains the baseline offsets for expressions below the staff.
Definition Details.h:380
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:385
Contains the baseline offsets for fretboards.
Definition Details.h:395
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:400
Contains the baseline offsets for lyrics chorus records.
Definition Details.h:410
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:416
Contains the baseline offsets for lyrics section records.
Definition Details.h:426
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:432
Contains the baseline offsets for lyrics verse records.
Definition Details.h:442
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:448
Encapsulates inci handling for non-inci baselines.
Definition Details.h:245
BaselineNoInci(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff)
Constructor function.
Definition Details.h:255
Contains the baseline offsets for chords.
Definition Details.h:264
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:268
Contains the baseline offsets for expressions above the staff.
Definition Details.h:276
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:280
Contains the baseline offsets for expressions below the staff.
Definition Details.h:288
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:292
Contains the baseline offsets for fretboards.
Definition Details.h:300
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:304
Contains the baseline offsets for lyrics chorus records.
Definition Details.h:312
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:316
Contains the baseline offsets for lyrics section records.
Definition Details.h:324
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:328
Contains the baseline offsets for lyrics verse records.
Definition Details.h:336
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:340
Contains the baseline information for all baseline types.
Definition Details.h:218
std::optional< Cmper > lyricNumber
The 1-based text number of the lyric, if this is a lyrics baseline. Otherwise unused and should be st...
Definition Details.h:235
static const xml::XmlElementArray< Baseline > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Baseline(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staff, std::optional< Inci > inci)
Constructor function.
Definition Details.h:229
Evpu baselineDisplacement
Definition Details.h:232
Beam alteration for downstem primary beams.
Definition Details.h:530
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:542
BeamAlterationsDownStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor.
Definition Details.h:539
Beam alteration for upstem primary beams.
Definition Details.h:552
BeamAlterationsUpStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor.
Definition Details.h:561
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:564
Represents beam alterations applied to a specific entry. This is used to apply additional shaping or ...
Definition Details.h:458
static const xml::XmlElementArray< BeamAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool isActive() const
Returns whether this beam alteration record is active. Its flattenStyle must match the value in optio...
Definition Details.h:502
Edu dura
For secondary beams, specifies the duration corresponding to the secondary beam (16th beam is 256,...
Definition Details.h:490
Evpu rightOffsetY
Vertical adjustment of the beam end. (xml node is <syAdd>)
Definition Details.h:489
FlattenStyle flattenStyle
Beam shaping style (xml node is <context>).
Definition Details.h:491
static MusxInstance< BeamAlterations > getSecondaryForStem(const EntryInfoPtr &entryInfo, Edu dura, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:422
static MusxInstance< BeamAlterations > getPrimaryForStem(const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:414
BeamAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
Constructor.
Definition Details.h:480
static bool calcIsFeatheredBeamImpl(const EntryInfoPtr &entryInfo, Evpu &outLeftY, Evpu &outRightY)
Implementation of SecondaryBeamAlterationsDownStem::calcIsFeatheredBeam and SecondaryBeamAlterationsU...
Definition Details.cpp:337
Evpu rightOffsetH
Horizontal adjustment of the beam end. (xml node is <sxAdd>)
Definition Details.h:488
static MusxInstanceList< SecondaryBeamType > getSecondaryBeamArray(const EntryInfoPtr &entryInfo)
Generalized getter for secondary beam type arrays for either stem direction.
Definition Details.cpp:399
Evpu leftOffsetY
Vertical adjustment of the beam start. (xml node is <yAdd>)
Definition Details.h:487
Evpu leftOffsetH
Horizontal adjustment of the beam start. (xml node is <xAdd>)
Definition Details.h:486
Efix calcEffectiveBeamWidth() const
Calculates the effective beam width by returning either the default width or the width override value...
Definition Details.cpp:310
static void calcAllActiveFlags(const DocumentPtr &document)
Used by the factory to set active indicators.
Definition Details.cpp:290
Efix beamWidth
The calcEffectiveBeamWidth method handles this for you.
Definition Details.h:492
Beam extension for downstem beams.
Definition Details.h:614
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:618
Beam extension for upstem beams.
Definition Details.h:626
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:630
Represents both sides of a beam extension. It is attached to the first entry in the beam....
Definition Details.h:575
unsigned calcMaxExtension() const
Calculates the maximum beam extension.
Definition Details.cpp:460
static MusxInstance< BeamExtension > getForStem(const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:482
bool extBeyond8th
Definition Details.h:592
Evpu rightOffset
Right extension offset. (xml node is <x4Disp>)
Definition Details.h:588
unsigned mask
Definition Details.h:589
static const xml::XmlElementArray< BeamExtension > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
BeamExtension(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor.
Definition Details.h:584
Evpu leftOffset
Left extension offset. (xml node is <x3Disp>)
Definition Details.h:587
Specifies the direction for beam stubs (if they are manually overridden.)
Definition Details.h:642
unsigned mask
Definition Details.h:650
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:657
static const xml::XmlElementArray< BeamStubDirection > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool isLeft() const
True if the beam stub(s) point left.
Definition Details.h:655
BeamStubDirection(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor function.
Definition Details.h:645
Represents a bracket, used in two different contexts:
Definition Details.h:674
static const xml::XmlElementArray< Bracket > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:711
Evpu horzAdjLeft
"Distance from Left Edge of Staff" (xml node is <bracPos>)
Definition Details.h:706
Evpu vertAdjTop
"Vertical Adjust (Top of Bracket)" (xml node is <bracTop>)
Definition Details.h:707
Bracket(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, Inci inci)
Constructor for top-level instances.
Definition Details.h:677
Evpu vertAdjBot
"Vertical Adjust (Bottom of Bracket)" (xml node is <bracBot>)
Definition Details.h:708
Bracket(const DocumentWeakPtr &document)
Constructor for embedded instances.
Definition Details.h:683
BracketStyle style
Bracket style (xml node is <id>)
Definition Details.h:705
BracketStyle
Bracket types.
Definition Details.h:693
@ BracketCurvedHooks
Thick bracket with curved hooks.
@ DeskBracket
Thin bracket with horizontal hook lines.
@ BracketStraightHooks
Thick bracket with straight hooks.
bool showOnSingleStaff
"Show Bracket If Group Contains Only One Staff" (only applies to staff groups: xml node is <onSingle>...
Definition Details.h:709
Represents chord symbol assignment for a staff and measure.
Definition Details.h:723
Edu horzEdu
Edu position in measure.
Definition Details.h:783
Evpu fbHorzOff
Horizontal offset of fretboard (in EVPU)
Definition Details.h:781
bool showFretboard
Show fretboard.
Definition Details.h:763
bool rootLowerCase
Display root in lowercase (minor triad)
Definition Details.h:759
bool playRoot
Playback root.
Definition Details.h:762
bool showRoot
Show root.
Definition Details.h:761
int bassAlter
Bass alteration.
Definition Details.h:767
BassPosition
Bass position options.
Definition Details.h:746
ChordAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
Constructor.
Definition Details.h:736
int rootScaleNum
Root scale degree: 0–6, where zero is the tonic.
Definition Details.h:757
Evpu fbVertOff
Vertical offset of fretboard (in EVPU)
Definition Details.h:782
bool showAltBass
Show alternate bass.
Definition Details.h:770
MusxInstanceList< others::ChordSuffixElement > getChordSuffix() const
Returns the chord suffix as an array of others::ChordSuffixElement.
Definition Details.cpp:503
Evpu horzOff
Horizontal offset of chord (in EVPU)
Definition Details.h:779
bool showSuffix
Show suffix.
Definition Details.h:764
MusxInstance< others::FretboardGroup > getFretboardGroup() const
Get the others::FretboardGroup instance for this chord assignment. You can use this to get the fret i...
Definition Details.cpp:508
Cmper suffixId
Definition Details.h:752
bool useFretboardFont
Definition Details.h:777
Inci fretboardGroupInci
Definition Details.h:774
bool playFretboard
Playback fretboard.
Definition Details.h:765
Cmper fbStyleId
The others::FretboardStyle ID. (Ignored when useFretboardFont is true.)
Definition Details.h:756
int fbPercent
FretboardDiagram scaling (100 means 100%)
Definition Details.h:785
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:798
int bassScaleNum
Bass scale degree: 0–6, where zero is the tonic.
Definition Details.h:766
Evpu vertOff
Vertical offset of chord (in EVPU)
Definition Details.h:780
int capoValue
Capo value (if useLocalCapo is true)
Definition Details.h:772
bool playAltBass
Playback alternate bass.
Definition Details.h:771
MusxInstance< others::FretboardStyle > getFretboardStyle() const
Returns the others::FretboardStyle instance for this chord assignment.
Definition Details.cpp:517
int chPercent
Chord scaling (100 means 100%)
Definition Details.h:784
int rootAlter
Root alteration.
Definition Details.h:758
bool playSuffix
Playback suffix.
Definition Details.h:760
bool useLocalCapo
Use local capo.
Definition Details.h:773
static const xml::XmlElementArray< ChordAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool bassLowerCase
Display bass in lowercase.
Definition Details.h:768
BassPosition bassPosition
Visual position of bass relative to root.
Definition Details.h:769
Defines the octaves in which each clef should display flats in key signatures. Only linear key signat...
Definition Details.h:817
static const xml::XmlElementArray< ClefOctaveFlats > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:823
Defines the octaves in which each clef should display sharps in key signatures.
Definition Details.h:846
static const xml::XmlElementArray< ClefOctaveSharps > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:852
Represents a cross-staff assignment for the note, if any.
Definition Details.h:865
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:876
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:878
static const xml::XmlElementArray< CrossStaff > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
CrossStaff(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:868
NoteNumber noteId
The ID of the note being assigned to a different staff (XML node: <noteID>)
Definition Details.h:873
StaffCmper staff
The target staff (XML node: <instrument>)
Definition Details.h:874
Custom stem for downstem context.
Definition Details.h:930
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:934
Represents a custom stem definition (up or down) for an entry. Which stem direction this instance con...
Definition Details.h:891
Evpu yOffset
Optional vertical displacement. (xml node is <ydisp>)
Definition Details.h:905
bool calcIsHiddenStem() const
Calculates if this custom stem record hides the stem. The stem is determined to be hidden if one of t...
Definition Details.cpp:529
static MusxInstance< CustomStem > getForStem(const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:539
static const xml::XmlElementArray< CustomStem > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Cmper shapeDef
The Cmper of the associated others::ShapeDef. Setting this value to zero hides the stem.
Definition Details.h:903
Evpu xOffset
Optional horizontal displacement. (xml node is <xdisp>)
Definition Details.h:904
CustomStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor.
Definition Details.h:900
Custom stem for upstem context.
Definition Details.h:944
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:948
Represents display offsets and spacing adjustments for augmentation dots on a specific note.
Definition Details.h:960
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:975
NoteNumber noteId
The ID of the note whose dots are adjusted.
Definition Details.h:968
Evpu hOffset
Horizontal offset for the dot (XML: <xadd>)
Definition Details.h:969
Evpu vOffset
Vertical offset for the dot (XML: <yadd>)
Definition Details.h:970
static const xml::XmlElementArray< DotAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu interdotSpacing
Additional spacing between dots (XML: <posIncr>)
Definition Details.h:971
DotAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor.
Definition Details.h:963
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:973
Per-part overrides for entry properties such as manual position and stem direction.
Definition Details.h:990
bool upStem
When freezeStem is true: whether the stem is forced up (otherwise down).
Definition Details.h:1004
bool freezeStem
Whether the stem direction is frozen for this entry in this part.
Definition Details.h:1003
Evpu hOffset
Manual offset created with the Note Position Tool. (xml node is <posi>.)
Definition Details.h:1002
static const xml::XmlElementArray< EntryPartFieldDetail > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
EntryPartFieldDetail(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor function.
Definition Details.h:999
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1007
Specifies a custom size for an entry. It scales the entire entry, including the stem and all notehead...
Definition Details.h:1019
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1034
int percent
The note/chord size as a percent (e.g., 65 for 65%).
Definition Details.h:1031
static const xml::XmlElementArray< EntrySize > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
EntrySize(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor.
Definition Details.h:1028
Represents a barre (spanning multiple strings).
Definition Details.h:1095
int endString
Ending 1-based string number.
Definition Details.h:1099
int startString
Starting 1-based string number.
Definition Details.h:1098
static const xml::XmlElementArray< Barre > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
int fret
0-based fret number, where 0 signifies the open string. (Finale allows nut barres....
Definition Details.h:1097
Represents a single fretboard cell (string/fret position).
Definition Details.h:1080
Shape shape
Cell shape.
Definition Details.h:1084
int fingerNum
Finger number 0..5, where 0 means there is no finger number and 5 means T (thumb).
Definition Details.h:1085
int fret
0-based fret number, where 0 signifies the open string.
Definition Details.h:1083
static const xml::XmlElementArray< Cell > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
FretboardDiagram diagram for chord symbols.
Definition Details.h:1050
int fretboardNum
FretboardDiagram number: the starting fret of the fretboard diagram (xml node <fretNum>).
Definition Details.h:1105
bool showNum
Show fretboard number.
Definition Details.h:1107
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1114
std::vector< std::shared_ptr< Barre > > barres
Array of fretboard barres.
Definition Details.h:1112
static const xml::XmlElementArray< FretboardDiagram > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
int numFretCells
Number of fret cells (xml node <numFretCells>).
Definition Details.h:1108
Shape
Shape type for a fretboard cell.
Definition Details.h:1067
@ None
No explicit shape. This is the default value and may not occur in the xml.
@ Custom
Custom symbol. By default this is an open diamond signifying a harmonic.
bool lock
Lock flag (xml node <lock>).
Definition Details.h:1106
int numFretBarres
Number of fret barres (xml node <numFretBarres>).
Definition Details.h:1109
FretboardDiagram(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition Details.h:1055
int numFrets
Number of frets.
Definition Details.h:1104
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1131
std::vector< std::shared_ptr< Cell > > cells
Array of fretboard cells.
Definition Details.h:1111
Represents the attributes of a Finale frame holder.
Definition Details.h:1143
StaffCmper getStaff() const
returns the staffId (staff) number for this GFrameHold
Definition Details.h:1166
GFrameHold(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas)
Constructor function.
Definition Details.h:1153
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1193
std::optional< ClefIndex > clefId
clef index when there are no mid-measure clef changes. (xml tag is <clefID>).
Definition Details.h:1157
int clefPercent
Clef percent where 100 means 100%.
Definition Details.h:1162
bool iterateRawEntries(std::function< bool(const MusxInstance< Entry > &, LayerIndex)> iterator) const
Iterates all the raw entries in a the GFrameHold, passing them to the iterator function....
Definition Details.cpp:572
ShowClefMode showClefMode
"Show Clef" mode. (xml tag is <clefMode>)
Definition Details.h:1159
bool mirrorFrame
Indicates this is a mirror frame. (Not used after Finale 14.5.)
Definition Details.h:1160
static const xml::XmlElementArray< GFrameHold > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
MeasCmper getMeasure() const
returns the measure number for this GFrameHold
Definition Details.h:1169
bool calcContainsMusic() const
Returns true if the GFrameHold contains any layer frames.
Definition Details.h:1178
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1204
bool calcIsMultiLayer() const
Returns true if the GFrameHold instance has more than one layer.
Definition Details.h:1172
bool clefAfterBarline
"Place Clef After Barline"
Definition Details.h:1161
Cmper clefListId
The clef list ID when there are mid-measure clef changes, if non-zero. (xml tag is <clefListID>).
Definition Details.h:1158
std::pair< MusxInstance< others::Frame >, Edu > findLayerFrame(LayerIndex layerIndex) const
Find the layer frame and Edu start position for the given layer. A non-zero start position indicates ...
Definition Details.cpp:551
std::vector< Cmper > frames
others::Frame values for layers 1..4 (layer indices 0..3) if non-zero
Definition Details.h:1163
Represents independent time and key signature overrides for a staff.
Definition Details.h:1216
bool hasTime
If true, this item contains an independent time signature.
Definition Details.h:1247
MusxInstance< TimeSignature > createTimeSignature() const
Create a shared pointer to an instance of the TimeSignature for this instance.
Definition Details.cpp:591
Cmper divBeat
Time signature denominator in Edu or a Cmper to a composite record.
Definition Details.h:1237
bool displayAltDenTsig
If true, dispDivBeat is the Cmper of a others::TimeCompositeLower record.
Definition Details.h:1242
Cmper dispDivBeat
Display time signature denominator in Edu or a Cmper to a composite record.
Definition Details.h:1239
bool altNumTsig
If true, beats is the Cmper of a others::TimeCompositeUpper record.
Definition Details.h:1243
bool hasKey
If true, this item contains an independent key signature.
Definition Details.h:1233
std::shared_ptr< KeySignature > keySig
The key signature value if present. (xml tag is <keySig>/<key>)
Definition Details.h:1232
IndependentStaffDetails(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas)
Constructor function.
Definition Details.h:1226
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1256
bool altDenTsig
If true, divBeat is the Cmper of a others::TimeCompositeLower record.
Definition Details.h:1244
static const xml::XmlElementArray< IndependentStaffDetails > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool hasDispTime
If true, the display time signature is present.
Definition Details.h:1246
bool displayAbbrvTime
If true, the display time signature is abbreviated.
Definition Details.h:1245
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1264
Cmper dispBeats
Display time signature numerator or a Cmper to a composite record.
Definition Details.h:1238
bool displayAltNumTsig
If true, dispBeats is the Cmper of a others::TimeCompositeUpper record.
Definition Details.h:1241
MusxInstance< TimeSignature > createDisplayTimeSignature() const
Create a shared pointer to an instance of the display TimeSignature for this measure and staff.
Definition Details.cpp:596
Cmper beats
Time signature numerator or a Cmper to a composite record.
Definition Details.h:1236
Represents a single element in a Finale accidental symbol list.
Definition Details.h:1275
int getAlterationValue() const
Returns the alteration value that this symbol corresponds with.
Definition Details.h:1285
KeySymbolListElement(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition Details.h:1278
static const xml::XmlElementArray< KeySymbolListElement > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1298
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1289
std::string accidentalString
Definition Details.h:1281
Contains the syllable assignments for lyrics chorus blocks.
Definition Details.h:1356
MusxInstance< texts::LyricsTextBase > getLyricText() const override
Get the raw lyric text for this assignment.
Definition Details.cpp:614
LyricTextType getLyricTextType() const override
Get the lyric text type for this assignment.
Definition Details.cpp:629
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1365
Contains the syllable assignments for lyrics section blocks.
Definition Details.h:1375
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1384
LyricTextType getLyricTextType() const override
Get the lyric text type for this assignment.
Definition Details.cpp:634
MusxInstance< texts::LyricsTextBase > getLyricText() const override
Get the raw lyric text for this assignment.
Definition Details.cpp:619
Contains the syllable assignments for lyrics verse blocks.
Definition Details.h:1394
LyricTextType getLyricTextType() const override
Get the lyric text type for this assignment.
Definition Details.cpp:624
MusxInstance< texts::LyricsTextBase > getLyricText() const override
Get the raw lyric text for this assignment.
Definition Details.cpp:609
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1403
Contains assignment data for a lyric assignment (a single syllable)
Definition Details.h:1307
util::EnigmaParsingContext getRawTextCtx() const
Return an Enigma parsing context for the associated lyrics text block.
Definition Details.cpp:639
virtual LyricTextType getLyricTextType() const =0
Get the lyric text type for this assignment.
Evpu wext
Definition Details.h:1325
LyricAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:1317
static const xml::XmlElementArray< LyricAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Cmper lyricNumber
the text number of the lyric.
Definition Details.h:1320
unsigned syllable
the 1-based syllable number. Subtract 1 for an index into texts::LyricsTextBase::syllables....
Definition Details.h:1321
Evpu floatingHorzOff
This appears to have something to do with note spacing. It may simply be a cache that Finale changes ...
Definition Details.h:1324
Evpu horzOffset
horizontal offset from default position. (xml node is <horzOff>)
Definition Details.h:1322
virtual MusxInstance< texts::LyricsTextBase > getLyricText() const =0
Get the raw lyric text for this assignment.
Evpu vertOffset
horizontal offset from default position. (xml node is <vertOff>)
Definition Details.h:1323
bool displayVerseNum
If set, the text block number displays to the left of the syllable. (E.g., when numbering verses in a...
Definition Details.h:1328
EntryInfoPtr calcWordExtensionEndpoint() const
Calculate the entry to which an automatic word extension extends.
Definition Details.cpp:648
Specifies lyric alignment and justification for a single entry. This affects all lyric assignments on...
Definition Details.h:1414
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1431
std::optional< AlignJustify > align
Override default alignment if present. (xml node is <align>)
Definition Details.h:1428
static const xml::XmlElementArray< LyricEntryInfo > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
LyricEntryInfo(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
Constructor.
Definition Details.h:1424
std::optional< AlignJustify > justify
Override default justification if present. (xml node is <justify>)
Definition Details.h:1427
Per-staff/per-measure overrides for the position and appearance of a measure number.
Definition Details.h:1442
ForceVisibility
Force-visibility options for the measure number at this location.
Definition Details.h:1463
@ Show
Force the number to display (xml text value: "force")
@ Hide
Force the number to be hidden (xml text value: "hide")
@ None
No override (default; node may be omitted in XML)
bool useEnclosure
Whether to use an enclosure for this number. (xml node is <useEncl>)
Definition Details.h:1474
Evpu xOffset
Horizontal offset for the measure number. (xml node is <x1add>)
Definition Details.h:1470
Evpu xOffset2
Horizontal offset for the measure number range under a multimeasure rest (Page View only)....
Definition Details.h:1472
MeasureNumberIndividualPositioning(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
Constructor.
Definition Details.h:1453
static const xml::XmlElementArray< MeasureNumberIndividualPositioning > & xmlMappingArray()
Required for musx::
ForceVisibility forceVisibility
Force-visibility behavior. (xml node is <forceHide>)
Definition Details.h:1473
Cmper measNumRegion
The Cmper of the others::MeasureNumberRegion that this override applies to. (xml node is <region>)
Definition Details.h:1469
std::shared_ptr< others::Enclosure > enclosure
Optional enclosure settings. (xml node is <encl>)
Definition Details.h:1475
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1477
Evpu yOffset
Vertical offset for the measure number. (xml node is <y1add>)
Definition Details.h:1471
Represents a text block assignment for a staff and measure.
Definition Details.h:1497
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1526
util::EnigmaParsingContext getRawTextCtx(Cmper forPartId) const
Gets the raw text for this assignment, or nullptr if none.
Definition Details.cpp:679
Evpu yDisp
Vertical displacement in Evpu (xml node is <ydisp>)
Definition Details.h:1517
Evpu xDispEvpu
Negative horizontal displacement in Evpu, when xDispEdu is zero. (xml node is <xdispEvpu>)
Definition Details.h:1516
MusxInstance< others::TextBlock > getTextBlock() const
Gets the TextBlock for this assignment, or nullptr if none.
Definition Details.cpp:674
MeasureTextAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
Constructor.
Definition Details.h:1508
Cmper block
Text block ID.
Definition Details.h:1513
bool hidden
Indicates the text appears only on screen (xml node is <postIt/>)
Definition Details.h:1518
static const xml::XmlElementArray< MeasureTextAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Edu xDispEdu
Definition Details.h:1514
Represents graphical and notational alterations applied to a note.
Definition Details.h:1539
bool allowVertPos
Whether vertical positioning is allowed .
Definition Details.h:1553
int percent
Size percentage for the notehead. (A value of 100 means 100%.)
Definition Details.h:1548
char32_t altNhead
Alternate notehead character. Zero (the default) means no override is specified.
Definition Details.h:1550
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1560
NoteAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:1542
Evpu nydisp
Vertical notehead offset.
Definition Details.h:1554
std::shared_ptr< FontInfo > customFont
Custom font info (consolidates: <fontID>, <fontSize>, <efx>)
Definition Details.h:1552
bool useOwnFont
Whether to use the custom font.
Definition Details.h:1551
Evpu nxdisp
Horizontal notehead offset.
Definition Details.h:1549
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:1558
bool enharmonic
Definition Details.h:1555
NoteNumber noteId
The ID of the note being altered. (xml node is <noteID>)
Definition Details.h:1547
static const xml::XmlElementArray< NoteAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Represents a percussion note code override for a single note.
Definition Details.h:1573
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:1584
NoteNumber noteId
The ID of the note being assigned a code.
Definition Details.h:1581
PercussionNoteTypeId noteCode
The percussion note code. Use this to search the incis of the percussion map for the specific note.
Definition Details.h:1582
static const xml::XmlElementArray< PercussionNoteCode > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
PercussionNoteCode(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:1576
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1586
Beam alteration for downstem secondary beams.
Definition Details.h:1597
static bool calcIsFeatheredBeam(const EntryInfoPtr &entryInfo, Evpu &outLeftY, Evpu &outRightY)
Calculates if the input entry starts a feathered beam and returns information about it.
Definition Details.h:1617
SecondaryBeamAlterationsDownStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor.
Definition Details.h:1608
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1620
Beam alteration for downstem secondary beams.
Definition Details.h:1630
static bool calcIsFeatheredBeam(const EntryInfoPtr &entryInfo, Evpu &outLeftY, Evpu &outRightY)
Calculates if the input entry starts a feathered beam and returns information about it.
Definition Details.h:1650
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1653
SecondaryBeamAlterationsUpStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor.
Definition Details.h:1641
Specifies which secondary beams break and restart on the associated entry.
Definition Details.h:1665
SecondaryBeamBreak(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor function.
Definition Details.h:1668
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1709
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1696
BeamNumber calcLowestBreak() const
Calculates the lowest (largest note-value) beam specified for a secondary beam break.
Definition Details.h:1682
bool breakThrough
True if the beam should be broken through to the largest specified beam value.
Definition Details.h:1674
unsigned mask
Composite mask of beam breaks, derived from <do16th> through <do4096th> tags.
Definition Details.h:1673
static const xml::XmlElementArray< SecondaryBeamBreak > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Embedded shape record for a single index in noteShapes.
Definition Details.h:1735
char32_t quarter
Filled (quarter) notehead symbol (xml nodename is <q>).
Definition Details.h:1740
char32_t whole
Whole notehead symbol (xml nodename is <w>).
Definition Details.h:1738
static const xml::XmlElementArray< NoteShapes > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
char32_t doubleWhole
Double-whole notehead symbol (xml nodename is <d>).
Definition Details.h:1737
char32_t half
Half notehead symbol (xml nodename is <h>).
Definition Details.h:1739
Shape Note settings for staves and staffs style.
Definition Details.h:1723
ShapeNoteBase(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition Details.h:1727
std::vector< std::shared_ptr< NoteShapes > > noteShapes
Notehead shapes (only the first seven elements are used).
Definition Details.h:1745
bool arrangedByPitch
Definition Details.h:1746
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1749
static const xml::XmlElementArray< ShapeNoteBase > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Shape Note settings for staff styles.
Definition Details.h:1788
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1792
Shape Note settings for staves.
Definition Details.h:1773
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1777
Provides run-time information about Staff Groups within a system or list of others::StaffUsed.
Definition Details.h:1935
std::optional< size_t > startSlot
the 0-based start slot (index) of the group in the system staves.
Definition Details.h:1937
std::optional< size_t > endSlot
the 0-based end slot (index) of the group in the system staves.
Definition Details.h:1938
std::optional< size_t > numStaves() const
The number of staves in the group for the systemStaves.
Definition Details.h:1949
MusxInstanceList< others::StaffUsed > systemStaves
the system staves referred to by startSlot and endSlot
Definition Details.h:1940
MusxInstance< StaffGroup > group
the StaffGroup record for the group.
Definition Details.h:1939
bool calcIsSingleInstrumentSection(MeasCmper measureId) const
Returns true if this staff group spans multiple staves with the same exact instrument UUID,...
Definition Details.cpp:816
void iterateStaves(MeasCmper measId, Edu eduPosition, std::function< bool(const MusxInstance< others::StaffComposite > &)> iterator) const
Iterates the staves in the group in order according to systemStaves.
Definition Details.cpp:796
static std::vector< StaffGroupInfo > getGroupsAtMeasure(MeasCmper measureId, Cmper linkedPartId, const MusxInstanceList< others::StaffUsed > &systemStaves)
Creates a vector of StaffGroupInfo instances for the measure, part, and system staves.
Definition Details.cpp:879
Represents the attributes of a Finale staff group that brackets staves.
Definition Details.h:1801
AlignJustify abbrvNameJustify
Abbreviated name justification (xml node is <abbrvJustify>)
Definition Details.h:1850
bool abbrvNameExpand
"Expand Single Word" for abbreviated name (xml node is <abbrvExpand>)
Definition Details.h:1862
Cmper multiStaffGroupId
Definition Details.h:1865
static const xml::XmlElementArray< StaffGroup > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool fullNameExpand
"Expand Single Word" for full name (xml node is <fullExpand>)
Definition Details.h:1861
bool ownBarline
"Use Alternate Group Barline"
Definition Details.h:1852
int abbrvNameYadj
Vertical adjustment for abbreviated name (xml node is <abbrvYadj>)
Definition Details.h:1858
DrawBarlineStyle
Enum for how to draw group barlines.
Definition Details.h:1822
@ Mensurstriche
Draw barlines between staves (xml value is "Mensurstriche" with capitalization)
@ ThroughStaves
Draw barlines through staves (xml value is "group")
@ OnlyOnStaves
Default value (may not appear in xml)
std::string getAbbreviatedInstrumentName(util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
Returns the abbreviated instrument name for this group without Enigma tags and with autonumbering (if...
Definition Details.cpp:764
bool isAllMeasures() const
Returns true if this group spans all measures.
Definition Details.h:1910
Cmper abbrvNameId
Abbreviated name TextBlock cmper (xml node is <abbrvID>)
Definition Details.h:1856
StaffCmper startInst
Starting staff ID.
Definition Details.h:1840
int fullNameXadj
Horizontal adjustment for full name (xml node is <fullXadj>)
Definition Details.h:1845
std::shared_ptr< Bracket > bracket
Bracket Options. The factory guarantees this value to exist.
Definition Details.h:1847
util::EnigmaParsingContext getAbbreviatedNameCtx() const
Get the raw text context for the abbreviated staff group name.
Definition Details.cpp:709
std::string getAbbreviatedName(util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
Get the abbreviated staff group name without Enigma tags.
Definition Details.cpp:717
AlignJustify fullNameJustify
Full name justification (xml node is <fullJustify>)
Definition Details.h:1849
DrawBarlineStyle drawBarlines
"Draw Barlines" option (xml node is <groupBarlineStyle>)
Definition Details.h:1851
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1913
AlignJustify abbrvNameAlign
Abbreviated name horizontal alignment (xml node is <abbrvHAlign>)
Definition Details.h:1860
util::EnigmaParsingContext getAbbreviatedInstrumentNameCtx() const
Returns the raw text context for the abbreviated instrument name for this group, with autonumbering c...
Definition Details.cpp:754
util::EnigmaParsingContext getFullNameCtx() const
Get the raw text context for the full staff group name.
Definition Details.cpp:693
std::unordered_set< StaffCmper > staves
Calculated list of staves in the group.
Definition Details.h:1870
int fullNameYadj
Vertical adjustment for full name (xml node is <fullYadj>)
Definition Details.h:1846
HideStaves hideStaves
"When Hiding Empty Staves" option (xml node is <optimize>)
Definition Details.h:1863
BarlineType barlineType
Group barline type (xml node is <barline>)
Definition Details.h:1848
AlignJustify fullNameAlign
Full name horizontal alignment (xml node is <fullHAlign>)
Definition Details.h:1859
Cmper fullNameId
Full name TextBlock cmper (xml node is <fullID>)
Definition Details.h:1844
std::string getFullInstrumentName(util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
Returns the full instrument name for this group without Enigma tags and with autonumbering (if any).
Definition Details.cpp:746
StaffCmper endInst
Ending staff ID.
Definition Details.h:1841
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1926
MeasCmper startMeas
Starting measure number.
Definition Details.h:1842
std::string getFullName(util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
Get the full staff group name without Enigma tags.
Definition Details.cpp:701
MusxInstance< others::MultiStaffInstrumentGroup > getMultiStaffInstGroup() const
Returns the others::MultiStaffInstrumentGroup for this group if it is part of one....
Definition Details.cpp:725
MeasCmper endMeas
Ending measure number.
Definition Details.h:1843
StaffGroup(const DocumentWeakPtr &document, Cmper partId, EnigmaBase::ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor.
Definition Details.h:1811
bool hideName
Inverse of "Show Group Name".
Definition Details.h:1855
bool fullNameIndivPos
Indicates if full name has individual position (xml node is <fullIndivPos>)
Definition Details.h:1853
util::EnigmaParsingContext getFullInstrumentNameCtx() const
Returns the raw text context for the full instrument name for this group, with autonumbering context ...
Definition Details.cpp:736
bool abbrvNameIndivPos
Indicates if abbreviated name has individual position (xml node is <abbrvIndivPos>)
Definition Details.h:1854
int abbrvNameXadj
Horizontal adjustment for abbreviated name (xml node is <abbrvXadj>)
Definition Details.h:1857
HideStaves
Enum for optimization options.
Definition Details.h:1833
@ AsGroup
Hide staves only if all staves are empty.
@ Normally
Hide staves as if there were no StaffGroup (this is the default and may not appear in the xml)
@ None
Never hide the staves in this StaffGroup.
Represents a per-staff-size override for a specific staff in a system.
Definition Details.h:1985
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2006
static const xml::XmlElementArray< StaffSize > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
util::Fraction calcStaffScaling() const
Calculate the staff scaling.
Definition Details.h:2003
StaffSize(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staffId)
Constructor.
Definition Details.h:1995
int staffPercent
The staff size percentage override. (A value of 100 means 100%, i.e, no staff scaling....
Definition Details.h:2000
Specifies horizontal and vertical adjustments for stems under beam.
Definition Details.h:2045
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2049
Specifies horizontal and vertical stem adjustments for upstem and downstem contexts.
Definition Details.h:2019
Evpu upVertAdjust
Vertical adjustment for upstem context (positive is up).
Definition Details.h:2027
Evpu downHorzAdjust
Horizontal adjustment for downstem context (positive is right).
Definition Details.h:2030
Evpu downVertAdjust
Vertical adjustment for downstem context (positive is up).
Definition Details.h:2028
static const xml::XmlElementArray< StemAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu upHorzAdjust
Horizontal adjustment for upstem context (positive is right).
Definition Details.h:2029
StemAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor function.
Definition Details.h:2022
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2032
Specifies the TAB string a note appears on. Finale automatically figures out the fret number from the...
Definition Details.h:2062
TablatureNoteMods(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:2065
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:2074
static const xml::XmlElementArray< TablatureNoteMods > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2076
NoteNumber noteId
The ID of the tablature note being modified. (xml node is <noteID>)
Definition Details.h:2070
int stringNumber
Definition Details.h:2071
Base class for tie alteration properties. (Used for both ties and tie ends.)
Definition Details.h:2085
DirectionContext
Indicates the placement context of end- and control-point adjustments.
Definition Details.h:2131
@ Under
The tie is positioned below (e.g., tie under)
@ Over
The tie is positioned above (e.g., tie over)
Evpu yEnd
Vertical end position of the tie.
Definition Details.h:2141
NoteNumber noteId
Note ID associated with the tie alteration. (xml node is <noteID>)
Definition Details.h:2137
bool outerOn
Enable "Outer" placement.
Definition Details.h:2143
bool outerLocal
Local setting for "Outer Tie".
Definition Details.h:2142
Evpu xStart
Horizontal start position of the tie.
Definition Details.h:2138
DirectionContext enPtContext
End point must match this direction context for xEnd & yEnd to apply.
Definition Details.h:2164
Evpu height1
Height of the first control point.
Definition Details.h:2166
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:2173
bool afterMultiDotsLocal
Local setting for "After Multiple Dots".
Definition Details.h:2146
bool shiftForSecondsOn
Enable "Shift for Seconds".
Definition Details.h:2149
Evpu height2
Height of the second control point.
Definition Details.h:2168
ConnectionType stPtEntCnct
Start point must match this connection type for xStart & yStart to apply.
Definition Details.h:2160
ConnectionType
Defines tie connection points for start and end attachment locations.
Definition Details.h:2106
@ EntryLeftNoteCenter
Left of entry, center of note.
@ DotRightNoteCenter
Right of dot(s), center of note.
@ NoteRightNoteTop
Right of note, top of note.
@ NoteCenterNoteBottom
Horizontal center of note, bottom of note.
@ EntryCenterNoteBottom
Horizontal center of entry, bottom of note.
@ NoteCenterNoteTop
Horizontal center of note, top of note.
@ SystemEnd
System end (for the right side across systems)
@ NoteLeftNoteCenter
Left of note, center of note.
@ EntryCenterNoteTop
Horizontal center of entry, top of note.
@ NoteRightNoteBottom
Right of note, bottom of note.
@ SystemStart
System start (for the left side across systems)
@ EntryRightNoteCenter
Right of entry, center of note.
@ NoteRightNoteCenter
Right of note, center of note.
@ AccidentalLeftNoteCenter
Left of accidental, center of note.
@ NoteLeftNoteBottom
Left of note, bottom of note.
static MusxInstance< TieAlterBase > fromNoteInfo(const NoteInfoPtr &noteInfoPtr, bool forTieEnd=false)
Gets the the TieAlterStart or TieAlterEnd for this note, based on the input boolean.
Definition Details.cpp:905
Evpu insetRatio1
Inset ratio for the first control point.
Definition Details.h:2165
bool enPtAdjOn
Enable end point adjustment.
Definition Details.h:2162
ConnectionType enPtEntCnct
End point must match this connection type for xEnd & yEnd to apply.
Definition Details.h:2163
bool shiftForSecondsLocal
Local setting for "Shift for Seconds".
Definition Details.h:2148
bool afterSingleDotOn
Enable "After Single Dot".
Definition Details.h:2145
bool afterMultiDotsOn
Enable "After Multiple Dots".
Definition Details.h:2147
Evpu insetRatio2
Inset ratio for the second control point.
Definition Details.h:2167
bool breakKeyLocal
Local setting for "Break at Key Signature".
Definition Details.h:2155
bool ctlPtFixed
Definition Details.h:2170
TieAlterBase(const DocumentWeakPtr &document, Cmper partId, EnigmaBase::ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:2088
bool breakKeyOn
Enable "Break at Key Signature".
Definition Details.h:2156
bool down
Downward tie. Only applicable if freezeDirection is true. (False freezes the tie up....
Definition Details.h:2152
DirectionContext stPtContext
Start point must match this direction context for xStart & yStart to apply.
Definition Details.h:2161
bool beforeSingleAcciOn
Enable "Before Single Accidental".
Definition Details.h:2151
bool noSpecialArc
Inverse of "Avoid Staff Lines". (See options::TieOptions for more information about the naming....
Definition Details.h:2158
bool stPtAdjOn
Enable start point adjustment.
Definition Details.h:2159
static const xml::XmlElementArray< TieAlterBase > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool beforeSingleAcciLocal
Local setting for "Before Single Accidental".
Definition Details.h:2150
Evpu xEnd
Horizontal end position of the tie.
Definition Details.h:2139
bool ctlPtAdjOn
Enable control point adjustment.
Definition Details.h:2169
bool breakTimeLocal
Local setting for "Break at Time Signature".
Definition Details.h:2153
bool freezeDirection
Freeze tie direction. (xml node is <freeze>)
Definition Details.h:2157
Evpu yStart
Vertical start position of the tie.
Definition Details.h:2140
bool afterSingleDotLocal
Local setting for "After Single Dot".
Definition Details.h:2144
bool breakTimeOn
Enable "Break at Time Signature".
Definition Details.h:2154
Alterations for tie ends.
Definition Details.h:2187
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2191
static const xml::XmlElementArray< TieAlterEnd > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Alterations for tie starts. (Tie starts are normal ties.)
Definition Details.h:2204
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2208
static const xml::XmlElementArray< TieAlterStart > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Options controlling the appearance of tuplets.
Definition Details.h:2221
bool hidden
Inverse of "Show".
Definition Details.h:2247
util::Fraction calcRatio() const
return the tuplet ratio (reference / display)
Definition Details.h:2274
util::Fraction calcDisplayDuration() const
return the display duration as a util::Fraction of a whole note
Definition Details.h:2271
Evpu tupOffX
Horizontal offset.
Definition Details.h:2248
Evpu rightHookLen
Length of the right hook in the tuplet bracket. (This value is sign-reversed in the Finale UI....
Definition Details.h:2263
Evpu brackOffY
Vertical offset for brackets.
Definition Details.h:2251
BracketStyle brackStyle
Bracket style.
Definition Details.h:2259
bool avoidStaff
"Avoid Staff"
Definition Details.h:2245
AutoBracketStyle autoBracketStyle
Autobracket style.
Definition Details.h:2246
bool alwaysFlat
"Always Flat" (xml node is <flat>)
Definition Details.h:2242
bool fullDura
"Bracket Full Duration"
Definition Details.h:2243
bool allowHorz
"Allow Horizontal Drag"
Definition Details.h:2254
int referenceNumber
The number of notes "in the time of" (xml node is <refNum>)
Definition Details.h:2240
Evpu rightHookExt
Extension of the right hook beyond the tuplet bracket.
Definition Details.h:2264
Evpu leftHookExt
Extension of the left hook beyond the tuplet bracket.
Definition Details.h:2262
bool ignoreHorzNumOffset
"Ignore Horizontal Number Offset" (xml node is <ignoreGlOffs>)
Definition Details.h:2255
TupletDef(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:2224
util::Fraction calcReferenceDuration() const
return the reference duration as a util::Fraction of a whole note
Definition Details.h:2268
bool smartTuplet
"Engraver Tuplets"
Definition Details.h:2260
Edu displayDuration
The duration of each note to display (xml node is <symbolicDur>)
Definition Details.h:2239
Evpu tupOffY
Vertical.
Definition Details.h:2249
NumberStyle numStyle
Number style.
Definition Details.h:2252
static const xml::XmlElementArray< TupletDef > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu brackOffX
Horizontal offset for brackets.
Definition Details.h:2250
Evpu manualSlopeAdj
"Manual Slope Adjustment" in Evpu. (xml node is <slope>)
Definition Details.h:2265
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2276
bool breakBracket
"Break Slur or Bracket"
Definition Details.h:2256
int displayNumber
The number of notes to display (xml node is <symbolicNum>)
Definition Details.h:2238
bool metricCenter
"Center Number Using Duration"
Definition Details.h:2244
bool useBottomNote
"Use Bottom Note" (xml node is <noteBelow>)
Definition Details.h:2258
bool matchHooks
"Match Length of Hooks"
Definition Details.h:2257
PositioningStyle posStyle
Positioning style.
Definition Details.h:2253
Edu referenceDuration
The duration of each note "in the time of" (xml node is <refDur>)
Definition Details.h:2241
Evpu leftHookLen
Length of the left hook in the tuplet bracket. (This value is sign-reversed in the Finale UI....
Definition Details.h:2261
FlattenStyle
Beaming style choices for when to flatten beams.
Definition Options.h:174
BracketStyle
Bracket style options.
Definition Options.h:1810
PositioningStyle
Positioning style options.
Definition Options.h:1797
AutoBracketStyle
Auto-bracket style options.
Definition Options.h:1769
NumberStyle
Number style options.
Definition Options.h:1784
BarlineType
Barline type for left and right barlines.
Definition Others.h:1166
Contains chorus text for lyrics.
Definition Texts.h:162
Contains section text for lyrics.
Definition Texts.h:175
Contains verse text for lyrics.
Definition Texts.h:149
Wrapper class for interpreting and rendering Enigma-style strings with insert handling.
Definition EnigmaString.h:430
AccidentalStyle
Enumeration to specify the type of accidental substitution representation.
Definition EnigmaString.h:203
@ Ascii
Use ASCII substitutions for accidentals.
A class to represent fractions with integer m_numerator and m_denominator, automatically reduced to s...
Definition Fraction.h:38
static constexpr Fraction fromPercent(int percent)
Constructs a Fraction from a percent (where 100 is 100%)
Definition Fraction.h:97
@ Verbose
Informational messages that should only displayed when verbose logging is requested.
static void log(LogLevel level, const std::string &message)
Logs a message with a specific severity level.
Definition Logger.h:87
constexpr int STANDARD_DIATONIC_STEPS
currently this is the only supported number of diatonic steps.
Definition music_theory.hpp:45
constexpr int MAX_ALTERATIONS
Maximum absolute value for chromatic alterations supported in Finale.
Definition Fundamentals.h:80
ShowClefMode
Enum representing the clef display mode for a frame.
Definition EnumClasses.h:164
LyricTextType
The lyric text type if this is a lyrics smart shape.
Definition EnumClasses.h:119
uint16_t PercussionNoteTypeId
multiple times in one layout. The rest are the "pure" note type. See percussion::PercussionNoteType.
Definition Fundamentals.h:76
int16_t MeasCmper
Enigma meas Cmper (may be negative when not applicable)
Definition Fundamentals.h:66
int32_t Efix
EFIX value (64 per EVPU, 64*288=18432 per inch)
Definition Fundamentals.h:62
std::shared_ptr< const T > MusxInstance
Defines the type of a musx instance stored in a pool.
Definition MusxInstance.h:40
unsigned int LayerIndex
Layer index (valid values are 0..3)
Definition Fundamentals.h:73
constexpr Cmper SCORE_PARTID
The part id of the score.
Definition Fundamentals.h:81
VerticalPlacement
Specifies a vertical placement relationship for notation objects.
Definition EnumClasses.h:202
@ NotApplicable
Above/below placement does not meaningfully apply.
int16_t Inci
Enigma "incident" key type.
Definition Fundamentals.h:58
int32_t Evpu
EVPU value (288 per inch)
Definition Fundamentals.h:59
constexpr int MAX_LAYERS
The maximum number of music layers in a Finale document.
Definition Fundamentals.h:79
uint16_t Cmper
Enigma "comperator" key type.
Definition Fundamentals.h:57
int32_t Edu
"Enigma Durational Units" value (1024 per quarter note)
Definition Fundamentals.h:63
std::weak_ptr< Document > DocumentWeakPtr
Shared weak Document pointer.
Definition DocumentElement.h:37
int32_t EntryNumber
Entry identifier.
Definition Fundamentals.h:71
uint16_t NoteNumber
Note identifier.
Definition Fundamentals.h:72
std::shared_ptr< Document > DocumentPtr
Shared Document pointer.
Definition DocumentElement.h:35
int16_t StaffCmper
Enigma staff (staffId) Cmper (may be negative when not applicable)
Definition Fundamentals.h:67
AlignJustify
Alignment and justification options for staff and group names.
Definition EnumClasses.h:30
unsigned int BeamNumber
A number where 1 corresponds to the primary (8th note) beam, 2 the 16th beam, 3 the 32nd beam,...
Definition Fundamentals.h:74
std::vector< XmlElementDescriptor< T > > XmlElementArray
an array type for XmlElementDescriptor instances.
Definition XmlInterface.h:127
object model for musx file (enigmaxml)
Definition BaseClasses.h:38
Provides information about the best analysis as to which articulation symbol in being used on this as...
Definition Details.h:118
MusxInstance< others::ArticulationDef > definition
The associated articulation definition.
Definition Details.h:119
others::ArticulationDef::SelectedSymbol symbol
Definition Details.h:120
VerticalPlacement placement
The resolved placement for the selected symbol.
Definition Details.h:122
The resolved main or alternate symbol selection for an articulation definition.
Definition Others.h:257
Information about a shape that could be used as a surrogate for a tie.
Definition PseudoTieUtils.h:55