neume.h

// Name:        neume.h
// Author:      Andrew Tran
// Created:     2017
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_NEUME_H__
#define __VRV_NEUME_H__
 
#include <cassert>
 
//----------------------------------------------------------------------------
 
#include "accid.h"
#include "atts_mensural.h"
#include "atts_shared.h"
#include "beam.h"
#include "chord.h"
#include "durationinterface.h"
#include "layerelement.h"
#include "offsetinterface.h"
 
namespace vrv {
 
class Accid;
class Chord;
class Slur;
class Tie;
class Verse;
class Neume;
 
//----------------------------------------------------------------------------
// Note
//----------------------------------------------------------------------------
 
enum NeumeGroup {
    NEUME_ERROR = 0,
    PUNCTUM,
    CLIVIS,
    PES,
    PRESSUS,
    CLIMACUS,
    PORRECTUS,
    SCANDICUS,
    TORCULUS,
    SCANDICUS_FLEXUS,
    PORRECTUS_FLEXUS,
    TORCULUS_RESUPINUS,
    CLIMACUS_RESUPINUS,
    PES_SUBPUNCTIS,
    PORRECTUS_SUBPUNCTIS,
    SCANDICUS_SUBPUNCTIS
};
 
class Neume : public LayerElement, public ObjectListInterface, public OffsetInterface, public AttColor {
public:
    Neume();
    virtual ~Neume();
    void Reset() override;
    Object *Clone() const override { return new Neume(*this); }
    std::string GetClassName() const override { return "neume"; }
 
    OffsetInterface *GetOffsetInterface() override { return vrv_cast<OffsetInterface *>(this); }
    const OffsetInterface *GetOffsetInterface() const override { return vrv_cast<const OffsetInterface *>(this); }
 
    bool IsSupportedChild(ClassId classId) override;
 
    int GetLigatureCount(int position);
    bool IsLastInNeume(const LayerElement *element) const;
 
    bool GenerateChildMelodic();
 
    NeumeGroup GetNeumeGroup() const;
 
    std::vector<int> GetPitchDifferences() const;
 
    PitchInterface *GetHighestPitch();
    PitchInterface *GetLowestPitch();
 
    FunctorCode Accept(Functor &functor) override;
    FunctorCode Accept(ConstFunctor &functor) const override;
    FunctorCode AcceptEnd(Functor &functor) override;
    FunctorCode AcceptEnd(ConstFunctor &functor) const override;
 
private:
    int GetPosition(const LayerElement *element) const;
 
public:
    //----------------//
    // Static members //
    //----------------//
 
    static const std::map<std::string, NeumeGroup> s_neumes;
 
    static std::string NeumeGroupToString(NeumeGroup group);
 
private:
};
} // namespace vrv
 
#endif