musx::dom::others::LayerAttributes Class Reference

Represents the attributes of a Finale "layer". More...

#include <Others.h>

Inheritance diagram for musx::dom::others::LayerAttributes:

Public Member Functions
	LayerAttributes (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
Public Member Functions inherited from musx::dom::OthersBase
Cmper	getCmper () const
	Gets the cmper 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< LayerAttributes > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
int	restOffset {}
	"Adjust Floating Rests by " number of staff steps.
bool	freezTiesToStems {}
	"Freeze Ties in the Same Direction as Stems" (xml node is <flipTies>)
bool	onlyIfOtherLayersHaveNotes {}
	"Apply Settings Only if Notes are in Other Layers" (xml node is <floatLayer>)
bool	useRestOffset {}
	"Adjust Floating Rests by ". Determines if restOffset is used. (xml node is <useRestOff>)
bool	freezeStemsUp {}
	If true, freeze stems up, otherwise freeze stems down. Only used if freezeLayer is true. (xml node is <freezeLayUp>)
bool	freezeLayer {}
	"Freeze Stems and Ties"
bool	playback {}
	If true, playback this layer. If false, the layer is muted.
bool	affectSpacing {}
	"Affect Music Spacing" (xml node is <spacing>)
bool	ignoreHiddenNotesOnly {}
	"Ignore Layers Containing Only Hidden Notes" (xml node is <ignoreHidden>)
bool	ignoreHiddenLayers {}
	"Ignore Hidden Layers"
bool	hideLayer {}
	"Hide Layer when Inactive"

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "layerAtts"
	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::OthersBase
	OthersBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, std::optional< Inci > inci=std::nullopt)
	Constructs an OthersBase 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 the attributes of a Finale "layer".

The cmper is the layer ID (0-3). In the Finale UI these are represented as Layer 1 thru Layer 4. The 0-based cmper value is used to identify layers where needed, rather than the 1-based UI value.

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