musx::dom::options::TupletOptions Class Reference

Options controlling the appearance of tuplets. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::TupletOptions:

Public Types
enum class	AutoBracketStyle { Always , UnbeamedOnly , NeverBeamSide }
	Auto-bracket style options. More...
enum class	NumberStyle {   Nothing , Number , UseRatio , RatioPlusDenominatorNote ,   RatioPlusBothNotes }
	Number style options. More...
enum class	PositioningStyle {   Manual , BeamSide , NoteSide , Above ,   Below }
	Positioning style options. More...
enum class	BracketStyle { Nothing , Slur , Bracket }
	Bracket style options. More...
Public Types inherited from musx::dom::EnigmaBase
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
	TupletOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor function.
Public Member Functions inherited from musx::dom::EnigmaBase
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< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.
virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.
Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.
DocumentPtr	getDocument () const
	Gets a reference to the Document.
Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static const xml::XmlElementArray< TupletOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
bool	alwaysFlat {}
	"Always Flat" (xml node is <flat>)
bool	fullDura {}
	"Bracket Full Duration"
bool	metricCenter {}
	"Center Number Using Duration"
bool	avoidStaff {}
	"Avoid Staff"
AutoBracketStyle	autoBracketStyle {}
	Autobracket style.
Evpu	tupOffX {}
	Horizontal offset.
Evpu	tupOffY {}
	Vertical.
Evpu	brackOffX {}
	Horizontal offset for brackets.
Evpu	brackOffY {}
	Vertical offset for brackets.
NumberStyle	numStyle {}
	Number style.
PositioningStyle	posStyle {}
	Positioning style.
bool	allowHorz {}
	"Allow Horizontal Drag"
bool	ignoreHorzNumOffset {}
	"Ignore Horizontal Number Offset" (xml node is <ignoreGlOffs>)
bool	breakBracket {}
	"Break Slur or Bracket"
bool	matchHooks {}
	"Match Length of Hooks"
bool	useBottomNote {}
	"Use Bottom Note" (xml node is <noteBelow>)
BracketStyle	brackStyle {}
	Bracket style.
bool	smartTuplet {}
	"Engraver Tuplets"
Evpu	leftHookLen {}
	Length of the left hook in the tuplet bracket. (This value is sign-reversed in the Finale UI.)
Evpu	leftHookExt {}
	Extension of the left hook beyond the tuplet bracket.
Evpu	rightHookLen {}
	Length of the right hook in the tuplet bracket. (This value is sign-reversed in the Finale UI.)
Evpu	rightHookExt {}
	Extension of the right hook beyond the tuplet bracket.
Evpu	manualSlopeAdj {}
	"Manual Slope Adjustment" in Evpu. (xml node is <slope>)
int	tupMaxSlope {}
	Maximum slope for automatic tuplet brackets in 10ths of an angular degree.
Efix	tupLineWidth {}
	Line width for tuplet brackets in Efix.
Evpu	tupNUpstemOffset {}
	Offset for upstem tuplet numbers.
Evpu	tupNDownstemOffset {}
	Offset for downstem tuplet numbers.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "tupletOptions"
	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::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.
	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor
	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor
EnigmaBase &	operator= (const EnigmaBase &)
	no-op copy assignment operator allows subclasses to copy their values.
EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.
Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.
	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor
	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor
DocumentElement &	operator= (const DocumentElement &)
	no-op copy assignment operator allows subclasses to copy their values.
DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Detailed Description

Options controlling the appearance of tuplets.

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

Member Enumeration Documentation

AutoBracketStyle

enum class musx::dom::options::TupletOptions::AutoBracketStyle

strong

Auto-bracket style options.

Enumerator
Always	"Always Use Specified Shape"–the default value
UnbeamedOnly	"Bracket Unbeamed Notes Only"
NeverBeamSide	"Never Bracket Beamed Notes on Beam Side"

BracketStyle

enum class musx::dom::options::TupletOptions::BracketStyle

strong

Bracket style options.

Enumerator
Nothing	No bracket (the default)
Slur	Use a slur instead of a bracket.
Bracket	Use a bracket.

NumberStyle

enum class musx::dom::options::TupletOptions::NumberStyle

strong

Number style options.

Note

Finale appears to have implemented RatioPlusBothNotes and RatioPlusDenominatorNote backwards from how they are named in the xml. It is probably a long-standing bug that was never worth fixing. This DOM corrects the mistake by reversing their mapping in the enum mapping.

Enumerator
Nothing	The default.
Number	Number only.
UseRatio	Ratio X:Y.
RatioPlusDenominatorNote	displays a note value only on the denominator (xml value is "ratioPlusBothNotes")
RatioPlusBothNotes	display notes on both values (xml value is "ratioPlusDenNote")

PositioningStyle

enum class musx::dom::options::TupletOptions::PositioningStyle

strong

Positioning style options.

Enumerator
Manual	The default.
BeamSide	Display the tuplet on the beam side.
NoteSide	Display the tuplet on the note side.
Above	Display the tuplet above the notes.
Below	Display the tuplet below the notes.