lyricelement.h

// Name:        lyricelement.h
// Author:      Simon Waloschek
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_LYRICELEMENT_H__
#define __VRV_LYRICELEMENT_H__
 
#include "atts_shared.h"
#include "layerelement.h"
#include "offsetinterface.h"
 
#include <algorithm>
#include <utility>
 
namespace vrv {
 
class Syl;
class Volta;
 
//----------------------------------------------------------------------------
// LyricElement
//----------------------------------------------------------------------------
 
class LyricElement : public LayerElement,
                     public OffsetInterface,
                     public AttColor,
                     public AttLang,
                     public AttPlacementRelStaff,
                     public AttTypography,
                     public AttVoltaGroupingSym {
public:
    virtual ~LyricElement();
    void Reset() override;
 
    bool IsSupportedChild(ClassId classId) override;
 
    OffsetInterface *GetOffsetInterface() override { return vrv_cast<OffsetInterface *>(this); }
    const OffsetInterface *GetOffsetInterface() const override { return vrv_cast<const OffsetInterface *>(this); }
 
    int GetVoltaCount() const;
    std::pair<int, int> GetVoltaDrawingRange() const;
    bool HasDirectSyl() const;
    bool HasDrawingDirectSylTrack() const { return m_drawingDirectSylTrack || this->HasDirectSyl(); }
    void SetDrawingDirectSylTrack() const { m_drawingDirectSylTrack = true; }
    void ResetDrawingDirectSylTrack() { m_drawingDirectSylTrack = false; }
    int GetLyricLineCount() const;
    int GetVoltaLineN(const Volta *volta) const;
 
    int GetDrawingVerseN() const { return m_drawingVerseN; }
    void SetDrawingVerseN(int verseN) const { m_drawingVerseN = std::max(verseN, 1); }
    int GetDrawingLyricGroupN() const { return m_drawingLyricGroupN; }
    void SetDrawingLyricGroupN(int groupN) const { m_drawingLyricGroupN = std::max(groupN, 1); }
    void ResetDrawingLyricGroup()
    {
        m_drawingVerseN = 1;
        m_drawingLyricGroupN = 1;
        m_drawingDirectSylTrack = false;
    }
 
    int AdjustPosition(int &overlap, int freeSpace, const Doc *doc);
 
protected:
    explicit LyricElement(ClassId classId);
 
private:
    mutable int m_drawingVerseN;
    mutable int m_drawingLyricGroupN;
    mutable bool m_drawingDirectSylTrack;
};
 
} // namespace vrv
 
#endif