musx::dom::options::NoteRestOptions Class Reference

Options controlling note/rest display and positioning. More...

#include <Options.h>

Inheritance diagram for musx::dom::options::NoteRestOptions:

Classes
class	NoteColor
	16-bit per-channel note color (RGB) used by Finale. More...

Public Member Functions
	NoteRestOptions (const DocumentPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
	Constructor function.
void	integrityCheck (const std::shared_ptr< Base > &ptrToThis) override
	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.
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 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< NoteRestOptions > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
bool	doShapeNotes {}
bool	doCrossStaffNotes {}
	Inverse of "Display Cross-Staff Notes in Original Staff" (xml node is <doCrossOver>)
Evpu	drop8thRest {}
	Vertical 8th rest positioning from staff default line. (Usually the center line.)
Evpu	drop16thRest {}
	Vertical 16th rest positioning from staff default line. (Usually the center line.)
Evpu	drop32ndRest {}
	Vertical 32nd rest positioning from staff default line. (Usually the center line.)
Evpu	drop64thRest {}
	Vertical 64th rest positioning from staff default line. (Usually the center line.)
Evpu	drop128thRest {}
	Vertical 128th (and smaller) rest positioning from staff default line. (Usually the center line.)
bool	scaleManualPositioning {}
	"Scale Manual Positioning of Notes"
bool	drawOutline {}
	"Show border around colored noteheads"
std::vector< std::shared_ptr< NoteColor > >	noteColors {}
	Notehead colors, one per pitch-class.

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "noteRestOptions"
	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::OptionsBase
	OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
	Constructs the OptionsBase and validates XmlNodeName in the derived class.
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

Options controlling note/rest display and positioning.

Member Function Documentation

integrityCheck()

void musx::dom::options::NoteRestOptions::integrityCheck ( const std::shared_ptr< Base > &  ptrToThis )

inlineoverridevirtual

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.

The default implementation should always be called inside an overridden implementation.

Parameters

ptrToThis

This instance in a shared_ptr. (Avoids need for shared_from_this.)

Exceptions

musx::dom::integrity_error

if there is a problem.

Reimplemented from musx::dom::Base.

Member Data Documentation

doShapeNotes

bool musx::dom::options::NoteRestOptions::doShapeNotes {}

"Use Shape Notes" - the default set of note shapes is stored in Cmper 0 of details::ShapeNote. If true, this overrides the staff-level flag. However, if a staff or staff style has individual note-shape settings, those take precedence over the default shapes.