musx::dom::details::TieAlterStart Class Reference

Alterations for tie starts. (Tie starts are normal ties.) More...

#include <Details.h>

Inheritance diagram for musx::dom::details::TieAlterStart:

Public Member Functions
	TieAlterBase (const DocumentWeakPtr &document, Cmper partId, Base::ShareMode shareMode, EntryNumber entnum, Inci inci)
	Constructor function.
Public Member Functions inherited from musx::dom::details::TieAlterBase
	TieAlterBase (const DocumentWeakPtr &document, Cmper partId, Base::ShareMode shareMode, EntryNumber entnum, Inci inci)
	Constructor function.
NoteNumber	getNoteId () const override
	Required virtual function that returns the note id.
bool	requireAllFields () const override
	Unless we decide to figure out connection types, this will stay here.
Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the entnum key value.
Public Member Functions inherited from musx::dom::DetailsBase
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).
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.

Static Public Member Functions
static const xml::XmlElementArray< TieAlterStart > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.
Static Public Member Functions inherited from musx::dom::details::TieAlterBase
static const xml::XmlElementArray< TieAlterBase > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "tieAlterStart"
	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.
Public Attributes inherited from musx::dom::details::TieAlterBase
NoteNumber	noteId {}
	Note ID associated with the tie alteration. (xml node is <noteID>)
Evpu	xStart {}
	Horizontal start position of the tie.
Evpu	xEnd {}
	Horizontal end position of the tie.
Evpu	yStart {}
	Vertical start position of the tie.
Evpu	yEnd {}
	Vertical end position of the tie.
bool	outerLocal {}
	Local setting for "Outer Tie".
bool	afterSingleDotLocal {}
	Local setting for "After Single Dot".
bool	afterSingleDotOn {}
	Enable "After Single Dot".
bool	afterMultiDotsLocal {}
	Local setting for "After Multiple Dots".
bool	afterMultiDotsOn {}
	Enable "After Multiple Dots".
bool	shiftForSecondsLocal {}
	Local setting for "Shift for Seconds".
bool	shiftForSecondsOn {}
	Enable "Shift for Seconds".
bool	beforeSingleAcciLocal {}
	Local setting for "Before Single Accidental".
bool	beforeSingleAcciOn {}
	Enable "Before Single Accidental".
bool	down {}
	Downward tie. Only applicable if freezeDirection is true. (False freezes the tie up.)
bool	breakTimeLocal {}
	Local setting for "Break at Time Signature".
bool	breakTimeOn {}
	Enable "Break at Time Signature".
bool	breakKeyLocal {}
	Local setting for "Break at Key Signature".
bool	breakKeyOn {}
	Enable "Break at Key Signature".
bool	freezeDirection {}
	Freeze tie direction. (xml node is <freeze>)
bool	stPtAdjOn {}
	Enable start point adjustment.
bool	enPtAdjOn {}
	Enable end point adjustment.
Evpu	insetRatio1 {}
	Inset ratio for the first control point.
Evpu	height1 {}
	Height of the first control point.
Evpu	insetRatio2 {}
	Inset ratio for the second control point.
Evpu	height2 {}
	Height of the second control point.
bool	ctlPtAdjOn {}
	Enable control point adjustment.
Protected Member Functions inherited from musx::dom::NoteDetailsBase
	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::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.
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

Alterations for tie starts. (Tie starts are normal ties.)

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