musx::dom::details::MeasureTextAssign Class Reference

Represents a text block assignment for a staff and measure. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::MeasureTextAssign:

Public Member Functions
	MeasureTextAssign (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper inst, Cmper meas, Inci inci)
	Constructor.
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.
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< MeasureTextAssign > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Cmper	block {}
	Text block ID.
Edu	xDispEdu {}
Evpu	xDispEvpu {}
	Negative horizontal displacement in Evpu (xml node is <xdispEvpu>)
Evpu	yDisp {}
	Vertical displacement in Evpu (xml node is <ydisp>)
bool	hidden {}
	Indicates the text appears only on screen (xml node is <postIt/>)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "measTextAssign"
	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.
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

Represents a text block assignment for a staff and measure.

Cmper1 is the staff (inst) Cmper and Cmper2 is the measure Cmper.

Note that each instance either has a positive horizontal displacement in Edu, meaning it maintains metrical alignment as spacing changes. Or it has a negative horizontal displacement in Evpu, meaning a negative offset maintains its displacement in any spacing context.

The UI interpolates these values and shows different numbers to the user, but the actual origin point where both xDispEdu and xDispEvpu are zero coincides with Edu position 0.

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

Constructor & Destructor Documentation

MeasureTextAssign()

musx::dom::details::MeasureTextAssign::MeasureTextAssign ( const DocumentWeakPtr &  document, Cmper  partId, ShareMode  shareMode, Cmper  inst, Cmper  meas, Inci  inci  )

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the associated document.
partId	The part that this is for (probably always 0).
shareMode	The sharing mode for this MeasureTextAssign (probably always ShareMode::All).
inst	The staff ID for this MeasureTextAssign.
meas	The measure ID for this MeasureTextAssign.
inci	The 0-based incident.

Member Data Documentation

xDispEdu

Edu musx::dom::details::MeasureTextAssign::xDispEdu {}

Positive horizontal displacement in Edu (xml node is <xdispEdu>) Note that the UI apparently interpolates between Evpu and Edu for this field.