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

#include <ShapeDesigner.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.

bool	isBlank () const
	Returns true if this shape does not draw anything.

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

std::optional< KnownShapeDefType >	recognize () const
	Determine if this is a recognized shape type.

Public Member Functions inherited from musx::dom::OthersBase
	OthersBase (const OthersBase &)=default
	explicit default copy constructor

	OthersBase (OthersBase &&) noexcept=default
	explicit default move constructor

Cmper	getCmper () const
	Gets the `cmper` 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::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 void	integrityCheck (const std::shared_ptr< Base > &ptrToThis)
	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< 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.

OthersBase &	operator= (const OthersBase &other)
	Assignment operator delegates to base, preserving OthersBase state.

OthersBase &	operator= (OthersBase &&other) noexcept
	Assignment operator delegates to base, preserving OthersBase state.

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 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 possible undocumented instruction tags.
Bracket	bracket data items: (1) bracket type (piano brace, bracket, etc.) Note This does not actually draw the bracket. It simply indicates the start of automatically created instructions that draw the bracket, ending with ClosePath.
CloneChar	cloned character for horizontal lines (e.g. trills) data items: (5) 0, 1: x and y of endpoint (y ignored) 2: unused 3: baseline shift in EMs (1/1000 of current point size) 4: the 32-bit codepoint of the character to clone
ClosePath	close path data items: none
CurveTo	relative curveto (bezier) data items: (6) 2 bezier control points and an end point
DrawChar	draw character (current font) data items: (1) The 32-bit codepoint of the character to draw
Ellipse	ellipse data items: (2) width and height of bounding rectangle current point is lower left corner
EndGroup	marks the end of a group data items: none
ExternalGraphic	external graphic (eps, pict, tiff, etc) data items: (3) width, height of graphic, cmper of corresponding ShapeGraphicAssign record
FillAlt	fill path (alternating, or even-odd rule) data items: none
FillSolid	fill path (solid, or non-zero winding rule) data items: none
GoToOrigin	go to origin point data items: none
GoToStart	go to start of path, same as close path for filled shapes data items: none
LineWidth	line width data items: (1) the new line width in Efix
Rectangle	rectangle data items: (2) width and height of rectangle current point is lower left corner
RLineTo	relative lineto data items: (2) X, Y endpoint
RMoveTo	relative moveto data items: (2) X, Y endpoint
SetArrowhead	set arrowhead data items: (4) startArrowID, endArrowID, startFlags, endFlags the meaning of the flags is currently untested, but they are likely only used to specify built-in vs. custom arrowhead
SetBlack	set black: equivalent to `SetGray(0)` data items: none
SetDash	set dash data items: (2) dash length, space between dashes
SetFont	set font data items: (3) font id, size, efx
SetGray	set gray data items: (1) gray value between 1 and 100 where 0=black and 100=white
SetWhite	set white: equivalent to `SetGray(100)` data items: none
Slur	slur data items: (6) 2 bezier control points and an end point like curve, except 2 more control points are deduced from a global slur thickness setting
StartGroup	start group data items: (11) same as StartObject
StartObject	start object data items: (11) with indices as noted: 0, 1: origin point (x, y) 2..5: bounding rect (left, top, right, bottom) 6, 7: x and y transform (scale ratio * 1000) 8: rotation transform 9,10: unused/undocumented
Stroke	stroke path data items: none
VerticalMode	pen vertical mode data items: (1) 1=center, 2=left, 3=right tells line-drawing commands to draw the line center, on the left, or on the right of the drawing coordinates specified.

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

◆ recognize()

std::optional< KnownShapeDefType > musx::dom::others::ShapeDef::recognize ( ) const

Determine if this is a recognized shape type.

Returns: If the shape is recognized, return its known type. Otherwise return std::nullopt.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes