MUSX Document Model
Loading...
Searching...
No Matches
SmartShape.h
1/*
2 * Copyright (C) 2025, Robert Patterson
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
21 */
22#pragma once
23
24#include "musx/util/Logger.h"
25#include "musx/util/Fraction.h"
26
27#include "BaseClasses.h"
28#include "CommonClasses.h"
29 // do not add other dom class dependencies. Use Implementations.cpp for implementations that need total class access.
30
31namespace musx {
32namespace dom {
33
34class EntryInfoPtr;
35
36namespace details {
37class SmartShapeEntryAssign;
38}
39
40namespace others {
41 class SmartShapeMeasureAssign;
42}
43
44namespace smartshape {
45
50enum class DirectionType
51{
52 None,
53 Under,
54 Over
55};
56
64enum class EntryConnectionType
65{
66 HeadLeftTop,
67 HeadRightTop,
68 HeadRightBottom,
69 HeadLeftBottom,
70
71 StemLeftTop,
72 StemRightTop,
73 StemRightBottom,
74 StemLeftBottom,
75
76 NoteLeftTop,
77 NoteRightTop,
78 NoteRightBottom,
79 NoteLeftBottom,
80 NoteLeftCenter,
81 NoteRightCenter,
82
83 LyricRightCenter,
84 LyricLeftCenter,
85 LyricRightBottom,
86 HeadRightLyricBaseline,
87 DotRightLyricBaseline,
88 DurationLyricBaseline,
89
90 SystemLeft,
91 SystemRight
92};
93
113
151
168
169} // namespace smartshape
170
171namespace others {
172
179class SmartShape : public OthersBase
180{
181public:
183 explicit SmartShape(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper)
184 : OthersBase(document, partId, shareMode, cmper) {}
185
190 {
191 public:
193
194 std::shared_ptr<smartshape::EndPoint> endPoint;
195 std::shared_ptr<smartshape::EndPointAdjustment> endPointAdj;
196 std::shared_ptr<smartshape::ControlPointAdjustment> ctlPtAdj;
197 std::shared_ptr<smartshape::EndPointAdjustment> breakAdj;
199
200 void integrityCheck(const std::shared_ptr<Base>& ptrToThis) override
201 {
203 if (!endPoint) {
204 endPoint = std::make_shared<smartshape::EndPoint>(getParent());
205 }
206 if (!endPointAdj) {
207 endPointAdj = std::make_shared<smartshape::EndPointAdjustment>(getParent());
208 }
209 if (!ctlPtAdj) {
210 ctlPtAdj = std::make_shared<smartshape::ControlPointAdjustment>(getParent());
211 }
212 if (!breakAdj) {
213 breakAdj = std::make_shared<smartshape::EndPointAdjustment>(getParent());
214 }
215 endPoint->integrityCheck(ptrToThis);
216 endPointAdj->integrityCheck(ptrToThis);
217 ctlPtAdj->integrityCheck(ptrToThis);
218 breakAdj->integrityCheck(ptrToThis);
219 }
220
222 };
223
277
283 {
284 Auto,
285 Off,
286 On,
287 };
288
294 {
295 Auto,
296 Off,
297 On,
298 Invalid = -1
299 };
300
309 {
310 Same,
311 Opposite,
314 };
315
320 enum class LyricTextType
321 {
322 None,
323 Verse,
324 Chorus,
325 Section,
326 };
327
329 bool entryBased{};
330 bool rotate{};
332 bool makeHorz{};
334 bool makeVert{};
338 std::shared_ptr<TerminationSeg> startTermSeg;
339 std::shared_ptr<TerminationSeg> endTermSeg;
340 std::shared_ptr<smartshape::ControlPointAdjustment> fullCtlPtAdj;
341 bool hidden{};
353
359 bool calcAppliesTo(const EntryInfoPtr& entryInfo) const;
360
361 void integrityCheck(const std::shared_ptr<Base>& ptrToThis) override
362 {
364 if (!startTermSeg) {
365 startTermSeg = std::make_shared<TerminationSeg>(ptrToThis);
366 }
367 if (!endTermSeg) {
368 endTermSeg = std::make_shared<TerminationSeg>(ptrToThis);
369 }
370 if (!fullCtlPtAdj) {
371 fullCtlPtAdj = std::make_shared<smartshape::ControlPointAdjustment>(ptrToThis);
372 }
373 startTermSeg->integrityCheck(ptrToThis);
374 endTermSeg->integrityCheck(ptrToThis);
375 fullCtlPtAdj->integrityCheck(ptrToThis);
376 }
377
378 constexpr static std::string_view XmlNodeName = "smartShape";
380};
381
389{
390 util::EnigmaParsingContext getRawTextCtx(Cmper forPartId, Cmper textBlockId) const;
391
392public:
394 explicit SmartShapeCustomLine(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper)
395 : OthersBase(document, partId, shareMode, cmper) {}
396
399 enum class LineStyle { Char, Solid, Dashed };
400
403 enum class LineCapType { None, Hook, ArrowheadPreset, ArrowheadCustom };
404
407 {
408 public:
410 explicit CharParams(const MusxInstance<Base>& parent)
411 : ContainedClassBase(parent), font(std::make_shared<FontInfo>(parent->getDocument()))
412 {
413 }
414
415 char32_t lineChar{};
416 std::shared_ptr<FontInfo> font;
418
420 };
421
432
444
446 std::shared_ptr<CharParams> charParams;
447 std::shared_ptr<SolidParams> solidParams;
448 std::shared_ptr<DashedParams> dashedParams;
449
454
455 bool makeHorz{};
459
465
476
482
485
491 { return getRawTextCtx(forPartId, leftStartRawTextId); }
492
498 { return getRawTextCtx(forPartId, leftContRawTextId); }
499
505 { return getRawTextCtx(forPartId, rightEndRawTextId); }
506
512 { return getRawTextCtx(forPartId, centerFullRawTextId); }
513
519 { return getRawTextCtx(forPartId, centerAbbrRawTextId); }
520
521 void integrityCheck(const std::shared_ptr<Base>& ptrToThis) override
522 {
524
525 if (lineStyle == LineStyle::Char && !charParams)
526 charParams = std::make_shared<CharParams>(ptrToThis);
527
528 if (lineStyle == LineStyle::Solid && !solidParams)
529 solidParams = std::make_shared<SolidParams>(ptrToThis);
530
531 if (lineStyle == LineStyle::Dashed && !dashedParams)
532 dashedParams = std::make_shared<DashedParams>(ptrToThis);
533 }
534
535 constexpr static std::string_view XmlNodeName = "ssLineStyle";
537};
538
551{
552public:
554 explicit SmartShapeMeasureAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
555 : OthersBase(document, partId, shareMode, cmper, inci)
556 {
557 }
558
562
563 constexpr static std::string_view XmlNodeName = "smartShapeMeasMark";
565};
566
567} // namespace others
568
569namespace details {
570
587{
588public:
589
598 explicit CenterShape(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper shapeNum, Cmper centerShapeNum)
599 : DetailsBase(document, partId, shareMode, shapeNum, centerShapeNum)
600 {}
601
602 std::shared_ptr<smartshape::EndPointAdjustment> startBreakAdj;
603 std::shared_ptr<smartshape::EndPointAdjustment> endBreakAdj;
604 std::shared_ptr<smartshape::ControlPointAdjustment> ctlPtAdj;
605
606 void integrityCheck(const std::shared_ptr<Base>& ptrToThis) override
607 {
608 if (!startBreakAdj) {
609 startBreakAdj = std::make_shared<smartshape::EndPointAdjustment>(ptrToThis);
610 }
611 if (!endBreakAdj) {
612 endBreakAdj = std::make_shared<smartshape::EndPointAdjustment>(ptrToThis);
613 }
614 if (!ctlPtAdj) {
615 ctlPtAdj = std::make_shared<smartshape::ControlPointAdjustment>(ptrToThis);
616 }
617 }
618
619 constexpr static std::string_view XmlNodeName = "centerShape";
621};
622
630{
631public:
633 explicit SmartShapeEntryAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
634 : EntryDetailsBase(document, partId, shareMode, entnum, inci)
635 {
636 }
637
639
640 constexpr static std::string_view XmlNodeName = "smartShapeEntryMark";
642};
643
644} // namespace details
645
646} // namespace dom
647} // namespace musx
DocumentPtr getDocument() const
Gets a reference to the Document.
Definition BaseClasses.h:108
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 ...
Definition BaseClasses.h:154
ShareMode
Describes how this instance is shared between part and score.
Definition BaseClasses.h:91
Base class for classes that are contained by other classes.
Definition BaseClasses.h:224
ContainedClassBase(const MusxInstance< Base > &parent)
Constructs a ContainedClassBase object.
Definition BaseClasses.h:233
MusxInstance< ParentClass > getParent() const
Get the parent.
Definition BaseClasses.h:239
Base class for all "details" types.
Definition BaseClasses.h:407
Base class for all "details" types that use entnum rather than cmper and cmper.
Definition BaseClasses.h:479
Wraps a frame of shared_ptr<const EntryInfo> and an index for per entry access. This class manages ow...
Definition Entries.h:388
Represents the default font settings for a particular element type.
Definition CommonClasses.h:123
Base class for all "others" types.
Definition BaseClasses.h:283
Represents a center shape for a others::SmartShape that spans three or more measures.
Definition SmartShape.h:587
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition SmartShape.h:619
std::shared_ptr< smartshape::ControlPointAdjustment > ctlPtAdj
Manual adjustments made to this center shape.
Definition SmartShape.h:604
std::shared_ptr< smartshape::EndPointAdjustment > endBreakAdj
Adjustment at the end break (xml: <endBreakAdj>)
Definition SmartShape.h:603
CenterShape(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper shapeNum, Cmper centerShapeNum)
Constructor.
Definition SmartShape.h:598
std::shared_ptr< smartshape::EndPointAdjustment > startBreakAdj
Adjustment at the start break (xml: <startBreakAdj>)
Definition SmartShape.h:602
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 ...
Definition SmartShape.h:606
static const xml::XmlElementArray< CenterShape > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Assigns a smart shape to an entry.
Definition SmartShape.h:630
Cmper shapeNum
The Cmper of the others::SmartShape that is being assigned.
Definition SmartShape.h:638
SmartShapeEntryAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, EntryNumber entnum, Inci inci)
Constructor function.
Definition SmartShape.h:633
static const xml::XmlElementArray< SmartShapeEntryAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition SmartShape.h:640
Hold parameters for LineStyle::Char.
Definition SmartShape.h:407
static const xml::XmlElementArray< CharParams > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
char32_t lineChar
The character to use for the line.
Definition SmartShape.h:415
CharParams(const MusxInstance< Base > &parent)
Constructor function.
Definition SmartShape.h:410
std::shared_ptr< FontInfo > font
<fontID>, <fontSize>, <fontEfx>
Definition SmartShape.h:416
int baselineShiftEms
The UI says the units are "EMs", but it may be 1/100 EMs.
Definition SmartShape.h:417
Hold parameters for LineStyle::Dashed.
Definition SmartShape.h:434
Efix dashOff
Length of gap between dashes.
Definition SmartShape.h:440
Efix dashOn
Dash length.
Definition SmartShape.h:439
Efix lineWidth
Dashed line width.
Definition SmartShape.h:438
static const xml::XmlElementArray< DashedParams > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Hold parameters for LineStyle::Solid.
Definition SmartShape.h:424
Efix lineWidth
Solid line width.
Definition SmartShape.h:428
static const xml::XmlElementArray< SolidParams > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Represents a Finale smart shape custom line style.
Definition SmartShape.h:389
Evpu leftContX
Left continuation position X.
Definition SmartShape.h:468
Evpu rightEndX
Right end position X.
Definition SmartShape.h:470
bool lineBeforeRightEndText
Line adjustments "Right H: Before Text".
Definition SmartShape.h:457
Evpu leftStartX
Left start position X.
Definition SmartShape.h:466
SmartShapeCustomLine(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
Constructor function.
Definition SmartShape.h:394
LineCapType lineCapEndType
Line cap end type.
Definition SmartShape.h:451
util::EnigmaParsingContext getLeftContRawTextCtx(Cmper forPartId) const
Gets the raw text context for parsing the left-continuation text, or nullptr if none.
Definition SmartShape.h:497
Evpu centerFullY
Center full position Y.
Definition SmartShape.h:473
Efix lineCapStartHookLength
Length of start hook (if lineStyle is Hook)
Definition SmartShape.h:483
Cmper centerFullRawTextId
Cmper of texts::SmartShapeText. xml node is <centerFullRawTextID>
Definition SmartShape.h:463
Evpu centerAbbrY
Center abbreviation position Y.
Definition SmartShape.h:475
static const xml::XmlElementArray< SmartShapeCustomLine > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Efix lineCapEndHookLength
Length of end hook (if lineStyle is Hook)
Definition SmartShape.h:484
util::EnigmaParsingContext getCenterFullRawTextCtx(Cmper forPartId) const
Gets the raw text context for parsing the center-full text, or nullptr if none.
Definition SmartShape.h:511
Cmper leftStartRawTextId
Cmper of texts::SmartShapeText. xml node is <leftStartRawTextID>
Definition SmartShape.h:460
Evpu lineEndX
Line adjustments "End H" value.
Definition SmartShape.h:479
Evpu rightEndY
Right end position Y.
Definition SmartShape.h:471
Evpu lineEndY
Line adjustments "Start H" value.
Definition SmartShape.h:480
util::EnigmaParsingContext getRightEndRawTextCtx(Cmper forPartId) const
Gets the raw text context for parsing the right-end text, or nullptr if none.
Definition SmartShape.h:504
std::shared_ptr< CharParams > charParams
Parameters for char line style. Only allocated if lineStyle is LineStyle::Char.
Definition SmartShape.h:446
std::shared_ptr< DashedParams > dashedParams
Parameters for dashed line style. Only allocated if lineStyle is LineStyle::Dashed.
Definition SmartShape.h:448
LineStyle lineStyle
Line style.
Definition SmartShape.h:445
Evpu centerAbbrX
Center abbreviation position X.
Definition SmartShape.h:474
bool lineAfterLeftContText
Line adjustments "Cont H: After Text".
Definition SmartShape.h:458
Evpu leftContY
Left continuation position Y.
Definition SmartShape.h:469
Cmper lineCapStartArrowId
Cmper of start arrowhead (preset or cmper of custom ShapeDef). xml node is <lineCapStartArrowID>
Definition SmartShape.h:452
bool lineAfterLeftStartText
Line adjustments "Start H: After Text".
Definition SmartShape.h:456
Evpu lineContX
Line adjustments "V" value (Finale syncs this with lineStartY.)
Definition SmartShape.h:481
Cmper rightEndRawTextId
Cmper of texts::SmartShapeText. xml node is <rightEndRawTextID>
Definition SmartShape.h:462
Evpu leftStartY
Left start position Y.
Definition SmartShape.h:467
bool makeHorz
"Horizontal"
Definition SmartShape.h:455
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 ...
Definition SmartShape.h:521
Cmper centerAbbrRawTextId
Cmper of texts::SmartShapeText. xml node is <centerAbbrRawTextID>
Definition SmartShape.h:464
Cmper leftContRawTextId
Cmper of texts::SmartShapeText. xml node is <leftContRawTextID>
Definition SmartShape.h:461
util::EnigmaParsingContext getCenterAbbrRawTextCtx(Cmper forPartId) const
Gets the raw text context for parsing the center-abbreviated text, or nullptr if none.
Definition SmartShape.h:518
util::EnigmaParsingContext getLeftStartRawTextCtx(Cmper forPartId) const
Gets the raw text context for parsing the left-start, or nullptr if none.
Definition SmartShape.h:490
LineStyle
The type of line style.
Definition SmartShape.h:399
std::shared_ptr< SolidParams > solidParams
Parameters for solid line style. Only allocated if lineStyle is LineStyle::Solid.
Definition SmartShape.h:447
Cmper lineCapEndArrowId
Cmper of end arrowhead (preset or cmper of custom ShapeDef). xml node is <lineCapStartArrowID>
Definition SmartShape.h:453
LineCapType
The type of line cap.
Definition SmartShape.h:403
Evpu lineStartX
Line adjustments "Start H" value.
Definition SmartShape.h:477
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition SmartShape.h:535
Evpu centerFullX
Center full position X.
Definition SmartShape.h:472
Evpu lineStartY
Line adjustments "V" value (Finale syncs this with lineEndY.)
Definition SmartShape.h:478
LineCapType lineCapStartType
Line cap start type.
Definition SmartShape.h:450
Assigns a smart shape or center shape to a measure.
Definition SmartShape.h:551
static const xml::XmlElementArray< SmartShapeMeasureAssign > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
static constexpr std::string_view XmlNodeName
The XML node name for this type.
Definition SmartShape.h:563
SmartShapeMeasureAssign(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
Constructor function.
Definition SmartShape.h:554
Cmper shapeNum
The Cmper of the SmartShape that is being assigned.
Definition SmartShape.h:559
Cmper centerShapeNum
Definition SmartShape.h:560
Represents the termination segment of the smart shape.
Definition SmartShape.h:190
std::shared_ptr< smartshape::ControlPointAdjustment > ctlPtAdj
Manual adjustments for the shape at this endpoint.
Definition SmartShape.h:196
static const xml::XmlElementArray< TerminationSeg > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
std::shared_ptr< smartshape::EndPoint > endPoint
Endpoint information.
Definition SmartShape.h:194
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 ...
Definition SmartShape.h:200
std::shared_ptr< smartshape::EndPointAdjustment > endPointAdj
Endpoint adjustment information.
Definition SmartShape.h:195
std::shared_ptr< smartshape::EndPointAdjustment > breakAdj
Definition SmartShape.h:197
Represents a Finale smart shape.
Definition SmartShape.h:180
SlurAvoidAccidentalsState
The selection whether this shape avoids accidentals. (Only applicable for slurs.)
Definition SmartShape.h:294
@ Invalid
May not be used, but exists as a possibility in the Finale app.
SmartShape(const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode, Cmper cmper)
Constructor function.
Definition SmartShape.h:183
Cmper lineStyleId
If non-zero, the SmartShapeCustomLine for this shape. Several ShapeType values use it....
Definition SmartShape.h:344
bool entryBased
Whether the shape is entry-based.
Definition SmartShape.h:329
NoteNumber startNoteId
If non-zero, the specific note with the entry that this shape starts from. (xml node is <startNoteID>...
Definition SmartShape.h:342
SystemBreakType
How this shape breaks across systems. Represents the choice between "Make Horizontal Over System Brea...
Definition SmartShape.h:309
@ Same
System break honors makeHorz setting over a system break. (Default)
LyricTextType endLyricType
Definition SmartShape.h:351
LyricTextType
The lyric text type if this is a lyrics smart shape.
Definition SmartShape.h:321
@ None
The default, for when there is no lyrics text block.
@ Verse
The assignment is to a Verse lyrics text block.
@ Chorus
The assignment is to a Chorus lyrics text block.
@ Section
The assignment is to a Section lyrics text block.
EngraverSlurState
The selection for engraver slurs. (Only applicable for slurs.)
Definition SmartShape.h:283
@ Auto
Take the engraver slur setting from options::SmartShapeOptions::useEngraverSlurs. (Default value....
@ Off
Do not use engraver slur behaviour.
bool calcAppliesTo(const EntryInfoPtr &entryInfo) const
Calculates if the smart shape applies to the specified entry.
Definition SmartShape.cpp:146
Cmper startLyricNum
The text block of the lyrics text if this is a word extension or hyphen smart shape.
Definition SmartShape.h:345
std::shared_ptr< TerminationSeg > endTermSeg
End termination segment.
Definition SmartShape.h:339
NoteNumber endNoteId
If non-zero, the specific note with the entry that this shape ends on. (xml node is <endNoteID>)
Definition SmartShape.h:343
bool makeVert
This option has no obvious setting in the Finale U.I. A plugin could perhaps set it,...
Definition SmartShape.h:334
bool hidden
Inverse of "Show" option.
Definition SmartShape.h:341
EngraverSlurState engraverSlurState
The engraver slur setting if this is a slur.
Definition SmartShape.h:335
ShapeType
All the smart shape types supported by Finale.
Definition SmartShape.h:233
@ TwoOctaveUp
Quindicesima (15ma) == 21.
@ DashLineDownLeft
Dashed line with downward left hook.
@ DashLineUpLeft
Dashed line with upward left hook. == 32.
@ CustomLine
User-created custom line with shape determined by lineStyleId. (xml value is "smartLine")
@ Crescendo
Crescendo hairpin. (xml value is "cresc")
@ SlurAuto
Slur with direction automatically determined.
@ DashSlurUp
Thin line dashed upward slur (tips point down).
@ Trill
Trill (includes "tr" symbol at the beginning). == 14.
@ DashLineUp
Dashed line with upward hook.
@ DashLineDownBoth
Dashed line with downward hooks on both ends. (xml value is "dashLineDown2")
@ SlurDown
Downward Slur (tips point up). This is the default and may not appear in the xml, but the text is in ...
@ WordExtension
Lyric word extension, used only with lyric assignments. (xml value is "wordExt")
@ TabSlide
Tab slide (a solid line that is often used as a note-attached glissando)
@ SolidLineDown
Solid line with downward right hook.
@ DashSlurDown
Thin line dashed downward slur (tips point up).
@ SolidLineDownBoth
Solid line with downward hooks on both ends. (xml value is "solidLineDown2")
@ Glissando
Glissando (shape is determined by lineStyleId) == 25 (24 has no value)
@ SolidLineDownUp
Solid line with downward left hook and upward right hook.
@ SolidLineUp
Solid line with upward right hook.
@ Decrescendo
Decrescendo hairpin. (xml value is "decresc")
@ BendHat
Bend hat (solid up-down line with a corner in the middle)
@ Hyphen
Lyric hyphen, used only with lyric assignments.
@ DashLineUpDown
Dashed line with upward left hook and downward right hook.
@ DashContourSlurAuto
Contoured line dashed slur with direction automatically determined.
@ DashContourSlurUp
Contoured line dashed upward slur (tips point down).
@ DashContourSlurDown
Contoured line dashed downward slur (tips point up).
@ SolidLineDownLeft
Solid line with downward left hook.
@ DashLineDown
Dashed line with downward hook. == 7.
@ DashLineUpBoth
Dashed line with upward hooks on both ends. (xml value is "dashLineUp2")
@ SolidLineUpBoth
Solid line with upward hooks on both ends. (xml value is "solidLineUp2")
@ DashSlurAuto
Thin line dashed slur with direction automatically determined.
@ SolidLineUpDown
Solid line with upward left hook and downward right hook.
@ TrillExtension
Trill extension: only the wavy line. (xml value is "trillExt")
@ SolidLineUpLeft
Solid line with upward left hook.
@ TwoOctaveDown
Quindicesima bassa (15ma bassa)
@ SlurUp
Upward Slur (tips point down).
@ DashLineDownUp
Dashed line with downward left hook and upward right hook.
bool makeHorz
"Make Horizontal"
Definition SmartShape.h:332
SystemBreakType yBreakType
Whether a system break should honor makeHorz or do its opposite.
Definition SmartShape.h:337
Cmper endLyricNum
Definition SmartShape.h:346
SlurAvoidAccidentalsState slurAvoidAcciState
The avoid accidentals settings if this is a slur.
Definition SmartShape.h:336
bool noPresetShape
Legacy flag that may no longer be used.
Definition SmartShape.h:331
static const xml::XmlElementArray< SmartShape > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
bool noPushEndStart
Legacy flag that should always be false in modern files going back to at least Finale 2000.
Definition SmartShape.h:333
bool rotate
Purpose unknown: always set for slurs.
Definition SmartShape.h:330
static constexpr std::string_view XmlNodeName
XML node name.
Definition SmartShape.h:378
std::shared_ptr< smartshape::ControlPointAdjustment > fullCtlPtAdj
If the shape is only on one staff system, this is where the manual edits are.
Definition SmartShape.h:340
std::shared_ptr< TerminationSeg > startTermSeg
Start termination segment.
Definition SmartShape.h:338
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 ...
Definition SmartShape.h:361
LyricTextType startLyricType
The type of lyrics block for startLyricNum. (xml node is <startLyricTag>)
Definition SmartShape.h:350
ShapeType shapeType
Type of smart shape.
Definition SmartShape.h:328
Represents the manual adjustments to a smart shape.
Definition SmartShape.h:100
DirectionType contextDir
The direction type for this adjustment.
Definition SmartShape.h:109
Evpu startCtlPtY
Vertical offset of the start control point.
Definition SmartShape.h:105
Evpu endCtlPtY
Vertical offset of the end control point.
Definition SmartShape.h:107
Evpu startCtlPtX
Horizontal offset of the start control point.
Definition SmartShape.h:104
static const xml::XmlElementArray< ControlPointAdjustment > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu endCtlPtX
Horizontal offset of the end control point.
Definition SmartShape.h:106
bool active
If true, this adjustment should be used when it is applicable.
Definition SmartShape.h:108
Represents the endpoint adjustment of a smart shape or center shape.
Definition SmartShape.h:156
EntryConnectionType contextEntCnct
The entry conntection type for this adjustment.
Definition SmartShape.h:164
bool active
If true, this adjustment should be used when it is applicable (xml node is <on>)
Definition SmartShape.h:162
static const xml::XmlElementArray< EndPointAdjustment > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
Evpu horzOffset
Horizontal offset (xml node is <x>)
Definition SmartShape.h:160
Evpu vertOffset
Vertical offset (xml node is <y>)
Definition SmartShape.h:161
DirectionType contextDir
The direction type for this adjustment.
Definition SmartShape.h:163
Represents an endpoint of the smart shape.
Definition SmartShape.h:118
util::Fraction calcGlobalPosition() const
Calculates the global position of the endpoint within its measure, based on whether it is measure- or...
Definition SmartShape.cpp:123
Edu eduPosition
Edu position of endpoint (xml node is <edu>)
Definition SmartShape.h:124
bool calcIsAssigned() const
Return true if this endpoint is properly assigned to its measure and to its entry (for entry-attached...
Definition SmartShape.cpp:97
util::Fraction calcPosition() const
Calculates the staff-level position of the endpoint within its measure, based on whether it is measur...
Definition SmartShape.cpp:108
EntryNumber entryNumber
Entry number. Zero if the endpoint is not entry-attached. (xml node is <entryNum>)
Definition SmartShape.h:125
MusxInstance< details::SmartShapeEntryAssign > getEntryAssignment() const
Gets the entry assignment for this endpoint or null if none. Always null for measure-assigned endpoin...
Definition SmartShape.cpp:75
static const xml::XmlElementArray< EndPoint > & xmlMappingArray()
Required for musx::factory::FieldPopulator.
MusxInstance< others::SmartShapeMeasureAssign > getMeasureAssignment() const
Gets the measure assignment for this endpoint or null if none.
Definition SmartShape.cpp:56
MeasCmper measId
Measure ID (xml node is <meas>)
Definition SmartShape.h:123
EntryInfoPtr calcAssociatedEntry(Cmper forPartId) const
Calculates the entry associated with the endpoint.
Definition SmartShape.cpp:34
StaffCmper staffId
Staff ID (xml node is <inst>)
Definition SmartShape.h:122
Wrapper class for interpreting and rendering Enigma-style strings with insert handling.
Definition EnigmaString.h:415
A class to represent fractions with integer m_numerator and m_denominator, automatically reduced to s...
Definition Fraction.h:38
@ None
Default value, no rehearsal mark style.
int16_t MeasCmper
Enigma meas Cmper (may be negative when not applicable)
Definition Fundamentals.h:64
int32_t Efix
EFIX value (64 per EVPU, 64*288=18432 per inch)
Definition Fundamentals.h:60
std::shared_ptr< const T > MusxInstance
Defines the type of a musx instance stored in a pool.
Definition MusxInstance.h:35
int16_t Inci
Enigma "incident" key type.
Definition Fundamentals.h:56
int32_t Evpu
EVPU value (288 per inch)
Definition Fundamentals.h:57
uint16_t Cmper
Enigma "comperator" key type.
Definition Fundamentals.h:55
int32_t Edu
"Enigma Durational Units" value (1024 per quarter note)
Definition Fundamentals.h:61
std::weak_ptr< Document > DocumentWeakPtr
Shared weak Document pointer.
Definition BaseClasses.h:57
int32_t EntryNumber
Entry identifier.
Definition Fundamentals.h:69
uint16_t NoteNumber
Note identifier.
Definition Fundamentals.h:70
int16_t StaffCmper
Enigma staff (staffId) Cmper (may be negative when not applicable)
Definition Fundamentals.h:65
std::vector< XmlElementDescriptor< T > > XmlElementArray
an array type for XmlElementDescriptor instances.
Definition XmlInterface.h:127
object model for musx file (enigmaxml)
Definition BaseClasses.h:36