Represents a graphic used by a specific ShapeDef. More...

#include <Graphics.h>

Inheritance diagram for musx::dom::others::ShapeGraphicAssign:

Public Types
using	HorizontalAlignment = options::TextOptions::HorizontalAlignment
	Horizontal alignment options.

using	VerticalAlignment = options::TextOptions::VerticalAlignment
	Vertical alignment options.

Public Types inherited from musx::dom::EnigmaBase
enum class	ShareMode { All , Partial , None }
	Describes how this instance is shared between part and score. More...

Public Member Functions
	ShapeGraphicAssign (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
	Constructor.

Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor

	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor

Cmper	getCmper () const
	Gets the `cmper` 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::EnigmaBase
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.

virtual void	integrityCheck (const std::shared_ptr< EnigmaBase > &ptrToThis)
	Performs a final consistency check after population.

virtual bool	requireAllFields () const
	Returns true if all fields are required for valid input.

Public Member Functions inherited from musx::dom::DocumentElement
virtual	~DocumentElement () noexcept(false)=default
	Virtual destructor for polymorphic behavior.

DocumentPtr	getDocument () const
	Gets a reference to the Document.

Cmper	getPartId () const
	Gets the part id associated with this instance.

Static Public Member Functions
static MusxInstance< ShapeGraphicAssign >	findForGraphic (const DocumentPtr &document, Cmper partId, Cmper graphicCmper)
	Finds the assignment used by a ShapeDef ExternalGraphic instruction.

static const xml::XmlElementArray< ShapeGraphicAssign > &	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>`)

HorizontalAlignment	hAlign {}
	Horizontal alignment of the placed graphic: possibly always `Left`. (xml tag is `<halign>`)

VerticalAlignment	vAlign {}
	Vertical alignment the placed graphic: possibly always `Top`. (xml tag is `<valign>`)

bool	fixedPerc {}
	UI setting to preserve aspect ratio. It may be meaningless here, since there is no UI setting for shape graphics.

bool	hidden {}
	Indicates the graphic is hidden from print/displayed as hidden: possibly always `false` for ShapeGraphicAssign. (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 = "shapeGraphicAssign"
	The XML node name for this type.

Additional Inherited Members
Protected Member Functions inherited from musx::dom::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase object.

OthersBase &	operator= (const OthersBase &other)
	Copy assignment preserves the destination DOM instance's document, source and requested part IDs, sharing mode, cmper, and inci.

OthersBase &	operator= (OthersBase &&other) noexcept
	Move assignment preserves the destination DOM instance's document, source and requested part IDs, sharing mode, cmper, and inci.

Protected Member Functions inherited from musx::dom::EnigmaBase
	EnigmaBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the base class.

	EnigmaBase (const EnigmaBase &)=default
	explicit default copy constructor

	EnigmaBase (EnigmaBase &&) noexcept=default
	explicit default move constructor

EnigmaBase &	operator= (const EnigmaBase &)
	Copy assignment preserves the destination DOM instance's document, source part, and sharing mode.

EnigmaBase &	operator= (EnigmaBase &&) noexcept
	Move assignment preserves the destination DOM instance's document, source part, and sharing mode.

Protected Member Functions inherited from musx::dom::DocumentElement
	DocumentElement (const DocumentWeakPtr &document, Cmper partId)
	Constructs the document element.

	DocumentElement (const DocumentElement &)=default
	explicit default copy constructor

	DocumentElement (DocumentElement &&) noexcept=default
	explicit default move constructor

DocumentElement &	operator= (const DocumentElement &)
	Copy assignment preserves the destination DOM instance's document and part ID.

DocumentElement &	operator= (DocumentElement &&) noexcept
	Move assignment preserves the destination DOM instance's document and part ID.

Detailed Description

Represents a graphic used by a specific ShapeDef.

The Cmper comes from a ShapeDefInstructionType::ExternalGraphic instruction.

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

Constructor & Destructor Documentation

◆ ShapeGraphicAssign()

musx::dom::others::ShapeGraphicAssign::ShapeGraphicAssign	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		Cmper	cmper,
		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 ShapeGraphicAssign (often ShareMode::All).
cmper	The measure ID for this ShapeGraphicAssign.
inci	The 0-based incident. (Possibly always zero in this case.)

Member Function Documentation

◆ findForGraphic()

MusxInstance< ShapeGraphicAssign > musx::dom::others::ShapeGraphicAssign::findForGraphic	(	const DocumentPtr &	document,
		Cmper	partId,
		Cmper	graphicCmper
	)

static

Finds the assignment used by a ShapeDef ExternalGraphic instruction.

Parameters

document	The document containing the shape and assignment.
partId	The requested part ID.
graphicCmper	The comparator stored by the ExternalGraphic instruction.

Returns: The matching assignment, or an empty instance when none exists.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShapeGraphicAssign()

Member Function Documentation

◆ findForGraphic()