28#include "musx/util/Fraction.h"
29#include "BaseClasses.h"
184 std::vector<unsigned> calcTonalCenterArrayForSharps()
const;
185 std::vector<unsigned> calcTonalCenterArrayForFlats()
const;
186 std::vector<unsigned> calcTonalCenterArray()
const;
187 std::vector<int> calcAcciAmountsArray()
const;
188 std::vector<unsigned> calcAcciOrderArray()
const;
190 int m_octaveDisplacement{};
191 int m_alterationOffset{};
269 {
return m_octaveDisplacement; }
279 std::optional<std::vector<int>>
calcKeyMap()
const;
285 std::unique_ptr<music_theory::Transposer>
createTransposer(
int displacement,
int alteration)
const;
291 MUSX_INTEGRITY_ERROR(
"Key signature has invalid key value: " + std::to_string(
key));
363 {
return std::accumulate(
units.begin(),
units.end(),
Edu{}); }
379 { return acc + (comp.sumCounts() * comp.sumUnits()); }
381 return result /
Edu(NoteType::Whole);
411 void checkIndex(
size_t index)
const
414 throw std::invalid_argument(
"Index out of range. The time signature has " + std::to_string(
components.size())
415 +
" elements. The index requested was " + std::to_string(index) +
".");
423 explicit TimeSignature(
const DocumentWeakPtr& document,
int beats,
Edu unit,
bool hasCompositeTop,
bool hasCompositeBottom,
424 std::optional<bool> abbreviate = std::nullopt);
430 explicit TimeSignature(
const DocumentWeakPtr& document,
const TimeSigComponent& timeSigUnit, std::optional<bool> abbreviate)
431 : CommonClassBase(document), m_abbreviate(abbreviate)
436 std::optional<bool> m_abbreviate;
438 friend class others::Measure;
439 friend class details::IndependentStaffDetails;
478 :
OthersBase(document, partId, shareMode, cmper) {}
515 Cmper cmper = 0, std::optional<Inci> inci = std::nullopt)
516 :
OthersBase(document, partId, shareMode, cmper, inci)
540 std::optional<std::pair<MeasCmper, Edu>>
nextLocation(
const std::optional<InstCmper>& forStaff = std::nullopt)
const;
564 :
OthersBase(document, partId, shareMode, cmper) {}
DocumentPtr getDocument() const
Gets a reference to the Document.
Definition BaseClasses.h:85
virtual void integrityCheck()
Allows a class to determine if it has been properly contructed by the factory and fix issues that it ...
Definition BaseClasses.h:132
ShareMode
Describes how this instance is shared between part and score.
Definition BaseClasses.h:68
Base class for classes that are commonly used among others, details, entries, and/or texts....
Definition BaseClasses.h:178
CommonClassBase(const DocumentWeakPtr &document)
Constructs a CommonClassBase object.
Definition BaseClasses.h:185
Represents the default font settings for a particular element type.
Definition CommonClasses.h:110
bool calcIsSymbolFont() const
Calculates if this is a symbol font. (See others::FontDefinition::calcIsSymbolFont....
Definition Implementations.cpp:1023
bool strikeout
Strikeout effect.
Definition CommonClasses.h:117
void setFontIdByName(const std::string &name)
Sets the id of the font from a string name.
Definition Implementations.cpp:995
Cmper fontId
Font identifier. This is a Cmper for others::FontDefinition.
Definition CommonClasses.h:112
static std::vector< std::filesystem::path > calcSMuFLPaths()
Returns the standard SMuFL font folder.
Definition Implementations.cpp:1031
bool calcIsSMuFL() const
Calculates whether this is a SMuFL font.
Definition CommonClasses.h:165
std::string getName() const
Get the name of the font.
Definition Implementations.cpp:987
static const xml::XmlElementArray< FontInfo > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
void setEnigmaStyles(uint16_t efx)
Set style effects based on a bitmask. This is mainly useful for capturing text styles from enigma str...
Definition CommonClasses.h:142
bool italic
Italic effect.
Definition CommonClasses.h:115
bool hidden
Hidden effect.
Definition CommonClasses.h:119
bool calcIsDefaultMusic() const
Calculates if this is the default music font.
Definition CommonClasses.h:153
int fontSize
Font size.
Definition CommonClasses.h:113
bool underline
Underline effect.
Definition CommonClasses.h:116
bool absolute
Fixed size effect.
Definition CommonClasses.h:118
std::optional< std::filesystem::path > calcSMuFLMetaDataPath() const
Returns the filepath of the SMuFL font's metadata json file, if any.
Definition Implementations.cpp:1007
bool bold
Bold effect.
Definition CommonClasses.h:114
Shared key signature class that is contained in other classes. (See others::Measure)
Definition CommonClasses.h:182
Cmper getKeyMode() const
Returns the key mode.
Definition CommonClasses.h:220
bool hideKeySigShowAccis
Instead of a key signature, show accidentals for the key on the notes where they occur.
Definition CommonClasses.h:204
int getAlteration() const
For linear keys, returns the number of sharps or flats from -7..7.
Definition CommonClasses.h:224
bool isLinear() const
whether this is a linear key
Definition CommonClasses.h:226
int calcEDODivisions() const
Calculates the number of EDO division for the key. (The standard value is 12.)
Definition Implementations.cpp:1657
bool isBuiltIn() const
whether this is a built-in key
Definition CommonClasses.h:228
int calcAlterationOnNote(unsigned noteIndex) const
Calculates the amount of alteration on a note int the key.
Definition Implementations.cpp:1560
uint16_t key
16-bit value intepreted as follows:
Definition CommonClasses.h:202
std::unique_ptr< music_theory::Transposer > createTransposer(int displacement, int alteration) const
Creates a transposer for this KeySignature instance.
Definition Implementations.cpp:1665
std::optional< music_theory::DiatonicMode > calcDiatonicMode() const
If this key specifies a diatonic mode, returns the mode. This value is independent of EDO divisions....
Definition Implementations.cpp:1670
void setTransposition(int interval, int keyAdjustment, bool simplify)
Transposes the key by the specified amounts. Set them to zero to remove transposition.
Definition Implementations.cpp:1592
bool isMinor() const
whether this is a built-in minor key
Definition CommonClasses.h:230
int getOctaveDisplacement() const
The octave displacement if this key is a transposed key.
Definition CommonClasses.h:268
void integrityCheck() override
Allows a class to determine if it has been properly contructed by the factory and fix issues that it ...
Definition CommonClasses.h:287
bool isSame(const KeySignature &src)
returns whether the two key signatures represent the same key signature. Does not take into account t...
Definition CommonClasses.h:238
bool isNonLinear() const
whether this is a non-linear key
Definition CommonClasses.h:227
static const xml::XmlElementArray< KeySignature > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool isMajor() const
whether this is a built-in major key
Definition CommonClasses.h:229
std::optional< std::vector< int > > calcKeyMap() const
Calculates the key's diatonic key map.
Definition Implementations.cpp:1619
int calcTonalCenterIndex() const
Calculates the tonal center index for the key, where C=0, D=1, E=2, ...
Definition Implementations.cpp:1549
bool keyless
Indicates the absence of a key signature.
Definition CommonClasses.h:203
Contains the syllable information for a single syllable. (See texts::LyricsTextBase)
Definition CommonClasses.h:307
bool hasHyphenAfter
indicates the syllable if followed by a hyphen.
Definition CommonClasses.h:312
std::string syllable
the syllable text with no hyphenation or font information.
Definition CommonClasses.h:310
bool hasHyphenBefore
indicates the syllable is preceded by a hyphen.
Definition CommonClasses.h:311
Base class for all "others" types.
Definition BaseClasses.h:223
Shared time signature class that is derived from other classes. (See others::Measure)
Definition CommonClasses.h:341
bool isCutTime() const
Returns if this time signature is cut time.
Definition Implementations.cpp:3410
std::vector< TimeSigComponent > components
the components in the time signature
Definition CommonClasses.h:366
bool isSame(const TimeSignature &src)
returns whether the two time signatures represent the same time signature
Definition CommonClasses.h:385
util::Fraction calcTotalDuration() const
Calculates the total duration of the time signature as a fraction of a whole note.
Definition CommonClasses.h:375
std::optional< char32_t > getAbbreviatedSymbol() const
Returns the abbreviated symbol (code point) for this time signature, or std::nullopt if none.
Definition Implementations.cpp:3379
bool isCommonTime() const
Returns if this time signature is common time.
Definition Implementations.cpp:3402
std::pair< util::Fraction, NoteType > calcSimplified() const
Calculates the simplest form of of this time signature, expressed as a fractional count of NoteType u...
Definition Implementations.cpp:3418
std::shared_ptr< TimeSignature > createComponent(size_t index) const
Creates a time signature corresponding to the component at index.
Definition CommonClasses.h:393
Represents independent time and key signature overrides for a staff.
Definition Details.h:733
Represents the enclosure settings for text expressions.
Definition CommonClasses.h:451
bool notTall
"Enforce Minimum Width": don't let shape get taller than it is wide
Definition CommonClasses.h:489
Evpu yAdd
Center Y offset - offsets text from center (in EVPU).
Definition CommonClasses.h:481
Enclosure(const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All, Cmper cmper=0)
Constructs an Enclosure object.
Definition CommonClasses.h:477
bool roundCorners
Whether the enclosure has rounded corners.
Definition CommonClasses.h:491
Efix lineWidth
Line thickness in 64ths of an EVPU (EFIX).
Definition CommonClasses.h:484
static const xml::XmlElementArray< Enclosure > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool opaque
Whether the enclosure is opaque.
Definition CommonClasses.h:490
Shape
Enumeration for enclosure shapes.
Definition CommonClasses.h:458
@ NoEnclosure
No enclosure.
Evpu yMargin
Half height - extra space on top/bottom sides (in EVPU).
Definition CommonClasses.h:483
Shape shape
Enclosure shape (default: NoEnclosure).
Definition CommonClasses.h:485
bool fixedSize
Whether the enclosure is fixed size (ignore text bounding box)
Definition CommonClasses.h:487
bool equalAspect
"Match Height and Width"
Definition CommonClasses.h:488
Efix cornerRadius
Corner radius (in EFIX).
Definition CommonClasses.h:486
Evpu xMargin
Half width - extra space on left/right sides (in EVPU).
Definition CommonClasses.h:482
Evpu xAdd
Center X offset - offsets text from center (in EVPU).
Definition CommonClasses.h:480
Represents the attributes of a measure.
Definition Others.h:931
Represents a range of music using measure and EDUs.
Definition CommonClasses.h:504
Edu startEdu
Starting EDU (Elapsed Durational Unit) in the range.
Definition CommonClasses.h:521
MeasCmper endMeas
Ending measure in the range.
Definition CommonClasses.h:522
static const xml::XmlElementArray< MusicRange > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
std::optional< std::pair< MeasCmper, Edu > > nextLocation(const std::optional< InstCmper > &forStaff=std::nullopt) const
Returns the next metric location following the music range.
Definition Implementations.cpp:1905
Edu endEdu
Ending EDU (Elapsed Durational Unit) in the range.
Definition CommonClasses.h:523
MusicRange(const DocumentWeakPtr &document, Cmper partId=SCORE_PARTID, ShareMode shareMode=ShareMode::All, Cmper cmper=0, std::optional< Inci > inci=std::nullopt)
Constructs a MusicRange object.
Definition CommonClasses.h:514
MeasCmper startMeas
Starting measure in the range.
Definition CommonClasses.h:520
bool contains(MeasCmper measId, Edu eduPosition) const
Returns true of the given metric location is contained in this MusicRange instance.
Definition CommonClasses.h:528
Contains horizontal and vertical offsets, alignment, and expansion settings for name positioning.
Definition CommonClasses.h:553
bool indivPos
Indicates that this positioning overrides the default positioning. (Not used by options::StaffOptions...
Definition CommonClasses.h:577
NamePositioning(const DocumentWeakPtr &document, Cmper partId=SCORE_PARTID, ShareMode shareMode=ShareMode::All, Cmper cmper=0)
Constructs an NamePositioning object.
Definition CommonClasses.h:563
bool expand
"Expand Single Word"
Definition CommonClasses.h:579
AlignJustify
Alignment and justification options for staff and group names.
Definition CommonClasses.h:568
@ Center
Center alignment.
@ Left
Left alignment or justification (the default value.)
Evpu horzOff
Horizontal distance from staff in Evpu.
Definition CommonClasses.h:574
AlignJustify hAlign
Horizontal alignment for the name text. (xml node is <halign>)
Definition CommonClasses.h:578
AlignJustify justify
Justification for the name text.
Definition CommonClasses.h:576
Evpu vertOff
Vertical offset from staff in Evpu.
Definition CommonClasses.h:575
static const xml::XmlElementArray< NamePositioning > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Base class for lyrics text.
Definition Texts.h:118
A class to represent fractions with integer m_numerator and m_denominator, automatically reduced to s...
Definition Fraction.h:37
A dependency-free, header-only collection of useful functions for music theory.
DiatonicMode
Represents the seven standard diatonic musical modes.
Definition music_theory.hpp:49
ShowClefMode
Enum representing the clef display mode for a frame.
Definition CommonClasses.h:96
@ WhenNeeded
Clef is displayed only when needed (the default).
@ Always
Clef is always displayed. (xml value is "forced")
@ Never
Clef is never displayed. (xml value is "hidden")
NoteType
Enum class representing note types based on EDU values.
Definition CommonClasses.h:47
int16_t MeasCmper
Enigma meas Cmper (may be negative when not applicable)
Definition Fundamentals.h:64
int32_t Efix
EFIX value (64 per EVPU, 64*288=18432 per inch)
Definition Fundamentals.h:60
constexpr Cmper SCORE_PARTID
The part id of the score.
Definition Fundamentals.h:80
int32_t Evpu
EVPU value (288 per inch)
Definition Fundamentals.h:57
uint16_t Cmper
Enigma "comperator" key type.
Definition Fundamentals.h:55
DefaultClefType
Clef types used by default in Finale documents. The values correspond to indices into musx::dom::opti...
Definition CommonClasses.h:71
@ Bass8vb
F clef, sounds one octave lower (8vb).
@ Alto
C clef, centered on third line (Alto clef).
@ BaritoneC
C clef on fifth line (Baritone clef).
@ Tab1
Tablature clef (5 lines).
@ Treble
G clef, standard treble.
@ FrenchViolin
G clef placed on first line (French violin clef).
@ Treble8va
G clef, sounds one octave higher (8va).
@ Bass8va
F clef, sounds one octave higher (8va).
@ AltPercussion
Alternate percussion clef, heavy vertical hash marks (no pitch).
@ Soprano
C clef on first line (Soprano clef).
@ Bass
F clef, standard bass.
@ Percussion
Percussion clef, open rectangle (no pitch).
@ Baritone
F clef on third line (Baritone clef).
@ Tab2
Tablature clef (5 lines, alternative style).
@ Treble8vb
G clef, sounds one octave lower (8vb).
@ Blank
Blank clef (invisible, no symbol).
@ MezzoSoprano
C clef on second line (Mezzo-soprano clef).
@ Tenor
C clef, centered on fourth line (Tenor clef).
uint16_t ClefIndex
Index into options::ClefOptions::clefDefs.
Definition Fundamentals.h:67
int32_t Edu
"Enigma Durational Units" value (1024 per quarter note)
Definition Fundamentals.h:61
std::weak_ptr< Document > DocumentWeakPtr
Shared weak Document pointer.
Definition BaseClasses.h:53
std::vector< XmlElementDescriptor< T > > XmlElementArray
an array type for XmlElementDescriptor instances.
Definition XmlInterface.h:127
object model for musx file (enigmaxml)
Definition BaseClasses.h:32
A single time signature component.
Definition CommonClasses.h:346
std::vector< util::Fraction > counts
Definition CommonClasses.h:347
std::vector< Edu > units
Definition CommonClasses.h:349
util::Fraction sumCounts() const
Compute the sum of all counts.
Definition CommonClasses.h:358
Edu sumUnits() const
Compute the sum of all units.
Definition CommonClasses.h:362
bool operator==(const TimeSigComponent &src) const
Test if two TimeSigComponent values are the same.
Definition CommonClasses.h:354