Represents a custom stem definition (up or down) for an entry. Which stem direction this instance controls is determined by the subclass that inherits this class as a base. More...

#include <Details.h>

Inheritance diagram for musx::dom::details::CustomStem:

Public Member Functions
	CustomStem (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum)
	Constructor.

bool	calcIsHiddenStem () const
	Calculates if this custom stem record hides the stem. The stem is determined to be hidden if one of the following is true.

Public Member Functions inherited from musx::dom::EntryDetailsBase
EntryNumber	getEntryNumber () const
	Gets the `entnum` key value.

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::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.

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< 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< CustomStem >	getForStem (const EntryInfoPtr &entryInfo, StemSelection stemSelection=StemSelection::MatchEntry)
	Gets the beam extension record for the specified `stemSelection`.

static const xml::XmlElementArray< CustomStem > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Cmper	shapeDef {}
	The Cmper of the associated others::ShapeDef. Setting this value to zero hides the stem.

Evpu	xOffset {}
	Optional horizontal displacement. (xml node is `<xdisp>`)

Evpu	yOffset {}
	Optional vertical displacement. (xml node is `<ydisp>`)

Additional Inherited Members
Public Types inherited from musx::dom::EntryDetailsBase
enum class	StemSelection { MatchEntry , UpStem , DownStem , Any }
	The options for choosing which version to retrieve for stem-specific details. More...

Public Types inherited from musx::dom::EnigmaBase
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::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.

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::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 &)
	no-op copy assignment operator allows subclasses to copy their values.

EnigmaBase &	operator= (EnigmaBase &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

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 &)
	no-op copy assignment operator allows subclasses to copy their values.

DocumentElement &	operator= (DocumentElement &&) noexcept
	no-op move assignment operator allows subclasses to move their values.

Static Protected Member Functions inherited from musx::dom::EntryDetailsBase
template<typename EDUP , typename EDDOWN , typename EDBASE >
static MusxInstance< EDBASE >	getStemDependentDetail (const EntryInfoPtr &entryInfo, StemSelection stemSelection)
	Implement retrieval of stem-specific details. (Actual functions are defined per stem-specific class)

Detailed Description

Represents a custom stem definition (up or down) for an entry. Which stem direction this instance controls is determined by the subclass that inherits this class as a base.

The entry number refers to the entry to which the stem is attached. The shape is defined by a shape definition number, and optional x/y displacements can adjust placement.

Constructor & Destructor Documentation

◆ CustomStem()

musx::dom::details::CustomStem::CustomStem	(	const DocumentWeakPtr &	document,
		Cmper	partId,
		ShareMode	shareMode,
		EntryNumber	entnum
	)

inlineexplicit

Constructor.

Parameters

document	A weak pointer to the associated document.
partId	The part this is for.
shareMode	The sharing mode.
entnum	The entry number this stem applies to.

Member Function Documentation

◆ calcIsHiddenStem()

bool musx::dom::details::CustomStem::calcIsHiddenStem ( ) const

Calculates if this custom stem record hides the stem. The stem is determined to be hidden if one of the following is true.

shapeDef is 0. (This is only possible with effort using the Finale UI, but several popular plugins do it commonly.)
The shape indicated by shapeDef does not exist.
The shape indicated by shapeDef has no instructions.

Returns: If true, the associated entry has no stem in the direction controlled by the subclass.

◆ getForStem()

MusxInstance< CustomStem > musx::dom::details::CustomStem::getForStem	(	const EntryInfoPtr &	entryInfo,
		StemSelection	stemSelection = `StemSelection::MatchEntry`
	)

static

Gets the beam extension record for the specified stemSelection.

Parameters

entryInfo	The entry to search.
stemSelection	The choice of which stem version to get.

Public Member Functions

Static Public Member Functions