81 Clef(
Base&
parent,
const std::string_view& key,
ClefSign clefSign,
int staffPosition, std::optional<OttavaAmountOrZero> octaveAdjustment = std::nullopt)
85 set_staffPosition(staffPosition);
86 if (octaveAdjustment.has_value()) {
87 set_octave(octaveAdjustment.value());
122 create_position(position);
155 create_position(position);
156 create_end(endMeasureId, endPosition);
190 create_clef(clefSign, staffPosition, octaveAdjustment);
205 using ArrayElementObject::ArrayElementObject;
233 using ArrayElementObject::ArrayElementObject;
Represents an MNX object that is included as an array element.
Definition BaseTypes.h:615
Represents an MNX array, encapsulating property access.
Definition BaseTypes.h:483
Base class wrapper for all MNX JSON nodes.
Definition BaseTypes.h:210
json_pointer pointer() const
Returns the json_pointer for this node.
Definition BaseTypes.h:271
T parent() const
Returns the parent object for this node.
Definition BaseTypes.h:258
const std::shared_ptr< json > & root() const
Returns the root.
Definition BaseTypes.h:288
Base class for objects that are elements of content arrays.
Definition BaseTypes.h:640
std::pair< NumType, NumType > Initializer
initializer for Fraction class (numerator, denominator)
Definition CommonClasses.h:43
Represents a system on a page in a score.
Definition CommonClasses.h:133
Represents an MNX object, encapsulating property access.
Definition BaseTypes.h:420
Represents a single part in an MNX document.
Definition Part.h:231
MNX_OPTIONAL_PROPERTY(std::string, name)
Specifies the user-facing full name of this part.
MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staves, 1)
The number of staves in this part.
MNX_OPTIONAL_PROPERTY(std::string, id)
Uniquely identifies the part.
MNX_OPTIONAL_PROPERTY(std::string, smuflFont)
Name of SMuFL-font for notation elements in the part (can be overridden by children)
MNX_OPTIONAL_PROPERTY(std::string, shortName)
Specifies the user-facing abbreviated name of this part.
MNX_OPTIONAL_CHILD(Array< part::Measure >, measures)
Contains all the musical data for this part.
Represents a system on a page in a score.
Definition CommonClasses.h:105
Contains information about each level of bea.
Definition Part.h:40
Beam(Base &parent, const std::string_view &key)
Creates a new Beam class as a child of a JSON element.
Definition Part.h:51
MNX_OPTIONAL_CHILD(Array< Beam >, beams)
the beams that comprise the next beam level (may be omitted)
MNX_REQUIRED_CHILD(Array< std::string >, events)
the events that comprise this beam level
Beam(const std::shared_ptr< json > &root, json_pointer pointer)
Constructor for existing Beam objects.
Definition Part.h:43
MNX_OPTIONAL_PROPERTY(BeamHookDirection, direction)
the forced direction of a beam hook (if this beam contains one event).
Represents a visible clef in the measure.
Definition Part.h:67
MNX_OPTIONAL_PROPERTY(std::string, color)
color to use when rendering the ending
MNX_OPTIONAL_NAMED_PROPERTY(std::string, styleClass, "class")
style class
MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(bool, showOctave, true)
if octave is non-zero, this value determines whether the octave should be displayedon the clef
Clef(Base &parent, const std::string_view &key, ClefSign clefSign, int staffPosition, std::optional< OttavaAmountOrZero > octaveAdjustment=std::nullopt)
Creates a new Clef class as a child of a JSON element.
Definition Part.h:81
MNX_REQUIRED_PROPERTY(ClefSign, sign)
the clef sign
MNX_OPTIONAL_PROPERTY(std::string, glyph)
the specific SMuFL glyph to use for rendering the clef
MNX_REQUIRED_PROPERTY(int, staffPosition)
staff position offset from center of staff (in half-spaces)
Clef(const std::shared_ptr< json > &root, json_pointer pointer)
Constructor for existing Clef instances.
Definition Part.h:70
MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(OttavaAmountOrZero, octave, OttavaAmountOrZero::NoTransposition)
the number of octaves by which the clef transposes
Represents a dynamic positioned with the next event in the sequence.
Definition Part.h:105
MNX_REQUIRED_PROPERTY(std::string, value)
The value of the dynamic. Currently the MNX spec allows any string here.
MNX_OPTIONAL_PROPERTY(std::string, glyph)
The SMuFL glyph name (if any)
MNX_REQUIRED_CHILD(RhythmicPosition, position)
The rhythmic position of the dynamic within the measure.
MNX_OPTIONAL_PROPERTY(std::string, voice)
Optionally specify the voice this dynamic applies to.
Dynamic(const std::shared_ptr< json > &root, json_pointer pointer)
Constructor for existing Space objects.
Definition Part.h:108
Dynamic(Base &parent, const std::string_view &key, const std::string &value, const Fraction::Initializer &position)
Creates a new Space class as a child of a JSON element.
Definition Part.h:118
MNX_OPTIONAL_PROPERTY(int, staff)
The staff (within the part) this dynamic applies to.
Represents a single measuer in a part in an MNX document. It contains the majority of the musical inf...
Definition Part.h:203
MNX_OPTIONAL_CHILD(Array< PositionedClef >, clefs)
the clef changes in this bar
MNX_OPTIONAL_CHILD(Array< Dynamic >, dynamics)
the dynamics in this measure
MNX_OPTIONAL_CHILD(Array< Ottava >, ottavas)
the ottavas in this measure
Measure(Base &parent, const std::string_view &key)
Creates a new Measure class as a child of a JSON element.
Definition Part.h:210
MNX_REQUIRED_CHILD(Array< Sequence >, sequences)
sequences that contain all the musical details in each measure
MNX_OPTIONAL_CHILD(Array< Beam >, beams)
the beams in this measure
Represents an ottava starting with the next event in the sequence.
Definition Part.h:137
MNX_OPTIONAL_PROPERTY(std::string, voice)
Optionally specify the voice this ottava applies to.
MNX_REQUIRED_CHILD(MeasureRhythmicPosition, end)
Ottava(const std::shared_ptr< json > &root, json_pointer pointer)
Constructor for existing Space objects.
Definition Part.h:140
MNX_REQUIRED_PROPERTY(OttavaAmount, value)
The type of ottava (amount of displacement, in octaves)
MNX_REQUIRED_CHILD(RhythmicPosition, position)
The start position of the ottava.
Ottava(Base &parent, const std::string_view &key, OttavaAmount value, const Fraction::Initializer &position, int endMeasureId, const Fraction::Initializer &endPosition)
Creates a new Space class as a child of a JSON element.
Definition Part.h:152
MNX_OPTIONAL_PROPERTY(int, staff)
The staff (within the part) this ottava applies to.
Represents a positioned clef for the measure.
Definition Part.h:173
MNX_OPTIONAL_CHILD(RhythmicPosition, position)
location within the measure of the tempo marking
MNX_REQUIRED_CHILD(Clef, clef)
the beats per minute of this tempo marking
PositionedClef(Base &parent, const std::string_view &key, ClefSign clefSign, int staffPosition, std::optional< OttavaAmountOrZero > octaveAdjustment=std::nullopt)
Creates a new PositionedClef class as a child of a JSON element.
Definition Part.h:187
MNX_OPTIONAL_PROPERTY_WITH_DEFAULT(int, staff, 1)
the staff number (for multistaff parts)
PositionedClef(const std::shared_ptr< json > &root, json_pointer pointer)
Constructor for existing PositionedClef instances.
Definition Part.h:176
object model for MNX format
ClefSign
The values available in a clef sign object.
Definition Enumerations.h:94
OttavaAmount
Valid values for ottava amount.
Definition Enumerations.h:212
json::json_pointer json_pointer
JSON pointer class for MNX.
Definition BaseTypes.h:197
OttavaAmountOrZero
Valid values for octave displacment amount, including zero for no transposition.
Definition Enumerations.h:231
@ NoTransposition
No transposition.
BeamHookDirection
The types of jumps.
Definition Enumerations.h:71