functionmark.h

Go to the documentation of this file.

#ifndef FUNCTIONMARK_H_
#define FUNCTIONMARK_H_

#include <QList>
#include <QString>

#include "core/muselement.h"
#include "core/diatonickey.h"
#include "core/functionmarkcontext.h"

class CAFunctionMark : public CAMusElement {
public:
        enum CAFunctionType {
                Undefined=0,// no degree - extend the previous one
                I=1,            // 1st
                II=2,           // 2nd
                III=3,          // 3rd
                IV=4,           // 4th
                V=5,            // 5th
                VI=6,           // 6th
                VII=7,          // 7th
                T=8,            // Tonic
                S=9,            // Subdominant
                D=10,           // Dominant
                F=11,           // Phrygian (F for Frigio in Italian)
                N=12,           // Napolitan
                L=13,           // Lidian
                K=14            // Cadenze chord (see http://en.wikipedia.org/wiki/Cadence_%28music%29)
        };
        
        // addedDegrees and alteredDegrees are generated from alterations parameter
        CAFunctionMark(CAFunctionType function, bool minor, const CADiatonicKey key, CAFunctionMarkContext* context, int timeStart, int timeLength, CAFunctionType chordArea=Undefined, bool chordAreaMinor=false, CAFunctionType tonicDegree=T, bool tonicDegreeMinor=false, const QString alterations="", bool ellipseSequence=false);
        CAFunctionMark* clone(CAContext* context=0);
        void clear(); // same as in CASyllable
        ~CAFunctionMark();
        inline CAFunctionMarkContext *fmContext() { return static_cast<CAFunctionMarkContext*>(context()); }
        
        CAFunctionType function() { return _function; }
        CADiatonicKey key() { return _key; }
        CAFunctionType chordArea() { return _chordArea; }
        CAFunctionType tonicDegree() { return _tonicDegree; }
        QList<int> alteredDegrees() { return _alteredDegrees; }
        QList<int> addedDegrees() { return _addedDegrees; }
        void setFunction(CAFunctionType function) { _function = function; }
        void setKey(CADiatonicKey key) { _key = key; }
        void setChordArea(CAFunctionType chordArea) { _chordArea = chordArea; }
        void setChordAreaMinor(bool minor) { _chordAreaMinor = minor; }
        void setTonicDegree(CAFunctionType tonicDegree) { _tonicDegree = tonicDegree; }
        void setTonicDegreeMinor(bool minor) { _tonicDegreeMinor = minor; }
        void setAlteredDegrees(QList<int> degrees) { _alteredDegrees = degrees; }
        void setAddedDegrees(QList<int> degrees) { _addedDegrees = degrees; }
        void setMinor(bool minor) { _minor = minor; }
        void setEllipse(bool ellipse) { _ellipseSequence = ellipse; }
        void setAlterations(const QString alterations);
        
        inline bool isEmpty() { return (function()==Undefined && chordArea()==Undefined && tonicDegree()==T && !alteredDegrees().size() && !addedDegrees().size()); }
        bool isSideDegree();
        
        bool isMinor() { return _minor; }
        bool isChordAreaMinor() { return _chordAreaMinor; }
        bool isTonicDegreeMinor() { return _tonicDegreeMinor; }
        bool isPartOfEllipse() { return _ellipseSequence; }
        
        int compare(CAMusElement *function);
        
        static const QString functionTypeToString(CAFunctionType);
        static CAFunctionType functionTypeFromString(const QString);
        
private:
        CAFunctionType _function;       // Function name
        CADiatonicKey _key;                 // C for C-Major, g for g-minor, bes for b-flat-minor, Fis for F-sharp-Major etc.
        CAFunctionType _chordArea;      // Side degrees have undetermined chord locations (eg. 6th can be treated as chord of Subdominant or Tonic)
        bool _chordAreaMinor;           // Is chord area minor?
        CAFunctionType _tonicDegree;    // Used when doing tonicization (see http://en.wikipedia.org/wiki/Tonicization). This value is always set if the function name is set.
        bool _tonicDegreeMinor;         // Is tonic degree minor?
        QList<int> _alteredDegrees;     // Degree of the chord which are altered according to the current key. These marks are usually written below the function name, eg. -3, -7 for German chord
        QList<int> _addedDegrees;       // Degrees of the chord which are added to or substracted from the basic. eg. sixte ajoutée in cadence
        bool _minor;                    // Should the function have a circle drawn?
        bool _ellipseSequence;          // Function is part of ellipse?
};
#endif /* FUNCTIONMARK_H_ */