MUSX Document Model
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
musx::dom::details::AccidentalAlterations Class Reference

Represents display alterations to an accidental for a specific note. More...

#include <Details.h>

+ Inheritance diagram for musx::dom::details::AccidentalAlterations:

Public Member Functions

 AccidentalAlterations (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
 Constructor.
 
NoteNumber getNoteId () const override
 Required virtual function that returns the note id.
 
- Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber getEntryNumber () const
 Gets the entnum key value.
 
- Public Member Functions inherited from musx::dom::DetailsBase
Cmper getCmper1 () const
 Gets the cmper1 key value.
 
Cmper getCmper2 () const
 Gets the cmper2 key value.
 
std::optional< IncigetInci () const
 Gets the optional array index (inci).
 
- Public Member Functions inherited from musx::dom::Base
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 SharedNodesgetUnlinkedNodes () 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.
 
virtual void integrityCheck ()
 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.
 
virtual bool requireAllFields () const
 Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.
 

Static Public Member Functions

static const xml::XmlElementArray< AccidentalAlterations > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

NoteNumber noteId {}
 The ID of the note being altered.
 
int percent {}
 The percentage size for the accidental, where 100 is 100%.
 
Evpu vOffset {}
 Vertical offset: positive is up. (XML node: <ayDisp>)
 
Evpu hOffset {}
 Horizontal offset: positive is right. (XML node: <axDisp>)
 
char32_t altChar {}
 If non-zero, the character to use for the accidental. (Utf-32 if the font is a Unicode font.)
 
std::shared_ptr< FontInfocustomFont
 Font settings for the accidental (populated from <fontID>, <fontSize>, and <efx>)
 
bool useOwnFont {}
 Whether to use customFont.
 
bool allowVertPos {}
 Whether to use vOffset.
 

Static Public Attributes

static constexpr std::string_view XmlNodeName = "acciAlter"
 The XML node name for this type.
 

Additional Inherited Members

- Public Types inherited from musx::dom::Base
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.
 
- Protected Member Functions inherited from musx::dom::NoteDetailsBase
 EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
 Constructor for NoteDetailsBase uses EntryDetailsBase constructor.
 
- Protected Member Functions inherited from musx::dom::EntryDetailsBase
 EntryDetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, std::optional< Inci > inci=std::nullopt)
 Constructs a EntryDetailsBase object.
 
- Protected Member Functions inherited from musx::dom::DetailsBase
 DetailsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper1, Cmper cmper2, std::optional< Inci > inci=std::nullopt)
 Constructs a DetailsBase object.
 
- Protected Member Functions inherited from musx::dom::Base
 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
 
Baseoperator= (const Base &)
 no-op copy assignment operator allows subclasses to copy their values.
 
Baseoperator= (Base &&) noexcept
 no-op move assignment operator allows subclasses to move their values.
 

Detailed Description

Represents display alterations to an accidental for a specific note.

Entry::noteDetail is set if any note in the entry has visual alterations such as adjusted accidental appearance or position.

This class is identified by the XML node name "acciAlter".

Member Function Documentation

◆ getNoteId()

NoteNumber musx::dom::details::AccidentalAlterations::getNoteId ( ) const
inlineoverridevirtual

Required virtual function that returns the note id.

Implements musx::dom::NoteDetailsBase.