Represents a shape created in Finale's Shape Designer. More...

#include <Others.h>

Inheritance diagram for musx::dom::others::ShapeDef:

Public Types
enum class	InstructionType { Undocumented , Bracket , CloneChar , ClosePath , CurveTo , DrawChar , Ellipse , EndGroup , ExternalGraphic , FillAlt , FillSolid , GoToOrigin , GoToStart , LineWidth , Rectangle , RLineTo , RMoveTo , SetArrowhead , SetBlack , SetDash , SetFont , SetGray , SetWhite , Slur , StartGroup , StartObject , Stroke , VerticalMode }
	Defines the instruction types for Shape Designer shapes. More...

enum class	ShapeType { Other = 0 , Articulation = 1 , Barline = 2 , Executable = 3 , Expression = 4 , CustomStem = 5 , Frame = 6 , Arrowhead = 7 , Fretboard = 8 , Clef = 9 }
	Represents different types of shapes in Finale's Shape Designer. More...

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
	ShapeDef (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
	Constructor function.

void	iterateInstructions (std::function< bool(InstructionType, std::vector< int >)> callback) const
	Iterates through the instructions in the shape.

bool	requireAllFields () const override
	Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

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.

Static Public Member Functions
static const xml::XmlElementArray< ShapeDef > &	xmlMappingArray ()
	Required for musx::factory::FieldPopulator.

Public Attributes
Cmper	instructionList
	Instruction list Cmper. (xml node is `<instList>`)

Cmper	dataList
	Instruction data list Cmper.

ShapeType	shapeType
	Shape type (specifies which type of entity this shape pertains to)

Static Public Attributes
static constexpr std::string_view	XmlNodeName = "shapeDef"
	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 and enforces the static constexpr XmlNodeName.

Base &	operator= (const Base &)
	assignment constructor: m_unlinkedNodes is intentionally omitted

Detailed Description

Represents a shape created in Finale's Shape Designer.

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

Member Enumeration Documentation

◆ InstructionType

enum class musx::dom::others::ShapeDef::InstructionType

strong

Defines the instruction types for Shape Designer shapes.

Enumerator
Undocumented	catch-all for instruction tags not yet documented

◆ ShapeType

enum class musx::dom::others::ShapeDef::ShapeType

strong

Represents different types of shapes in Finale's Shape Designer.

Enumerator
Other	May Correspond to "other" in XML (but may not appear in XML). All pre-Fin2k shapes use this value.
Articulation	Corresponds to "articulation" in XML.
Barline	Corresponds to "barline" in XML.
Executable	Corresponds to "executable" in XML.
Expression	Corresponds to "expression" in XML.
CustomStem	Corresponds to "note" in XML.
Frame	Corresponds to "frame" in XML.
Arrowhead	Corresponds to "arrowhead" in XML.
Fretboard	Corresponds to "fretboard" in XML.
Clef	Corresponds to "clef" in XML.

Member Function Documentation

◆ iterateInstructions()

void musx::dom::others::ShapeDef::iterateInstructions ( std::function< bool(InstructionType, std::vector< int >)> callback ) const

Iterates through the instructions in the shape.

Parameters

callback The callback function. Returning false from this function aborts the iteration loop.

◆ requireAllFields()

bool musx::dom::others::ShapeDef::requireAllFields ( ) const

inlineoverridevirtual

Specifies if the parser should alert (print or throw) when an unknown xml tag is found for this class.

Some classes make it difficult to discover all the possible xml tags that might be used for all its options. An example is others::TextBlock. By overriding this function, a class can allow its members to be discovered as needed without causing error messages or throwing exceptions.

Remarks: This value only escapes errors on fields. Enum values must still have all values provided to avoid error messages or exceptions.

Reimplemented from musx::dom::Base.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes