MUSX Document Model
|
Represents a Finale staff style. More...
#include <Others.h>
Classes | |
class | Masks |
lists the masks that deterimine if this staff style overrides the staff settings More... | |
Public Member Functions | |
StaffStyle (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
Constructor function. | |
bool | requireAllFields () const override |
Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class. | |
void | integrityCheck () override |
Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes. | |
![]() | |
Staff (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) | |
Constructor function. | |
std::string | getFullName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const |
Returns the full staff name without Enigma tags. | |
std::string | getAbbreviatedName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii) const |
Returns the abbreviated staff name without Enigma tags. | |
std::shared_ptr< MultiStaffInstrumentGroup > | getMultiStaffInstGroup () const |
Returns the MultiStaffInstrumentGroup for this staff if it is part of one in the data. Otherwise nullptr. | |
std::shared_ptr< MultiStaffInstrumentGroup > | getMultiStaffInstVisualGroup () const |
Returns the MultiStaffInstrumentGroup for this staff if it is shown as part of one. Otherwise nullptr. | |
std::string | getFullInstrumentName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii, bool preferStaffName=false) const |
Returns the full instrument name for this staff without Enigma tags and with autonumbering (if any) | |
std::string | getAbbreviatedInstrumentName (util::EnigmaString::AccidentalStyle accidentalStyle=util::EnigmaString::AccidentalStyle::Ascii, bool preferStaffName=false) const |
Returns the abbreviated instrument name for this staff without Enigma tags and with autonumbering (if any) | |
std::shared_ptr< const NamePositioning > | getFullNamePosition () const |
Returns the full name positioning in effect for this staff instance. | |
std::shared_ptr< const NamePositioning > | getAbbreviatedNamePosition () const |
Returns the abbreviated name positioning in effect for this staff instance. | |
bool | showNamesForPart (Cmper partId) const |
Returns if names should be shown for the specified part. | |
std::string | addAutoNumbering (const std::string &plainName) const |
Add auto numbering as a prefix or suffix, if needed. | |
ClefIndex | calcClefIndexAt (MeasCmper measureId, Edu position, bool forWrittenPitch=false) const |
Returns the clef in this staff at the specified location. | |
ClefIndex | calcFirstClefIndex (bool forWrittenPitch=false) const |
Returns the first clef in this staff. | |
int | calcMiddleStaffPosition () const |
Returns the middle staff position. For staves with even numbers of lines, it is the middle space. | |
int | calcToplinePosition () const |
Returns the position of the top staff line, relative to the reference line. | |
bool | hasInstrumentAssigned () const |
Return true if this staff has an instrument assigned. | |
std::vector< std::shared_ptr< PartDefinition > > | getContainingParts (bool includeScore=true) const |
Gets a list of all parts that contain this staff. | |
std::shared_ptr< PartDefinition > | firstFirstContainingPart () const |
Finds the first part that contains this staff, not including the score. | |
![]() | |
Cmper | getCmper () const |
Gets the cmper key value. | |
std::optional< Inci > | getInci () const |
Gets the optional array index (inci ). | |
![]() | |
virtual | ~Base () noexcept(false)=default |
Virtual destructor for polymorphic behavior. | |
DocumentPtr | getDocument () const |
Gets a reference to the Document. | |
virtual Cmper | getPartId () const |
Gets the partId for this instance (or SCORE_PARTID for score) | |
ShareMode | getShareMode () const |
Gets the sharing mode for this instance. | |
const SharedNodes & | getUnlinkedNodes () const |
Gets the unlinked nodes for this instance. (Only populated for ShareMode::Partial ) | |
void | addUnlinkedNode (const std::string &nodeName) |
Adds a shared node for this instance. | |
Static Public Member Functions | |
static std::vector< std::shared_ptr< StaffStyle > > | findAllOverlappingStyles (const DocumentPtr &document, Cmper partId, InstCmper staffId, MeasCmper measId, Edu eduPosition) |
Finds a subset from all StaffStyle instances that overlap with the specified metric position on a given staff in a give linked part or score. | |
static const xml::XmlElementArray< StaffStyle > & | xmlMappingArray () |
Required for musx::factory::FieldPopulator. | |
![]() | |
static void | calcAllAutoNumberValues (const DocumentPtr &document) |
Get the auto-numbering value for this staff, if applicable. | |
template<typename SubType > | |
static void | calcAllRuntimeValues (const DocumentPtr &document) |
Populate runtime values for all staves or staffstyles, such as percussion map Id if any. | |
static ClefIndex | calcFirstClefIndex (const DocumentPtr &document, Cmper partId, InstCmper staffCmper) |
Returns the first clef in the specified staff in the document. | |
static const xml::XmlElementArray< Staff > & | xmlMappingArray () |
Required for musx::factory::FieldPopulator. | |
Public Attributes | |
std::string | styleName |
name of staff style | |
bool | addToMenu |
add this staff style to the context menu for staff styles | |
std::shared_ptr< Masks > | masks |
![]() | |
NotationStyle | notationStyle {} |
Standard, percussion, or tablature. | |
std::shared_ptr< FontInfo > | noteFont |
The custom font to use for noteheads. Guaranteed non-null by integrityCheck if useNoteFont is true . | |
bool | useNoteFont {} |
Indicates if noteFont should be used. | |
ClefIndex | defaultClef {} |
Index of default clef for the staff. | |
ClefIndex | transposedClef {} |
Index of transposed clef for the staff. Only used if Transposition::setToClef is true. | |
std::optional< int > | staffLines {} |
Number of lines in the staff (if no custom staff) | |
std::optional< std::vector< int > > | customStaff |
A list of stafflines from 0..26 where a standard 5-line staff is values 11, 12, 13, 14, 15. | |
Evpu | lineSpace {} |
Distance between staff lines. | |
std::string | instUuid |
Unique identifier for the type of instrument. | |
bool | floatKeys {} |
"Independent Key Signature" | |
bool | floatTime {} |
"Independent Time Signature" | |
bool | blineBreak {} |
"Break Barlines Between Staves" | |
bool | rbarBreak {} |
"Break Repeat Barlines Between Staves" | |
bool | hasStyles {} |
Indicates that this staff has staff style assignments. | |
bool | showNameInParts {} |
"Display Staff Name in Parts" (xml node is <showNameParts> ) | |
std::shared_ptr< Transposition > | transposition |
Transposition details, if non-null. | |
bool | hideNameInScore {} |
Inverse of "Display Staff Name in Score" (xml node is <hideStfNameInScore> ) | |
Evpu | botBarlineOffset {} |
Offset for the bottom barline. | |
AlternateNotation | altNotation {} |
Alternate notation on the staff. | |
LayerIndex | altLayer {} |
Alternate notation Apply To Layer index (0..3) | |
bool | altHideArtics {} |
Hide Articulations in alternate notation (in Apply-To Layer) | |
bool | altHideLyrics {} |
Hide Lyrics in alternate notation (in Apply-To Layer) | |
bool | altHideSmartShapes {} |
Hide Smart Shapes (in Apply-To layer: probably only affects entry-attached shapes) | |
bool | altRhythmStemsUp {} |
Show stems up in alternate Rhythmic Notation mode. | |
bool | altSlashDots {} |
Show dots on beat slashes in compound meter. | |
bool | altHideOtherNotes {} |
Hide notes in other layers in alternate notation. | |
bool | altHideOtherArtics {} |
Hide articulations in other layers in alternate notation. | |
bool | altHideExpressions {} |
Hide Expressions in alternate notation (in Apply-To Layer) | |
bool | altHideOtherLyrics {} |
Hide lyrics in other layers in alternate notation. | |
bool | altHideOtherSmartShapes {} |
Hide Smart Shapes in other layers in alternate notation. | |
bool | altHideOtherExpressions {} |
Hide Expressions in other layers in alternate notation. | |
bool | hideRepeatBottomDot {} |
Inverse of "Bottom Repeat Dot" in Staff Setup dialog. | |
bool | flatBeams {} |
"Flat Beams" | |
bool | hideFretboards {} |
Inverse of "Display Fretboards". | |
bool | blankMeasure {} |
Inverse of "Display Rests in Empty Measures". | |
bool | hideRepeatTopDot {} |
Inverse of "Top Repeat Dot" in Staff Setup dialog. | |
bool | hideLyrics {} |
Inverse of "Display Lyrics". | |
bool | noOptimize {} |
Inverse of "Allow Hiding When Empty". | |
Evpu | topBarlineOffset {} |
Offset for the top barline. | |
bool | hideMeasNums {} |
Inverse of "Display Measure Numbers". | |
bool | hideRepeats {} |
Inverse of "Display Endings and Text Repeats". | |
bool | hideBarlines {} |
Inverse of "Display Barlines". | |
bool | hideRptBars {} |
Inverse of "Display Repeat Bars". | |
bool | hideKeySigs {} |
Inverse of "Display Key Signatures". | |
bool | hideTimeSigs {} |
Inverse of "Display Time Signatures in Score". | |
bool | hideClefs {} |
Inverse of "Display Clefs". | |
bool | hideStaffLines {} |
Inverse of "Display Staff Lines". | |
bool | hideChords {} |
Inverse of "Display Chords". | |
bool | noKey {} |
"Ignore Key Signatures" | |
Evpu | dwRestOffset {} |
Offset for downstem rests. | |
Evpu | wRestOffset {} |
Offset for whole rests. | |
Evpu | hRestOffset {} |
Offset for half rests. | |
Evpu | otherRestOffset {} |
Offset for other rests. | |
bool | hideRests {} |
Inverse of "Display Rests". | |
bool | hideTies {} |
Inverse of "Display Ties". | |
bool | hideDots {} |
Inverse of "Display Augmentation Dots". | |
int | stemReversal {} |
Stem reversal value. | |
Cmper | fullNameTextId {} |
Full name TextBlock ID. (xml node is <fullName> ) | |
Cmper | abbrvNameTextId {} |
Abbreviated name TextBlock ID. (xml node is <abbrvName> ) | |
Evpu | botRepeatDotOff {} |
Offset for bottom repeat dots. | |
Evpu | topRepeatDotOff {} |
Offset for top repeat dots. | |
Evpu | vertTabNumOff {} |
Vertical offset for tab number. | |
bool | hideStems {} |
Inverse of "Display Stems". | |
StemDirection | stemDirection {} |
stem direction for staff (xml node is <stemDir> ) | |
bool | hideBeams {} |
Inverse of "Show Beams". | |
HideMode | hideMode {} |
"Force Hide Staff" option | |
bool | redisplayLayerAccis {} |
"Redisplay Accidentals in Other Layers Within Measures" | |
bool | hideTimeSigsInParts {} |
Inverse of "Display Time Signatures in Parts". | |
AutoNumberingStyle | autoNumbering {} |
Autonumbering style if useAutoNumbering is true. (xml node is <autoNum> ) | |
bool | useAutoNumbering {} |
Whether names should be auto-numbered. (xml node is <useAutoNum> ) | |
bool | hideKeySigsShowAccis {} |
"Hide Key Signature and Show Accidentals" transposition option. | |
Cmper | fullNamePosId {} |
bool | fullNamePosFromStyle {} |
Cmper | abrvNamePosId {} |
bool | abrvNamePosFromStyle {} |
Cmper | multiStaffInstId {} |
Cmper | multiStaffInstVisualId {} |
Cmper | multiStaffInstVisualGroupId {} |
It is set by the factory with the Resolver function for MultiStaffInstrumentGroup. | |
std::optional< int > | autoNumberValue |
Calculated autonumbering value. It is computed by calcAllAutoNumberValues. | |
std::optional< Cmper > | percussionMapId |
Calculated percussion map Id for a percussion staff. (Populated by in calcAllRuntimeValues.) | |
Static Public Attributes | |
static constexpr std::string_view | XmlNodeName = "staffStyle" |
The XML node name for this type. | |
![]() | |
static constexpr std::string_view | XmlNodeName = "staffSpec" |
The XML node name for this type. | |
Protected Member Functions | |
StaffStyle (const std::shared_ptr< Staff > &staff) | |
protected constructor for StaffComposite | |
![]() | |
OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt) | |
Constructs an OthersBase object. | |
![]() | |
Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode) | |
Constructs the base class. | |
Base (const Base &)=default | |
explicit default copy constructor | |
Base (Base &&) noexcept=default | |
explicit default move constructor | |
Base & | operator= (const Base &) |
no-op copy assignment operator allows subclasses to copy their values. | |
Base & | operator= (Base &&) noexcept |
no-op move assignment operator allows subclasses to move their values. | |
Additional Inherited Members | |
![]() | |
enum class | AutoNumberingStyle { ArabicSuffix , RomanSuffix , OrdinalPrefix , AlphaSuffix , ArabicPrefix } |
Enum for auto-numbering style. Auto-numbering is based on instUuid. More... | |
enum class | StemDirection { Default , AlwaysUp , AlwaysDown } |
Enum for staff-level stem direction override. More... | |
enum class | NotationStyle { Standard , Percussion , Tablature } |
Enum for notation style. | |
enum class | HideMode { None , Cutaway , ScoreParts , Score } |
Enum for hide mode. More... | |
enum class | AlternateNotation { Normal , SlashBeats , Rhythmic , Blank , OneBarRepeat , TwoBarRepeat , BlankWithRests } |
Enum for alternate notation styles. More... | |
![]() | |
enum class | ShareMode { All , Partial , None } |
Describes how this instance is shared between part and score. More... | |
using | SharedNodes = std::set< std::string > |
The container type for shared nodes. | |
Represents a Finale staff style.
The cmper is a 1-based staff style ID (not necessarily sequential). This class is identified by the XML node name "staffStyle".
|
static |
Finds a subset from all StaffStyle instances that overlap with the specified metric position on a given staff in a give linked part or score.
document | The document to search |
partId | The linked part id to search |
staffId | The staff to search |
measId | The MeasCmper of the measure position |
eduPosition | The Edu position within the measure specified by measId . |
|
inlineoverridevirtual |
Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes.
The default implementation should always be called inside an overridden implementation.
musx::dom::integrity_error | if there is a problem. |
Reimplemented from musx::dom::others::Staff.
|
inlineoverridevirtual |
Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
Some classes make it difficult to discover all the possible xml tags that might be used for all its options. An example is others::TextBlock. By overriding this function, a class can allow its members to be discovered as needed without causing error messages or throwing exceptions.
Reimplemented from musx::dom::others::Staff.
std::shared_ptr<Masks> musx::dom::others::StaffStyle::masks |
override masks: guaranteed to exist by integrityCheck, which is called by the factory (xml node is <mask>
)