25#include <unordered_set>
29#include "music_theory/music_theory.hpp"
31#include "musx/util/EnigmaString.h"
32#include "musx/util/PseudoTieUtils.h"
33#include "MusxInstance.h"
34#include "BaseClasses.h"
35#include "CommonClasses.h"
49class ChordSuffixElement;
55class MultiStaffInstrumentGroup;
126 struct PseudoTieShapeContext
174 [[nodiscard]] std::optional<utils::PseudoTieShapeInfo>
calcIsPseudoTie(utils::PseudoTieMode mode,
201 [[nodiscard]] std::optional<PseudoTieShapeContext> calcPseudoTieShapeContext(
const EntryInfoPtr& forStartEntry)
const;
230 :
DetailsBase(document, partId, shareMode, system, staff, inci) {}
256 :
Baseline(document, partId, shareMode, system, staff, std::nullopt) {}
268 constexpr static std::string_view
XmlNodeName =
"baselinesSysChords";
280 constexpr static std::string_view
XmlNodeName =
"baselinesSysExprAboveStaff";
292 constexpr static std::string_view
XmlNodeName =
"baselinesSysExprBelowStaff";
304 constexpr static std::string_view
XmlNodeName =
"baselinesSysFingerboards";
316 constexpr static std::string_view
XmlNodeName =
"baselinesSysLyricsChorus";
328 constexpr static std::string_view
XmlNodeName =
"baselinesSysLyricsSection";
340 constexpr static std::string_view
XmlNodeName =
"baselinesSysLyricsVerse";
355 constexpr static std::string_view
XmlNodeName =
"baselinesChords";
370 constexpr static std::string_view
XmlNodeName =
"baselinesExprAboveStaff";
385 constexpr static std::string_view
XmlNodeName =
"baselinesExprBelowStaff";
400 constexpr static std::string_view
XmlNodeName =
"baselinesFingerboards";
416 constexpr static std::string_view
XmlNodeName =
"baselinesLyricsChorus";
432 constexpr static std::string_view
XmlNodeName =
"baselinesLyricsSection";
448 constexpr static std::string_view
XmlNodeName =
"baselinesLyricsVerse";
460 bool m_active =
true;
464 template <
typename SecondaryBeamType>
468 template <
typename SecondaryBeamType>
505 template <
typename T,
506 std::enable_if_t<std::is_base_of_v<BeamAlterations, T>,
int> = 0>
542 constexpr static std::string_view
XmlNodeName =
"beamAltPrimDownStem";
564 constexpr static std::string_view
XmlNodeName =
"beamAltPrimUpStem";
618 constexpr static std::string_view
XmlNodeName =
"beamExtendDownStem";
630 constexpr static std::string_view
XmlNodeName =
"beamExtendUpStem";
678 :
DetailsBase(document, partId, shareMode, cmper1, cmper2, inci)
724 Cmper calcFretboardGroupCmper()
const;
737 :
DetailsBase(document, partId, shareMode, staffId, meas, inci)
818 std::string_view xmlTag()
const override {
return XmlNodeName; }
847 std::string_view xmlTag()
const override {
return XmlNodeName; }
1007 constexpr static std::string_view
XmlNodeName =
"entryPartFieldDetail";
1056 :
DetailsBase(document, partId, shareMode, cmper1, cmper2)
1114 std::vector<std::shared_ptr<Cell>>
cells;
1123 MUSX_INTEGRITY_ERROR(
"FretboardDiagram " + std::to_string(
getCmper1()) +
", " + std::to_string(
getCmper2())
1124 +
" specifies the wrong number of cells (" + std::to_string(oldVal) +
").");
1129 MUSX_INTEGRITY_ERROR(
"FretboardDiagram " + std::to_string(
getCmper1()) +
", " + std::to_string(
getCmper2())
1130 +
" specifies the wrong number of barres (" + std::to_string(oldVal) +
").");
1177 return std::count_if(
frames.begin(),
frames.end(), [](
Cmper frameId) { return frameId != 0; }) > 1;
1183 return std::find_if(
frames.begin(),
frames.end(), [](
Cmper frameId) { return frameId != 0; }) !=
frames.end();
1200 MUSX_INTEGRITY_ERROR(
"GFrameHold for staff " + std::to_string(
getCmper1()) +
" and measure " + std::to_string(
getCmper2()) +
" has both clef and clef list.");
1203 MUSX_INTEGRITY_ERROR(
"GFrameHold for staff " + std::to_string(
getCmper1()) +
" and measure " + std::to_string(
getCmper2()) +
" has neither clef nor clef list.");
1230 :
DetailsBase(document, partId, shareMode, staffId, meas)
1282 :
DetailsBase(document, partId, shareMode, cmper1, cmper2) {}
1289 return static_cast<int16_t
>(
getCmper2());
1462 :
DetailsBase(document, partId, shareMode, staffId, meas, inci)
1518 :
DetailsBase(document, partId, shareMode, staffId, meas, inci)
1627 {
return calcIsFeatheredBeamImpl<SecondaryBeamAlterationsDownStem>(entryInfo, outLeftY, outRightY); }
1660 {
return calcIsFeatheredBeamImpl<SecondaryBeamAlterationsUpStem>(entryInfo, outLeftY, outRightY); }
1693 MUSX_ASSERT_IF(!
mask ||
mask >=
unsigned(NoteType::Eighth)) {
1696 for (
unsigned shift = 0;
true; shift++) {
1697 if (
mask & (
unsigned(NoteType::Note16th) >> shift)) {
1709 mask = unsigned(NoteType::Note4096th);
1711 "Secondary beam break for entry " + std::to_string(
getEntryNumber())
1712 +
" has no breaks; the 4096th-note beam was assumed.");
1714 if (
mask >=
unsigned(NoteType::Eighth)) {
1715 mask = unsigned(NoteType::Eighth) - 1;
1716 MUSX_INTEGRITY_ERROR(
"Secondary beam break for entry " + std::to_string(
getEntryNumber()) +
" specifies a value that cannot be a secondary beam.");
1739 :
DetailsBase(document, partId, shareMode, cmper1, cmper2)
1763 const size_t currentSize =
noteShapes.size();
1766 noteShapes.emplace_back(std::make_shared<NoteShapes>());
1768 MUSX_INTEGRITY_ERROR(
"For ShapeNoteBase cmper " + std::to_string(
getCmper1()) +
", only " + std::to_string(currentSize)
1823 :
DetailsBase(document, partId, shareMode, cmper1, cmper2) {}
1922 {
return (
startMeas == 1 &&
endMeas == (std::numeric_limits<MeasCmper>::max)()); }
1933 +
" starts at measure " + std::to_string(
startMeas) +
" and ends at measure " + std::to_string(
endMeas));
1969 return std::nullopt;
2011 :
DetailsBase(document, partId, shareMode, system, staffId)
2297#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2299struct PartContextRebinder<details::MeasureNumberIndividualPositioning>
2301 static void rebind(
const std::shared_ptr<details::MeasureNumberIndividualPositioning>& positioning);
Template pattern for DetailsBase items consisting of an array of a single item.
Definition BaseClasses.h:522
DetailsArray(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition BaseClasses.h:528
EnigmaBase class for all "details" types.
Definition BaseClasses.h:397
Cmper getCmper1() const
Gets the cmper1 key value.
Definition BaseClasses.h:443
Cmper getCmper2() const
Gets the cmper2 key value.
Definition BaseClasses.h:448
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:95
Cmper getSourcePartId() const
Gets the source partId for this instance. If an instance is fully shared with the score,...
Definition BaseClasses.h:108
virtual void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis)
Performs a final consistency check after population.
Definition BaseClasses.h:116
EnigmaBase class for all "details" types that use entnum rather than cmper and cmper.
Definition BaseClasses.h:471
EntryNumber getEntryNumber() const
Gets the entnum key value.
Definition BaseClasses.h:510
StemSelection
The options for choosing which version to retrieve for stem-specific details.
Definition BaseClasses.h:476
@ 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:555
Represents the default font settings for a particular element type.
Definition CommonClasses.h:111
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:553
Wraps an EntryInfo instance and a note index.
Definition Entries.h:1640
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:253
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:424
static MusxInstance< BeamAlterations > getPrimaryForStem(const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:416
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:339
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:401
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:312
static void calcAllActiveFlags(const DocumentPtr &document)
Used by the factory to set active indicators.
Definition Details.cpp:292
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:462
static MusxInstance< BeamExtension > getForStem(const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:484
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
@ ThickLine
Thick line, no hooks.
@ BracketCurvedHooks
Thick bracket with curved hooks.
@ DeskBracket
Thin bracket with horizontal hook lines.
@ Unknown4
Possibly never used.
@ Unknown7
Possibly never used.
@ None
No bracket (the default)
@ Unknown5
Possibly never used.
@ 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:505
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:510
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:519
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:531
static MusxInstance< CustomStem > getForStem(const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
Gets the beam extension record for the specified stemSelection.
Definition Details.cpp:541
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. This is the highest-numbered string in the barre.
Definition Details.h:1102
int startString
Starting 1-based string number. This is the lowest-numbered string in the barre.
Definition Details.h:1101
static const xml::XmlElementArray< Barre > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
int fret
0-based fret number counting from the diagram's first fret, so 0 is the fret that Cell identifies as ...
Definition Details.h:1100
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:1108
bool showNum
Show fretboard number.
Definition Details.h:1110
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1117
std::vector< std::shared_ptr< Barre > > barres
Array of fretboard barres.
Definition Details.h:1115
static const xml::XmlElementArray< FretboardDiagram > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
int numFretCells
Number of fret cells (xml node <numFretCells>).
Definition Details.h:1111
Shape
Shape type for a fretboard cell.
Definition Details.h:1067
@ Closed
Closed dot (filled).
@ 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:1109
int numFretBarres
Number of fret barres (xml node <numFretBarres>).
Definition Details.h:1112
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:1107
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1134
std::vector< std::shared_ptr< Cell > > cells
Array of fretboard cells.
Definition Details.h:1114
Represents the attributes of a Finale frame holder.
Definition Details.h:1146
StaffCmper getStaff() const
returns the staffId (staff) number for this GFrameHold
Definition Details.h:1169
GFrameHold(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas)
Constructor function.
Definition Details.h:1156
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1196
std::optional< ClefIndex > clefId
clef index when there are no mid-measure clef changes. (xml tag is <clefID>).
Definition Details.h:1160
int clefPercent
Clef percent where 100 means 100%.
Definition Details.h:1165
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:574
ShowClefMode showClefMode
"Show Clef" mode. (xml tag is <clefMode>)
Definition Details.h:1162
bool mirrorFrame
Indicates this is a mirror frame. (Not used after Finale 14.5.)
Definition Details.h:1163
static const xml::XmlElementArray< GFrameHold > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
MeasCmper getMeasure() const
returns the measure number for this GFrameHold
Definition Details.h:1172
bool calcContainsMusic() const
Returns true if the GFrameHold contains any layer frames.
Definition Details.h:1181
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1207
bool calcIsMultiLayer() const
Returns true if the GFrameHold instance has more than one layer.
Definition Details.h:1175
bool clefAfterBarline
"Place Clef After Barline"
Definition Details.h:1164
Cmper clefListId
The clef list ID when there are mid-measure clef changes, if non-zero. (xml tag is <clefListID>).
Definition Details.h:1161
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:553
std::vector< Cmper > frames
others::Frame values for layers 1..4 (layer indices 0..3) if non-zero
Definition Details.h:1166
Represents independent time and key signature overrides for a staff.
Definition Details.h:1219
bool hasTime
If true, this item contains an independent time signature.
Definition Details.h:1250
MusxInstance< TimeSignature > createTimeSignature() const
Create a shared pointer to an instance of the TimeSignature for this instance.
Definition Details.cpp:593
Cmper divBeat
Time signature denominator in Edu or a Cmper to a composite record.
Definition Details.h:1240
bool displayAltDenTsig
If true, dispDivBeat is the Cmper of a others::TimeCompositeLower record.
Definition Details.h:1245
Cmper dispDivBeat
Display time signature denominator in Edu or a Cmper to a composite record.
Definition Details.h:1242
bool altNumTsig
If true, beats is the Cmper of a others::TimeCompositeUpper record.
Definition Details.h:1246
bool hasKey
If true, this item contains an independent key signature.
Definition Details.h:1236
std::shared_ptr< KeySignature > keySig
The key signature value if present. (xml tag is <keySig>/<key>)
Definition Details.h:1235
IndependentStaffDetails(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas)
Constructor function.
Definition Details.h:1229
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1259
bool altDenTsig
If true, divBeat is the Cmper of a others::TimeCompositeLower record.
Definition Details.h:1247
static const xml::XmlElementArray< IndependentStaffDetails > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool hasDispTime
If true, the display time signature is present.
Definition Details.h:1249
bool displayAbbrvTime
If true, the display time signature is abbreviated.
Definition Details.h:1248
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1267
Cmper dispBeats
Display time signature numerator or a Cmper to a composite record.
Definition Details.h:1241
bool displayAltNumTsig
If true, dispBeats is the Cmper of a others::TimeCompositeUpper record.
Definition Details.h:1244
MusxInstance< TimeSignature > createDisplayTimeSignature() const
Create a shared pointer to an instance of the display TimeSignature for this measure and staff.
Definition Details.cpp:598
Cmper beats
Time signature numerator or a Cmper to a composite record.
Definition Details.h:1239
Represents a single element in a Finale accidental symbol list.
Definition Details.h:1278
int getAlterationValue() const
Returns the alteration value that this symbol corresponds with.
Definition Details.h:1288
KeySymbolListElement(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition Details.h:1281
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:1301
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1292
std::string accidentalString
Definition Details.h:1284
Contains the syllable assignments for lyrics chorus blocks.
Definition Details.h:1364
MusxInstance< texts::LyricsTextBase > getLyricText() const override
Get the raw lyric text for this assignment.
Definition Details.cpp:616
LyricTextType getLyricTextType() const override
Get the lyric text type for this assignment.
Definition Details.cpp:631
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1373
Contains the syllable assignments for lyrics section blocks.
Definition Details.h:1383
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1392
LyricTextType getLyricTextType() const override
Get the lyric text type for this assignment.
Definition Details.cpp:636
MusxInstance< texts::LyricsTextBase > getLyricText() const override
Get the raw lyric text for this assignment.
Definition Details.cpp:621
Contains the syllable assignments for lyrics verse blocks.
Definition Details.h:1402
LyricTextType getLyricTextType() const override
Get the lyric text type for this assignment.
Definition Details.cpp:626
MusxInstance< texts::LyricsTextBase > getLyricText() const override
Get the raw lyric text for this assignment.
Definition Details.cpp:611
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1411
Contains assignment data for a lyric assignment (a single syllable)
Definition Details.h:1310
util::EnigmaParsingContext getRawTextCtx() const
Return an Enigma parsing context for the associated lyrics text block.
Definition Details.cpp:641
virtual LyricTextType getLyricTextType() const =0
Get the lyric text type for this assignment.
Evpu wext
Definition Details.h:1328
LyricAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:1320
static const xml::XmlElementArray< LyricAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
std::optional< std::string > calcDisplayNumberText() const
Calculate the verse/chorus/section number to display to the left of this assignment's syllable,...
Definition Details.cpp:672
Cmper lyricNumber
the text number of the lyric.
Definition Details.h:1323
unsigned syllable
the 1-based syllable number. Subtract 1 for an index into texts::LyricsTextBase::syllables....
Definition Details.h:1324
Evpu floatingHorzOff
This appears to have something to do with note spacing. It may simply be a cache that Finale changes ...
Definition Details.h:1327
Evpu horzOffset
horizontal offset from default position. (xml node is <horzOff>)
Definition Details.h:1325
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:1326
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:1331
EntryInfoPtr calcWordExtensionEndpoint() const
Calculate the entry to which an automatic word extension extends.
Definition Details.cpp:650
Specifies lyric alignment and justification for a single entry. This affects all lyric assignments on...
Definition Details.h:1422
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1439
std::optional< AlignJustify > align
Override default alignment if present. (xml node is <align>)
Definition Details.h:1436
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:1432
std::optional< AlignJustify > justify
Override default justification if present. (xml node is <justify>)
Definition Details.h:1435
Per-staff/per-measure overrides for the position and appearance of a measure number.
Definition Details.h:1450
ForceVisibility
Force-visibility options for the measure number at this location.
Definition Details.h:1471
@ 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:1483
Evpu xOffset
Horizontal offset for the measure number. (xml node is <x1add>)
Definition Details.h:1478
Evpu xOffset2
Horizontal offset for the measure number range under a multimeasure rest (Page View only)....
Definition Details.h:1480
MeasureNumberIndividualPositioning(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
Constructor.
Definition Details.h:1461
static const xml::XmlElementArray< MeasureNumberIndividualPositioning > & xmlMappingArray()
Required for musx::
ForceVisibility forceVisibility
Force-visibility behavior. (xml node is <forceHide>)
Definition Details.h:1481
Cmper measNumRegion
The Cmper of the others::MeasureNumberRegion that this override applies to. (xml node is <region>)
Definition Details.h:1477
std::shared_ptr< others::Enclosure > enclosure
Optional enclosure settings. (xml node is <encl>)
Definition Details.h:1484
bool isAlternateNumber
Whether this is an alternate number, such as a boxed number. (xml node is <isAltNum>)
Definition Details.h:1482
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1486
Evpu yOffset
Vertical offset for the measure number. (xml node is <y1add>)
Definition Details.h:1479
Represents a text block assignment for a staff and measure.
Definition Details.h:1506
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1535
util::EnigmaParsingContext getRawTextCtx(Cmper forPartId) const
Gets the raw text for this assignment, or nullptr if none.
Definition Details.cpp:705
Evpu yDisp
Vertical displacement in Evpu (xml node is <ydisp>)
Definition Details.h:1526
Evpu xDispEvpu
Negative horizontal displacement in Evpu, when xDispEdu is zero. (xml node is <xdispEvpu>)
Definition Details.h:1525
MusxInstance< others::TextBlock > getTextBlock() const
Gets the TextBlock for this assignment, or nullptr if none.
Definition Details.cpp:700
MeasureTextAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
Constructor.
Definition Details.h:1517
Cmper block
Text block ID.
Definition Details.h:1522
bool hidden
Indicates the text appears only on screen (xml node is <postIt/>)
Definition Details.h:1527
static const xml::XmlElementArray< MeasureTextAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Edu xDispEdu
Definition Details.h:1523
Represents graphical and notational alterations applied to a note.
Definition Details.h:1548
bool allowVertPos
Whether vertical positioning is allowed .
Definition Details.h:1562
int percent
Size percentage for the notehead. (A value of 100 means 100%.)
Definition Details.h:1557
char32_t altNhead
Alternate notehead character. Zero (the default) means no override is specified.
Definition Details.h:1559
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1569
NoteAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:1551
Evpu nydisp
Vertical notehead offset.
Definition Details.h:1563
std::shared_ptr< FontInfo > customFont
Custom font info (consolidates: <fontID>, <fontSize>, <efx>)
Definition Details.h:1561
bool useOwnFont
Whether to use the custom font.
Definition Details.h:1560
Evpu nxdisp
Horizontal notehead offset.
Definition Details.h:1558
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:1567
bool enharmonic
Definition Details.h:1564
NoteNumber noteId
The ID of the note being altered. (xml node is <noteID>)
Definition Details.h:1556
static const xml::XmlElementArray< NoteAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Represents a percussion note code override for a single note.
Definition Details.h:1582
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:1593
NoteNumber noteId
The ID of the note being assigned a code.
Definition Details.h:1590
PercussionNoteTypeId noteCode
The percussion note code. Use this to search the incis of the percussion map for the specific note.
Definition Details.h:1591
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:1585
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1595
Beam alteration for downstem secondary beams.
Definition Details.h:1606
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:1626
SecondaryBeamAlterationsDownStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor.
Definition Details.h:1617
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1629
Beam alteration for downstem secondary beams.
Definition Details.h:1639
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:1659
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1662
SecondaryBeamAlterationsUpStem(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor.
Definition Details.h:1650
Specifies which secondary beams break and restart on the associated entry.
Definition Details.h:1674
SecondaryBeamBreak(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor function.
Definition Details.h:1677
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:1720
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1705
BeamNumber calcLowestBreak() const
Calculates the lowest (largest note-value) beam specified for a secondary beam break.
Definition Details.h:1691
bool breakThrough
True if the beam should be broken through to the largest specified beam value.
Definition Details.h:1683
unsigned mask
Composite mask of beam breaks, derived from <do16th> through <do4096th> tags.
Definition Details.h:1682
static const xml::XmlElementArray< SecondaryBeamBreak > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Embedded shape record for a single index in noteShapes.
Definition Details.h:1746
char32_t quarter
Filled (quarter) notehead symbol (xml nodename is <q>).
Definition Details.h:1751
char32_t whole
Whole notehead symbol (xml nodename is <w>).
Definition Details.h:1749
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:1748
char32_t half
Half notehead symbol (xml nodename is <h>).
Definition Details.h:1750
Shape Note settings for staves and staffs style.
Definition Details.h:1734
ShapeNoteBase(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor function.
Definition Details.h:1738
std::vector< std::shared_ptr< NoteShapes > > noteShapes
Notehead shapes (only the first seven elements are used).
Definition Details.h:1756
bool arrangedByPitch
Definition Details.h:1757
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1760
static const xml::XmlElementArray< ShapeNoteBase > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Shape Note settings for staff styles.
Definition Details.h:1799
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1803
Shape Note settings for staves.
Definition Details.h:1784
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1788
Provides run-time information about Staff Groups within a system or list of others::StaffUsed.
Definition Details.h:1950
std::optional< size_t > startSlot
the 0-based start slot (index) of the group in the system staves.
Definition Details.h:1952
std::optional< size_t > endSlot
the 0-based end slot (index) of the group in the system staves.
Definition Details.h:1953
std::optional< size_t > numStaves() const
The number of staves in the group for the systemStaves.
Definition Details.h:1964
MusxInstanceList< others::StaffUsed > systemStaves
the system staves referred to by startSlot and endSlot
Definition Details.h:1955
MusxInstance< StaffGroup > group
the StaffGroup record for the group.
Definition Details.h:1954
bool calcIsSingleInstrumentSection(MeasCmper measureId) const
Returns true if this staff group spans multiple staves with the same exact instrument UUID,...
Definition Details.cpp:842
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:822
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:905
Represents the attributes of a Finale staff group that brackets staves.
Definition Details.h:1812
AlignJustify abbrvNameJustify
Abbreviated name justification (xml node is <abbrvJustify>)
Definition Details.h:1861
bool abbrvNameExpand
"Expand Single Word" for abbreviated name (xml node is <abbrvExpand>)
Definition Details.h:1873
Cmper multiStaffGroupId
Definition Details.h:1876
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:1872
bool ownBarline
"Use Alternate Group Barline"
Definition Details.h:1863
int abbrvNameYadj
Vertical adjustment for abbreviated name (xml node is <abbrvYadj>)
Definition Details.h:1869
DrawBarlineStyle
Enum for how to draw group barlines.
Definition Details.h:1833
@ 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:790
bool isAllMeasures() const
Returns true if this group spans all measures.
Definition Details.h:1921
Cmper abbrvNameId
Abbreviated name TextBlock cmper (xml node is <abbrvID>)
Definition Details.h:1867
StaffCmper startInst
Starting staff ID.
Definition Details.h:1851
int fullNameXadj
Horizontal adjustment for full name (xml node is <fullXadj>)
Definition Details.h:1856
std::shared_ptr< Bracket > bracket
Bracket Options. The factory guarantees this value to exist.
Definition Details.h:1858
util::EnigmaParsingContext getAbbreviatedNameCtx() const
Get the raw text context for the abbreviated staff group name.
Definition Details.cpp:735
std::string getAbbreviatedName(util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
Get the abbreviated staff group name without Enigma tags.
Definition Details.cpp:743
AlignJustify fullNameJustify
Full name justification (xml node is <fullJustify>)
Definition Details.h:1860
DrawBarlineStyle drawBarlines
"Draw Barlines" option (xml node is <groupBarlineStyle>)
Definition Details.h:1862
void integrityCheck(const std::shared_ptr< EnigmaBase > &ptrToThis) override
Performs a final consistency check after population.
Definition Details.h:1924
AlignJustify abbrvNameAlign
Abbreviated name horizontal alignment (xml node is <abbrvHAlign>)
Definition Details.h:1871
util::EnigmaParsingContext getAbbreviatedInstrumentNameCtx() const
Returns the raw text context for the abbreviated instrument name for this group, with autonumbering c...
Definition Details.cpp:780
util::EnigmaParsingContext getFullNameCtx() const
Get the raw text context for the full staff group name.
Definition Details.cpp:719
std::unordered_set< StaffCmper > staves
Calculated list of staves in the group.
Definition Details.h:1881
int fullNameYadj
Vertical adjustment for full name (xml node is <fullYadj>)
Definition Details.h:1857
HideStaves hideStaves
"When Hiding Empty Staves" option (xml node is <optimize>)
Definition Details.h:1874
BarlineType barlineType
Group barline type (xml node is <barline>)
Definition Details.h:1859
AlignJustify fullNameAlign
Full name horizontal alignment (xml node is <fullHAlign>)
Definition Details.h:1870
Cmper fullNameId
Full name TextBlock cmper (xml node is <fullID>)
Definition Details.h:1855
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:772
StaffCmper endInst
Ending staff ID.
Definition Details.h:1852
static constexpr std::string_view XmlNodeName
XML node name for this type.
Definition Details.h:1941
MeasCmper startMeas
Starting measure number.
Definition Details.h:1853
std::string getFullName(util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const
Get the full staff group name without Enigma tags.
Definition Details.cpp:727
MusxInstance< others::MultiStaffInstrumentGroup > getMultiStaffInstGroup() const
Returns the others::MultiStaffInstrumentGroup for this group if it is part of one....
Definition Details.cpp:751
MeasCmper endMeas
Ending measure number.
Definition Details.h:1854
StaffGroup(const DocumentWeakPtr &document, Cmper partId, EnigmaBase::ShareMode shareMode, Cmper cmper1, Cmper cmper2)
Constructor.
Definition Details.h:1822
bool hideName
Inverse of "Show Group Name".
Definition Details.h:1866
bool fullNameIndivPos
Indicates if full name has individual position (xml node is <fullIndivPos>)
Definition Details.h:1864
util::EnigmaParsingContext getFullInstrumentNameCtx() const
Returns the raw text context for the full instrument name for this group, with autonumbering context ...
Definition Details.cpp:762
bool abbrvNameIndivPos
Indicates if abbreviated name has individual position (xml node is <abbrvIndivPos>)
Definition Details.h:1865
int abbrvNameXadj
Horizontal adjustment for abbreviated name (xml node is <abbrvXadj>)
Definition Details.h:1868
HideStaves
Enum for optimization options.
Definition Details.h:1844
@ 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:2000
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2021
static const xml::XmlElementArray< StaffSize > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
util::Fraction calcStaffScaling() const
Calculate the staff scaling.
Definition Details.h:2018
StaffSize(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper system, Cmper staffId)
Constructor.
Definition Details.h:2010
int staffPercent
The staff size percentage override. (A value of 100 means 100%, i.e, no staff scaling....
Definition Details.h:2015
Specifies horizontal and vertical adjustments for stems under beam.
Definition Details.h:2060
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2064
Specifies horizontal and vertical stem adjustments for upstem and downstem contexts.
Definition Details.h:2034
Evpu upVertAdjust
Vertical adjustment for upstem context (positive is up).
Definition Details.h:2042
Evpu downHorzAdjust
Horizontal adjustment for downstem context (positive is right).
Definition Details.h:2045
Evpu downVertAdjust
Vertical adjustment for downstem context (positive is up).
Definition Details.h:2043
static const xml::XmlElementArray< StemAlterations > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu upHorzAdjust
Horizontal adjustment for upstem context (positive is right).
Definition Details.h:2044
StemAlterations(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
Constructor function.
Definition Details.h:2037
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2047
Specifies the TAB string a note appears on. Finale automatically figures out the fret number from the...
Definition Details.h:2077
TablatureNoteMods(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:2080
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:2089
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:2091
NoteNumber noteId
The ID of the tablature note being modified. (xml node is <noteID>)
Definition Details.h:2085
int stringNumber
Definition Details.h:2086
Base class for tie alteration properties. (Used for both ties and tie ends.)
Definition Details.h:2100
DirectionContext
Indicates the placement context of end- and control-point adjustments.
Definition Details.h:2146
@ 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:2156
NoteNumber noteId
Note ID associated with the tie alteration. (xml node is <noteID>)
Definition Details.h:2152
bool outerOn
Enable "Outer" placement.
Definition Details.h:2158
bool outerLocal
Local setting for "Outer Tie".
Definition Details.h:2157
Evpu xStart
Horizontal start position of the tie.
Definition Details.h:2153
DirectionContext enPtContext
End point must match this direction context for xEnd & yEnd to apply.
Definition Details.h:2179
Evpu height1
Height of the first control point.
Definition Details.h:2181
NoteNumber getNoteId() const override
Required virtual function that returns the note id.
Definition Details.h:2188
bool afterMultiDotsLocal
Local setting for "After Multiple Dots".
Definition Details.h:2161
bool shiftForSecondsOn
Enable "Shift for Seconds".
Definition Details.h:2164
Evpu height2
Height of the second control point.
Definition Details.h:2183
ConnectionType stPtEntCnct
Start point must match this connection type for xStart & yStart to apply.
Definition Details.h:2175
ConnectionType
Defines tie connection points for start and end attachment locations.
Definition Details.h:2121
@ NoteLeftNoteTop
Left of note, top of note.
@ 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 ¬eInfoPtr, bool forTieEnd=false)
Gets the the TieAlterStart or TieAlterEnd for this note, based on the input boolean.
Definition Details.cpp:931
Evpu insetRatio1
Inset ratio for the first control point.
Definition Details.h:2180
bool enPtAdjOn
Enable end point adjustment.
Definition Details.h:2177
ConnectionType enPtEntCnct
End point must match this connection type for xEnd & yEnd to apply.
Definition Details.h:2178
bool shiftForSecondsLocal
Local setting for "Shift for Seconds".
Definition Details.h:2163
bool afterSingleDotOn
Enable "After Single Dot".
Definition Details.h:2160
bool afterMultiDotsOn
Enable "After Multiple Dots".
Definition Details.h:2162
Evpu insetRatio2
Inset ratio for the second control point.
Definition Details.h:2182
bool breakKeyLocal
Local setting for "Break at Key Signature".
Definition Details.h:2170
bool ctlPtFixed
Definition Details.h:2185
TieAlterBase(const DocumentWeakPtr &document, Cmper partId, EnigmaBase::ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:2103
bool breakKeyOn
Enable "Break at Key Signature".
Definition Details.h:2171
bool down
Downward tie. Only applicable if freezeDirection is true. (False freezes the tie up....
Definition Details.h:2167
DirectionContext stPtContext
Start point must match this direction context for xStart & yStart to apply.
Definition Details.h:2176
bool beforeSingleAcciOn
Enable "Before Single Accidental".
Definition Details.h:2166
bool noSpecialArc
Inverse of "Avoid Staff Lines". (See options::TieOptions for more information about the naming....
Definition Details.h:2173
bool stPtAdjOn
Enable start point adjustment.
Definition Details.h:2174
static const xml::XmlElementArray< TieAlterBase > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool beforeSingleAcciLocal
Local setting for "Before Single Accidental".
Definition Details.h:2165
Evpu xEnd
Horizontal end position of the tie.
Definition Details.h:2154
bool ctlPtAdjOn
Enable control point adjustment.
Definition Details.h:2184
bool breakTimeLocal
Local setting for "Break at Time Signature".
Definition Details.h:2168
bool freezeDirection
Freeze tie direction. (xml node is <freeze>)
Definition Details.h:2172
Evpu yStart
Vertical start position of the tie.
Definition Details.h:2155
bool afterSingleDotLocal
Local setting for "After Single Dot".
Definition Details.h:2159
bool breakTimeOn
Enable "Break at Time Signature".
Definition Details.h:2169
Alterations for tie ends.
Definition Details.h:2202
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2206
static const xml::XmlElementArray< TieAlterEnd > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Alterations for tie starts. (Tie starts are normal ties.)
Definition Details.h:2219
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2223
static const xml::XmlElementArray< TieAlterStart > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Options controlling the appearance of tuplets.
Definition Details.h:2236
bool hidden
Inverse of "Show".
Definition Details.h:2262
util::Fraction calcRatio() const
return the tuplet ratio (reference / display)
Definition Details.h:2289
util::Fraction calcDisplayDuration() const
return the display duration as a util::Fraction of a whole note
Definition Details.h:2286
Evpu tupOffX
Horizontal offset.
Definition Details.h:2263
Evpu rightHookLen
Length of the right hook in the tuplet bracket. (This value is sign-reversed in the Finale UI....
Definition Details.h:2278
Evpu brackOffY
Vertical offset for brackets.
Definition Details.h:2266
BracketStyle brackStyle
Bracket style.
Definition Details.h:2274
bool avoidStaff
"Avoid Staff"
Definition Details.h:2260
AutoBracketStyle autoBracketStyle
Autobracket style.
Definition Details.h:2261
bool alwaysFlat
"Always Flat" (xml node is <flat>)
Definition Details.h:2257
bool fullDura
"Bracket Full Duration"
Definition Details.h:2258
bool allowHorz
"Allow Horizontal Drag"
Definition Details.h:2269
int referenceNumber
The number of notes "in the time of" (xml node is <refNum>)
Definition Details.h:2255
Evpu rightHookExt
Extension of the right hook beyond the tuplet bracket.
Definition Details.h:2279
Evpu leftHookExt
Extension of the left hook beyond the tuplet bracket.
Definition Details.h:2277
bool ignoreHorzNumOffset
"Ignore Horizontal Number Offset" (xml node is <ignoreGlOffs>)
Definition Details.h:2270
TupletDef(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition Details.h:2239
util::Fraction calcReferenceDuration() const
return the reference duration as a util::Fraction of a whole note
Definition Details.h:2283
bool smartTuplet
"Engraver Tuplets"
Definition Details.h:2275
Edu displayDuration
The duration of each note to display (xml node is <symbolicDur>)
Definition Details.h:2254
Evpu tupOffY
Vertical.
Definition Details.h:2264
NumberStyle numStyle
Number style.
Definition Details.h:2267
static const xml::XmlElementArray< TupletDef > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu brackOffX
Horizontal offset for brackets.
Definition Details.h:2265
Evpu manualSlopeAdj
"Manual Slope Adjustment" in Evpu. (xml node is <slope>)
Definition Details.h:2280
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition Details.h:2291
bool breakBracket
"Break Slur or Bracket"
Definition Details.h:2271
int displayNumber
The number of notes to display (xml node is <symbolicNum>)
Definition Details.h:2253
bool metricCenter
"Center Number Using Duration"
Definition Details.h:2259
bool useBottomNote
"Use Bottom Note" (xml node is <noteBelow>)
Definition Details.h:2273
bool matchHooks
"Match Length of Hooks"
Definition Details.h:2272
PositioningStyle posStyle
Positioning style.
Definition Details.h:2268
Edu referenceDuration
The duration of each note "in the time of" (xml node is <refDur>)
Definition Details.h:2256
Evpu leftHookLen
Length of the left hook in the tuplet bracket. (This value is sign-reversed in the Finale UI....
Definition Details.h:2276
FlattenStyle
Beaming style choices for when to flatten beams.
Definition Options.h:175
BracketStyle
Bracket style options.
Definition Options.h:1827
PositioningStyle
Positioning style options.
Definition Options.h:1814
AutoBracketStyle
Auto-bracket style options.
Definition Options.h:1786
NumberStyle
Number style options.
Definition Options.h:1801
BarlineType
Barline type for left and right barlines.
Definition Others.h:1175
Contains chorus text for lyrics.
Definition Texts.h:164
Contains section text for lyrics.
Definition Texts.h:177
Contains verse text for lyrics.
Definition Texts.h:151
Wrapper class for interpreting and rendering Enigma-style strings with insert handling.
Definition EnigmaString.h:501
AccidentalStyle
Enumeration to specify the type of accidental substitution representation.
Definition EnigmaString.h:253
@ 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
@ Info
Informational messages for general program operation.
@ 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:46
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:182
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:220
@ 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:133
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