musx::dom::details::TupletDef Class Reference

Options controlling the appearance of tuplets. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::TupletDef:

Public Types
using	AutoBracketStyle = options::TupletOptions::AutoBracketStyle
	see options::TupletOptions::AutoBracketStyle
using	NumberStyle = options::TupletOptions::NumberStyle
	see options::TupletOptions::NumberStyle
using	PositioningStyle = options::TupletOptions::PositioningStyle
	see options::TupletOptions::PositioningStyle
using	BracketStyle = options::TupletOptions::BracketStyle
	see options::TupletOptions::BracketStyle
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
	TupletDef (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
	Constructor function.
util::Fraction	calcReferenceDuration () const
	return the reference duration as a util::Fraction of a whole note
util::Fraction	calcDisplayDuration () const
	return the display duration as a util::Fraction of a whole note
util::Fraction	calcRatio () const
	return the tuplet ratio (reference / display)
Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the entnum key value.
Public Member Functions inherited from musx::dom::DetailsBase
	DetailsBase (const DetailsBase &)=default
	explicit default copy constructor
	DetailsBase (DetailsBase &&) noexcept=default
	explicit default move constructor
Cmper	getCmper1 () const
	Gets the cmper1 key value.
Cmper	getCmper2 () const
	Gets the cmper2 key value.
std::optional< Inci >	getInci () const
	Gets the optional array index (inci).
Cmper	getRequestedPartId () const
	If this instance was retrieved from an object pool, it contains the part ID that was used to retrieve it. If this value is different than getSourcePartId, then this instance is a copy of the pool instance.
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< TupletDef > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	displayNumber {}
	The number of notes to display (xml node is <symbolicNum>)
Edu	displayDuration {}
	The duration of each note to display (xml node is <symbolicDur>)
int	referenceNumber {}
	The number of notes "in the time of" (xml node is <refNum>)
Edu	referenceDuration {}
	The duration of eacn note "in the time of" (xml node is <refDur>)
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.
bool	hidden {}
	Inverse of "Show".
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>)

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

Additional Inherited Members
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.
DetailsBase &	operator= (const DetailsBase &other)
	Assignment operator delegates to base, preserving OthersBase state.
DetailsBase &	operator= (DetailsBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.
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 tuplets.

Entry::tupletStart is set if the entry starts a tuplet.

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