Options controlling the appearance of beams. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::BeamOptions:

Public Types
enum class	FlattenStyle { OnEndNotes , OnStandardNote , OnExtremeNote , AlwaysFlat }
	Beaming style choices for when to flatten beams. More...

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.

Public Member Functions
	BeamOptions (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	getSourcePartId () const
	Gets the source partId for this instance. If an instance is fully shared with the score, the source is SCORE_PARTID. If an instance is partially shared or non shared, the source is the ID of the part that sourced it.

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 (const std::shared_ptr< Base > &ptrToThis)
	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< BeamOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	beamStubLength {}
	"Broken Beam Length" in Evpu.

Evpu	maxSlope {}
	Maximum slope in Evpu.

Evpu	beamSepar {}
	Secondary beam separation in Evpu. This is the distance between the top of one beam to the top of the next.

Evpu	maxFromMiddle {}
	"Maximum Distance from Middle Staff Line" in Evpu. (xml node is `<hmBeamTip>`)

FlattenStyle	beamingStyle {}
	Beaming style.

bool	extendBeamsOverRests {}
	"Extend Beams Over Rests" (xml node is `<incEdgeRestsInBeamGroups>`)

bool	incRestsInFourGroups {}
	"Include Rests when Beaming in Group of Four" (xml node is `<incRestsInClassicBeams>`)

bool	beamFourEighthsInCommonTime {}
	"Beam Four Eighth Notes Together in Common Time"

bool	beamThreeEighthsInCommonTime {}
	"Beam Three Eighth Notes Together Before/After An Eighth Rest"

bool	dispHalfStemsOnRests {}
	"Display Half-Stems for Beamed Rests" (xml node is `<doStemStubs>`)

bool	oldFinaleRestBeams {}
	Compatibility setting for legacy Finale files.

bool	spanSpace {}
	"Allow Primary Beam Within a Space"

bool	extendSecBeamsOverRests {}
	"Extend Secondary Beams Over Rests"

Efix	beamWidth {}
	Thickness of beams in Efix.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "beamOptions"
	The XML node name for this type.

Additional Inherited Members
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.

	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.

Detailed Description

Options controlling the appearance of beams.

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

Member Enumeration Documentation

strong

Beaming style choices for when to flatten beams.

Enumerator
OnEndNotes	Flatten based on end notes only (the legacy default)
OnStandardNote	Flatten based on standard note.
OnExtremeNote	Flatten based on extreme note.
AlwaysFlat	Flatten all beams.