|
enum class | AutoVerticalMode {
AlwaysNoteheadSide
, AutoNoteStem
, StemSide
, AlwaysOnStem
,
AboveEntry
, BelowEntry
} |
| Defines the automatic vertical positioning mode. These values are only meaningful if autoVert is true. Otherwise autoVertMode has the default value but it means "Manual". More...
|
|
enum class | CopyMode { None
, Vertical
, Horizontal
} |
| Defines the character copy mode (vertical or horizontal) More...
|
|
enum class | SlurInteractionMode { Ignore
, InsideSlur
, AvoidSlur
} |
| Defines the interaction mode with slurs. More...
|
|
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.
|
|
|
| ArticulationDef (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper) |
| Constructor.
|
|
| 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.
|
|
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.
|
|
|
char32_t | charMain {} |
| Main symbol character (utf32).
|
|
std::shared_ptr< FontInfo > | fontMain |
| The font info for the main symbol. (xml nodes <fontMain> , <sizeMain> , and <efxMain> )
|
|
CopyMode | copyMode {} |
| "Copy Main Symbol" option.
|
|
bool | useTopNote {} |
| "Attach to top note"
|
|
bool | autoHorz {} |
| Whether horizontal auto-positioning is enabled.
|
|
bool | autoVert {} |
| Whether vertical auto-positioning is enabled.
|
|
AutoVerticalMode | autoVertMode {} |
| Auto vertical positioning mode.
|
|
bool | outsideStaff {} |
| Whether the articulation is outside the staff.
|
|
bool | aboveSymbolAlt {} |
| Whether the alternate symbol is used above. (Otherwise main symbol is used.)
|
|
bool | belowSymbolAlt {} |
| Whether the alternate symbol is used below. (Otherwise main symbol is used.)
|
|
bool | insideSlur {} |
| Whether the articulation is inside a slur. (Used in addition to SlurInteractionMode::InsideSlur)
|
|
bool | noPrint {} |
| "Display on screen only (do not print)"
|
|
bool | autoStack {} |
| Whether automatic stacking is enabled.
|
|
bool | centerOnStem {} |
| Whether centering on the stem is enabled.
|
|
SlurInteractionMode | slurInteractionMode {} |
| Slur interaction mode.
|
|
char32_t | charAlt {} |
| Alternate symbol character (utf32).
|
|
std::shared_ptr< FontInfo > | fontAlt |
| The font info for the alternate symbol. (xml nodes <fontAlt> , <sizeAlt> , and <efxAlt> )
|
|
Evpu | xOffsetMain {} |
| Horizontal offset for the main symbol.
|
|
Evpu | yOffsetMain {} |
| Vertical offset for the main symbol.
|
|
Evpu | defVertPos {} |
| Default vertical position.
|
|
bool | avoidStaffLines {} |
| Whether to avoid staff lines.
|
|
bool | isStemSideWhenMultipleLayers {} |
| "Place stem side when multiple layers are present"
|
|
bool | playArtic {} |
| Whether playback articulation is enabled.
|
|
Evpu | xOffsetAlt {} |
| Horizontal offset for the alternate symbol.
|
|
Evpu | yOffsetAlt {} |
| Vertical offset for the alternate symbol.
|
|
bool | mainIsShape {} |
| Whether the main symbol is a shape.
|
|
bool | altIsShape {} |
| Whether the alternate symbol is a shape.
|
|
Cmper | mainShape {} |
| Main shape ID (if applicable).
|
|
Cmper | altShape {} |
| Alternate shape ID (if applicable).
|
|
int | startTopNoteDelta {} |
| Attack change for the top note.
|
|
int | startBotNoteDelta {} |
| Attack change for the bottom note.
|
|
int | startTopNotePercent {} |
| Attack change percent for the top note.
|
|
int | startBotNotePercent {} |
| Attack change percent for the bottom note.
|
|
int | durTopNoteDelta {} |
| Duration change for the top note.
|
|
int | durBotNoteDelta {} |
| Duration change for the bottom note.
|
|
int | durTopNotePercent {} |
| Duration percent change for the top note.
|
|
int | durBotNotePercent {} |
| Duration percent change for the bottom note.
|
|
int | ampTopNoteDelta {} |
| Key velocity change for the top note.
|
|
int | ampBotNoteDelta {} |
| Key velocity change for the bottom note.
|
|
int | ampTopNotePercent {} |
| Key velocity percentage for the top note.
|
|
int | ampBotNotePercent {} |
| Key velocity percentage for the bottom note.
|
|
Evpu | distanceFromStemEnd {} |
| "On-stem distance from stem end/flag/beam"
|
|
Stores the properties and behaviors of articulation definitions.
The playback "delta" and "percent" values are alternatives. For each type of playback modification, one or the other is used. The other is zero.
This class is identified by the XML node name "articDef".