Represents a graphic assignment anchored to a specific staff and measure. More...

#include <Graphics.h>

Inheritance diagram for musx::dom::details::MeasureGraphicAssign:

Public Member Functions
	MeasureGraphicAssign (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper meas, Inci inci)
	Constructor.

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< MeasureGraphicAssign > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
uint32_t	version {}
	Always 0x100, meaning perhaps "v1.0". (This was intended for tracking changes to the data format, but it was never used.)

Evpu	left {}
	Graphic left coordinate in Evpu.

Evpu	bottom {}
	Graphic bottom coordinate in Evpu.

Evpu	width {}
	Graphic width in Evpu.

Evpu	height {}
	Graphic height in Evpu.

Cmper	fDescId {}
	The Cmper of the assigned others::FileDescription. (xml tag is `<fDescID>`)

bool	hidden {}
	Indicates the graphic is hidden from print/displayed as hidden (xml node is `<displayHidden>`)

bool	savedRecord {}
	Indicates a stored/saved record. (Used internally by Finale when a graphic is created.)

Evpu	origWidth {}
	Original (intrinsic) width in Evpu.

Evpu	origHeight {}
	Original (intrinsic) height in Evpu.

Cmper	graphicCmper {}
	Graphic instance Cmper. (See others::PageGraphicAssign::graphicCmper for full explanation.)

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

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

Represents a graphic assignment anchored to a specific staff and measure.

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

Positions and sizes are Finale layout units: horizontal values use Evpu from the measure’s left edge (system coordinates); vertical values use Evpu from the staff baseline.

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

Constructor & Destructor Documentation

◆ MeasureGraphicAssign()

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

inlineexplicit

Constructor.

Parameters

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeasureGraphicAssign()