MUSX Document Model
Loading...
Searching...
No Matches
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.
 
util::EnigmaParsingContext getLeftStartRawTextCtx (Cmper forPartId) const
 Gets the raw text context for parsing the left-start, or nullptr if none.
 
util::EnigmaParsingContext getLeftContRawTextCtx (Cmper forPartId) const
 Gets the raw text context for parsing the left-continuation text, or nullptr if none.
 
util::EnigmaParsingContext getRightEndRawTextCtx (Cmper forPartId) const
 Gets the raw text context for parsing the right-end text, or nullptr if none.
 
util::EnigmaParsingContext getCenterFullRawTextCtx (Cmper forPartId) const
 Gets the raw text context for parsing the center-full text, or nullptr if none.
 
util::EnigmaParsingContext getCenterAbbrRawTextCtx (Cmper forPartId) const
 Gets the raw text context for parsing the center-abbreviated text, or nullptr if none.
 
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::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< IncigetInci () 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 SharedNodesgetUnlinkedNodes () 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< CharParamscharParams
 Parameters for char line style. Only allocated if lineStyle is LineStyle::Char.
 
std::shared_ptr< SolidParamssolidParams
 Parameters for solid line style. Only allocated if lineStyle is LineStyle::Solid.
 
std::shared_ptr< DashedParamsdashedParams
 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.
 
OthersBaseoperator= (const OthersBase &other)
 Assignment operator delegates to base, preserving OthersBase state.
 
OthersBaseoperator= (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
 
Baseoperator= (const Base &)
 no-op copy assignment operator allows subclasses to copy their values.
 
Baseoperator= (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

◆ getCenterAbbrRawTextCtx()

util::EnigmaParsingContext musx::dom::others::SmartShapeCustomLine::getCenterAbbrRawTextCtx ( Cmper  forPartId) const
inline

Gets the raw text context for parsing the center-abbreviated text, or nullptr if none.

Parameters
forPartIdThe linked part to used for ^partname and ^totpages inserts.

◆ getCenterFullRawTextCtx()

util::EnigmaParsingContext musx::dom::others::SmartShapeCustomLine::getCenterFullRawTextCtx ( Cmper  forPartId) const
inline

Gets the raw text context for parsing the center-full text, or nullptr if none.

Parameters
forPartIdThe linked part to used for ^partname and ^totpages inserts.

◆ getLeftContRawTextCtx()

util::EnigmaParsingContext musx::dom::others::SmartShapeCustomLine::getLeftContRawTextCtx ( Cmper  forPartId) const
inline

Gets the raw text context for parsing the left-continuation text, or nullptr if none.

Parameters
forPartIdThe linked part to used for ^partname and ^totpages inserts.

◆ getLeftStartRawTextCtx()

util::EnigmaParsingContext musx::dom::others::SmartShapeCustomLine::getLeftStartRawTextCtx ( Cmper  forPartId) const
inline

Gets the raw text context for parsing the left-start, or nullptr if none.

Parameters
forPartIdThe linked part to used for ^partname and ^totpages inserts.

◆ getRightEndRawTextCtx()

util::EnigmaParsingContext musx::dom::others::SmartShapeCustomLine::getRightEndRawTextCtx ( Cmper  forPartId) const
inline

Gets the raw text context for parsing the right-end text, or nullptr if none.

Parameters
forPartIdThe linked part to used for ^partname and ^totpages inserts.

◆ integrityCheck()

void musx::dom::others::SmartShapeCustomLine::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
ptrToThisThis instance in a shared_ptr. (Avoids need for shared_from_this.)
Exceptions
musx::dom::integrity_errorif there is a problem.

Reimplemented from musx::dom::Base.