musx::dom::options::AugmentationDotOptions Class Reference

Options controlling the appearance of augmentation dots. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::AugmentationDotOptions:

Public Member Functions
	AugmentationDotOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor function.
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.
Cmper	getPartId () const
	Gets the partId for this instance (or 0 for score)
std::shared_ptr< others::PartDefinition >	getPartDefinition () const
	Gets the others::PartDefinition corresponding to getPartId.
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.
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< AugmentationDotOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	dotUpFlagOffset {}
	"Horizontal Adjustment for Upstem Flags"
Evpu	dotOffset {}
	"Space Between Dots"
bool	adjMultipleVoices {}
	"Adjust Dots for Multiple Voices" (xml node is <doDotDownAdjust>)
Evpu	dotNoteOffset {}
	"Space Between Dot and Note" (xml node is <dotFirstOffset>)
Evpu	dotLift {}
	"Vertical Adjustment of Dot"
bool	useLegacyFlippedStemPositioning {}
	Use legacy dot positioning on flipped stems.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "augmentationDotOptions"
	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::OptionsBase
	OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the OptionsBase and validates XmlNodeName in the derived class.
Protected Member Functions inherited from musx::dom::Base
	Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Options controlling the appearance of augmentation dots.

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

Member Data Documentation

useLegacyFlippedStemPositioning

bool musx::dom::options::AugmentationDotOptions::useLegacyFlippedStemPositioning {}

Use legacy dot positioning on flipped stems.

Finale 27.4 fixed a long-standing bug in how dots on flipped stems are positioned. Finale added this option to avoid messing up documents in which the user manually worked around the bug. Enabling it suppresses the 27.4 behavior. It is not represented in the Finale UI, except as a question when you first open a document that it detects might contain the workaround.

xml node is <skip27_4DotAdjust>