MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::options::TieOptions Class Reference

Options controlling the appearance of ties. More...

#include <Options.h>

+ Inheritance diagram for musx::dom::options::TieOptions:

Classes

struct  ConnectStyle
 Struct for tie connect style. More...
 
struct  ControlPoint
 Struct for tie control style control points. More...
 
struct  ControlStyle
 Struct for tie control style. More...
 

Public Types

enum class  SecondsPlacement { None , ShiftForSeconds }
 Enumeration for seconds placement options. More...
 
enum class  ChordTieDirType { OutsideInside , StemReversal , SplitEvenly }
 Enumeration for chord tie direction type. More...
 
enum class  MixedStemDirection { Over , Under , OppositeFirst }
 Enumeration for mixed stem direction. More...
 
enum class  SpecialPosMode { None , Avoid }
 Enumeration for special position mode. More...
 
enum class  InsetStyle { Fixed , Percent }
 Enumeration for inset styles. More...
 
enum class  ConnectStyleType {
  OverStartPosInner , OverEndPosInner , UnderStartPosInner , UnderEndPosInner ,
  OverHighestNoteStartPosOver , OverHighestNoteEndPosOver , UnderLowestNoteStartPosUnder , UnderLowestNoteEndPosUnder ,
  OverHighestNoteStemStartPosOver , OverHighestNoteStemEndPosOver , UnderLowestNoteStemStartPosUnder , UnderLowestNoteStemEndPosUnder
}
 Enumeration for tie connect style types.
 
enum class  ControlStyleType { ShortSpan , MediumSpan , LongSpan , TieEnds }
 Enumeration for tie control style types.
 
- 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

 TieOptions (const DocumentWeakPtr &document, Cmper partId=0, ShareMode shareMode=ShareMode::All)
 Constructor function.
 
- 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::PartDefinitiongetPartDefinition () const
 Gets the others::PartDefinition corresponding to getPartId.
 
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 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.
 
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< TieOptions > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

Evpu frontTieSepar {}
 Separation for the front of ties.
 
Evpu thicknessRight {}
 Right thickness of the tie.
 
Evpu thicknessLeft {}
 Left thickness of the tie.
 
bool breakForTimeSigs {}
 Break ties for time signatures.
 
bool breakForKeySigs {}
 Break ties for key signatures.
 
Evpu breakTimeSigLeftHOffset {}
 Left horizontal offset for breaking time signature.
 
Evpu breakTimeSigRightHOffset {}
 Right horizontal offset for breaking time signature.
 
Evpu breakKeySigLeftHOffset {}
 Left horizontal offset for breaking key signature.
 
Evpu breakKeySigRightHOffset {}
 Right horizontal offset for breaking key signature.
 
Evpu sysBreakLeftHAdj {}
 Left adjustment for system breaks.
 
Evpu sysBreakRightHAdj {}
 Right adjustment for system breaks.
 
bool useOuterPlacement {}
 Use outer placement for ties.
 
SecondsPlacement secondsPlacement {}
 Placement of seconds.
 
ChordTieDirType chordTieDirType {}
 Chord tie direction type.
 
bool chordTieDirOpposingSeconds {}
 Chord tie opposing seconds.
 
MixedStemDirection mixedStemDirection {}
 Mixed stem direction.
 
bool afterSingleDot {}
 Special handling after a single dot.
 
bool afterMultipleDots {}
 Special handling after multiple dots.
 
bool beforeAcciSingleNote {}
 Special handling before accidental single notes.
 
SpecialPosMode specialPosMode {}
 Special positioning mode.
 
Evpu avoidStaffLinesDistance {}
 Distance to avoid staff lines.
 
InsetStyle insetStyle {}
 Inset style for ties.
 
bool useInterpolation {}
 "Interpolate Height Between Short and Long Span"
 
bool useTieEndCtlStyle {}
 Use tie end control style.
 
bool avoidStaffLinesOnly {}
 Only avoid staff lines.
 
EvpuFloat tieTipWidth {}
 Width of the tie tip.
 
std::unordered_map< ConnectStyleType, std::shared_ptr< ConnectStyle > > tieConnectStyles
 Tie connect styles.
 
std::unordered_map< ControlStyleType, std::shared_ptr< ControlStyle > > tieControlStyles
 Tie control styles.
 

Static Public Attributes

static constexpr std::string_view XmlNodeName = "tieOptions"
 The XML node name for this type.
 

Additional Inherited Members

- Protected Member Functions inherited from musx::dom::OptionsBase
 OptionsBase (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
 Constructs the OptionsBase and validates XmlNodeName in the derived class.
 
- 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.
 
Baseoperator= (const Base &)
 assignment constructor: m_unlinkedNodes is intentionally omitted
 

Detailed Description

Options controlling the appearance of ties.

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

Member Enumeration Documentation

◆ ChordTieDirType

Enumeration for chord tie direction type.

Enumerator
OutsideInside 

Legacy Finale 3.7 behavior (the default)

StemReversal 

Split at stem reversal point.

SplitEvenly 

Split evenly.

◆ InsetStyle

Enumeration for inset styles.

Enumerator
Fixed 

the default

◆ MixedStemDirection

Enumeration for mixed stem direction.

Enumerator
OppositeFirst 

xml value is "start"

◆ SecondsPlacement

Enumeration for seconds placement options.

Enumerator
None 

the default

ShiftForSeconds 

xml value is "both"

◆ SpecialPosMode

Enumeration for special position mode.

Enumerator
None 

the default