MUSX Document Model
Loading...
Searching...
No Matches
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 staffId, Cmper meas, Inci inci)
 Constructor.
 
MusxInstance< others::TextBlockgetTextBlock () const
 Gets the TextBlock for this assignment, or nullptr if none.
 
util::EnigmaParsingContext getRawTextCtx (Cmper forPartId) const
 Gets the raw text for this assignment, or nullptr if none.
 
- 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< IncigetInci () 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 SharedNodesgetUnlinkedNodes () 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< MeasureTextAssign > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

Cmper block {}
 Text block ID.
 
Edu xDispEdu {}
 
Evpu xDispEvpu {}
 Negative horizontal displacement in Evpu, when xDispEdu is zero. (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.
 
DetailsBaseoperator= (const DetailsBase &other)
 Assignment operator delegates to base, preserving OthersBase state.
 
DetailsBaseoperator= (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
 
Baseoperator= (const Base &)
 no-op copy assignment operator allows subclasses to copy their values.
 
Baseoperator= (Base &&) noexcept
 no-op move assignment operator allows subclasses to move their values.
 

Detailed Description

Represents a text block assignment for a staff and measure.

Cmper1 is the staff (staffId) 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  staffId,
Cmper  meas,
Inci  inci 
)
inlineexplicit

Constructor.

Parameters
documentA weak pointer to the associated document.
partIdThe part that this is for (probably always 0).
shareModeThe sharing mode for this MeasureTextAssign (probably always ShareMode::All).
staffIdThe staff ID for this MeasureTextAssign.
measThe measure ID for this MeasureTextAssign.
inciThe 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.