musx::dom::options::MusicSpacingOptions Class Reference

Options controlling music spacing. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::MusicSpacingOptions:

Public Types
enum class	ColUnisonsChoice { None , DiffNoteheads , All }
	Options for how to handle unisons. More...
enum class	GraceNoteSpacing { ResetToEntry , Automatic , KeepCurrent }
	Options for how to handle grace note spacing. More...
enum class	ManualPositioning { Clear , Ignore , Incorporate }
	Options for how to handle manual positioning. 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
	MusicSpacingOptions (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< MusicSpacingOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Evpu	minWidth {}
	Minimum measure width in Evpu.
Evpu	maxWidth {}
	Maximum measure width in Evpu.
Evpu	minDistance {}
	Minimum distance between items in Evpu.
Evpu	minDistTiedNotes {}
	Minimum distance between tied notes in Evpu.
bool	avoidColNotes {}
	Avoid collisions with notes.
bool	avoidColLyrics {}
	Avoid collisions with lyrics.
bool	avoidColChords {}
	Avoid collisions with chords.
bool	avoidColArtics {}
	Avoid collisions with articulations.
bool	avoidColClefs {}
	Avoid collisions with clefs.
bool	avoidColSeconds {}
	Avoid collisions with seconds.
bool	avoidColStems {}
	Avoid collisions with stems.
ColUnisonsChoice	avoidColUnisons {}
	Choice for how to handle collisions with unisons.
bool	avoidColLedgers {}
	Avoid collisions with ledger lines.
ManualPositioning	manualPositioning {}
	Manual positioning choice.
bool	ignoreHidden {}
	Ignore hidden notes. (This value is reversed in the Finale UI.)
bool	interpolateAllotments {}
	Interpolate allotments.
bool	usePrinter {}
	"Use Fonts & Resolution From Printer" (may be a Windows-only option)
bool	useAllottmentTables {}
	Use allotment tables for spacing.
Edu	referenceDuration {}
	Reference duration for spacing in Edu.
Evpu	referenceWidth {}
	Reference width for spacing in Evpu.
double	scalingFactor {}
	Scaling factor for spacing.
Evpu	defaultAllotment {}
	Default allotment for spacing in Evpu. (This value may not be settable in the Finale UI.)
Evpu	minDistGrace {}
	Minimum distance for grace notes in Evpu.
GraceNoteSpacing	graceNoteSpacing {}
	Choice for how to handle grace note spacing. (xml node is <graceNoteManualPositioning>)
Evpu	musFront {}
	Additional spacing before the first note in Evpu. (From Notes & Rests window.)
Evpu	musBack {}
	Additional spacing after the last note in Evpu. (From Notes & Rests window.)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "musicSpacingOptions"
	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 and enforces the static constexpr XmlNodeName.
Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Options controlling music spacing.

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

Member Enumeration Documentation

ColUnisonsChoice

enum class musx::dom::options::MusicSpacingOptions::ColUnisonsChoice

strong

Options for how to handle unisons.

Enumerator
None	Do not avoid collisions with unisons. (The default.)
DiffNoteheads	Avoid collisions with unisons that have different noteheads.
All	Avoid collisions with all unisons.

GraceNoteSpacing

enum class musx::dom::options::MusicSpacingOptions::GraceNoteSpacing

strong

Options for how to handle grace note spacing.

Enumerator
ResetToEntry	Reset to the entry position. (The default.)
Automatic	Automatically recompute grace note spacing. This activates minDistGrace. (xml value is "recomp")
KeepCurrent	Keep current grace note spacing. (xml value is "keep")

ManualPositioning

enum class musx::dom::options::MusicSpacingOptions::ManualPositioning

strong

Options for how to handle manual positioning.

Enumerator
Clear	Clear manual positioning (the default).
Ignore	Ignore manual positioning.
Incorporate	Incorporate manual positioning. (xml value is "incorp")