musx::dom::others::SmartShapeCustomLine Class Reference

Represents a Finale smart shape custom line style. More...

#include <SmartShape.h>

Inheritance diagram for musx::dom::others::SmartShapeCustomLine:

Classes
class	CharParams
	Hold parameters for LineStyle::Char. More...
class	DashedParams
	Hold parameters for LineStyle::Dashed. More...
class	SolidParams
	Hold parameters for LineStyle::Solid. More...

Public Types
enum class	LineStyle { Char , Solid , Dashed }
	The type of line style.
enum class	LineCapType { None , Hook , ArrowheadPreset , ArrowheadCustom }
	The type of line cap.
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.

Public Member Functions
	SmartShapeCustomLine (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.
void	integrityCheck () 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::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.
virtual Cmper	getPartId () const
	Gets the partId for this instance (or SCORE_PARTID for score)
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< SmartShapeCustomLine > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
LineStyle	lineStyle {}
	Line style.
std::shared_ptr< CharParams >	charParams
	Parameters for char line style. Only allocated if lineStyle is LineStyle::Char.
std::shared_ptr< SolidParams >	solidParams
	Parameters for solid line style. Only allocated if lineStyle is LineStyle::Solid.
std::shared_ptr< DashedParams >	dashedParams
	Parameters for dashed line style. Only allocated if lineStyle is LineStyle::Dashed.
LineCapType	lineCapStartType {}
	Line cap start type.
LineCapType	lineCapEndType {}
	Line cap end type.
Cmper	lineCapStartArrowId {}
	Cmper of start arrowhead (preset or cmper of custom ShapeDef). xml node is <lineCapStartArrowID>
Cmper	lineCapEndArrowId {}
	Cmper of end arrowhead (preset or cmper of custom ShapeDef). xml node is <lineCapStartArrowID>
bool	makeHorz {}
	"Horizontal"
bool	lineAfterLeftStartText {}
	Line adjustments "Start H: After Text".
bool	lineBeforeRightEndText {}
	Line adjustments "Right H: Before Text".
bool	lineAfterLeftContText {}
	Line adjustments "Cont H: After Text".
Cmper	leftStartRawTextId {}
	Cmper of texts::SmartShapeText. xml node is <leftStartRawTextID>
Cmper	leftContRawTextId {}
	Cmper of texts::SmartShapeText. xml node is <leftContRawTextID>
Cmper	rightEndRawTextId {}
	Cmper of texts::SmartShapeText. xml node is <rightEndRawTextID>
Cmper	centerFullRawTextId {}
	Cmper of texts::SmartShapeText. xml node is <centerFullRawTextID>
Cmper	centerAbbrRawTextId {}
	Cmper of texts::SmartShapeText. xml node is <centerAbbrRawTextID>
Evpu	leftStartX {}
	Left start position X.
Evpu	leftStartY {}
	Left start position Y.
Evpu	leftContX {}
	Left continuation position X.
Evpu	leftContY {}
	Left continuation position Y.
Evpu	rightEndX {}
	Right end position X.
Evpu	rightEndY {}
	Right end position Y.
Evpu	centerFullX {}
	Center full position X.
Evpu	centerFullY {}
	Center full position Y.
Evpu	centerAbbrX {}
	Center abbreviation position X.
Evpu	centerAbbrY {}
	Center abbreviation position Y.
Evpu	lineStartX {}
	Line adjustments "Start H" value.
Evpu	lineStartY {}
	Line adjustments "V" value (Finale syncs this with lineEndY.)
Evpu	lineEndX {}
	Line adjustments "End H" value.
Evpu	lineEndY {}
	Line adjustments "Start H" value.
Evpu	lineContX {}
	Line adjustments "V" value (Finale syncs this with lineStartY.)
Efix	lineCapStartHookLength {}
	Length of start hook (if lineStyle is Hook)
Efix	lineCapEndHookLength {}
	Length of end hook (if lineStyle is Hook)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "ssLineStyle"
	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.
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 Finale smart shape custom line style.

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

Member Function Documentation

integrityCheck()

void musx::dom::others::SmartShapeCustomLine::integrityCheck ( )

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.

Exceptions

musx::dom::integrity_error

if there is a problem.

Reimplemented from musx::dom::Base.