mnx::part::Clef Class Reference

Represents a visible clef in the measure. More...

#include <Part.h>

Inheritance diagram for mnx::part::Clef:

Public Member Functions
	Clef (const std::shared_ptr< json > &root, json_pointer pointer)
	Constructor for existing Clef instances.
	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.
	MNX_OPTIONAL_NAMED_PROPERTY (std::string, styleClass, "class")
	style class
	MNX_OPTIONAL_PROPERTY (std::string, color)
	color to use when rendering the ending
	MNX_OPTIONAL_PROPERTY (std::string, glyph)
	the specific SMuFL glyph to use for rendering the clef
	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (OttavaAmountOrZero, octave, OttavaAmountOrZero::NoTransposition)
	the number of octaves by which the clef transposes
	MNX_OPTIONAL_PROPERTY_WITH_DEFAULT (bool, showOctave, true)
	if octave is non-zero, this value determines whether the octave should be displayedon the clef
	MNX_REQUIRED_PROPERTY (ClefSign, sign)
	the clef sign
	MNX_REQUIRED_PROPERTY (int, staffPosition)
	staff position offset from center of staff (in half-spaces)
Public Member Functions inherited from mnx::Object
	Object (const std::shared_ptr< json > &root, json_pointer pointer)
	Wraps an Object class around an existing JSON object node.
	Object (Base &parent, const std::string_view &key)
	Creates a new Object class as a child of a JSON node.
Public Member Functions inherited from mnx::Base
	Base (const Base &src)
	Copy constructor.
	Base (Base &&src) noexcept
	Move constructor.
Base &	operator= (const Base &src)
	Copy assignment operator.
Base &	operator= (Base &&src)
	Move assignment operator.
std::string	dump (int indents=-1)
	Dumps the branch to a string. Useful in debugging.
template<typename T >
T	parent () const
	Returns the parent object for this node.
template<typename T >
std::optional< T >	getEnclosingElement () const
	Returns the enclosing array element for this instance.
json_pointer	pointer () const
	Returns the json_pointer for this node.

Additional Inherited Members
Protected Member Functions inherited from mnx::Base
json &	ref () const
	Convert this node for retrieval.
json &	ref ()
	Access the JSON node for modification.
const std::shared_ptr< json > &	root () const
	Returns the root.
	Base (const std::shared_ptr< json > &root, json_pointer pointer)
	Wrap a Base instance around a specific JSON reference using a json_pointer.
	Base (json &&jsonRef, Base &parent, const std::string_view &key)
	Construct a Base reference as a child inside a parent node.
template<typename T >
T	getChild (const std::string_view &key) const
	Retrieves and validates a required child node.
template<typename T >
T	setChild (const std::string_view &key, const T &value)
	Sets a child node.
template<typename T >
std::optional< T >	getOptionalChild (const std::string_view &key) const
	Retrieves an optional child node.

Detailed Description

Represents a visible clef in the measure.

Constructor & Destructor Documentation

Clef()

mnx::part::Clef::Clef ( Base &  parent, const std::string_view &  key, ClefSign  clefSign, int  staffPosition, std::optional< OttavaAmountOrZero >  octaveAdjustment = std::nullopt  )

inline

Creates a new Clef class as a child of a JSON element.

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.
staffPosition	The note value base for this Barline
clefSign	The type of clef symbold
octaveAdjustment	The number of octaves by which the clef transposes (may be omitted)