syl.h

// Name:        syl.h
// Author:      Laurent Pugin
// Created:     2014
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_SYL_H__
#define __VRV_SYL_H__
 
#include "atts_shared.h"
#include "facsimileinterface.h"
#include "layerelement.h"
#include "offsetinterface.h"
#include "timeinterface.h"
 
namespace vrv {
 
class Note;
class TextElement;
 
//----------------------------------------------------------------------------
// Syl
//----------------------------------------------------------------------------
 
class Syl : public LayerElement,
            public TextListInterface,
            public OffsetInterface,
            public TimeSpanningInterface,
            public AttLang,
            public AttTypography,
            public AttSylLog {
public:
    Syl();
    virtual ~Syl();
    Object *Clone() const override { return new Syl(*this); }
    void Reset() override;
    std::string GetClassName() const override { return "syl"; }
 
    bool IsRelativeToStaff() const override { return true; }
 
    OffsetInterface *GetOffsetInterface() override { return vrv_cast<OffsetInterface *>(this); }
    const OffsetInterface *GetOffsetInterface() const override { return vrv_cast<const OffsetInterface *>(this); }
    TimePointInterface *GetTimePointInterface() override { return vrv_cast<TimePointInterface *>(this); }
    const TimePointInterface *GetTimePointInterface() const override
    {
        return vrv_cast<const TimePointInterface *>(this);
    }
    TimeSpanningInterface *GetTimeSpanningInterface() override { return vrv_cast<TimeSpanningInterface *>(this); }
    const TimeSpanningInterface *GetTimeSpanningInterface() const override
    {
        return vrv_cast<const TimeSpanningInterface *>(this);
    }
 
    bool IsSupportedChild(ClassId classId) override;
 
    int CalcHyphenLength(Doc *doc, int staffSize);
 
    int CalcConnectorSpacing(Doc *doc, int staffSize);
 
    int GetDrawingWidth() const;
    int GetDrawingHeight() const;
 
    void SetDrawingTextInkBounds(int top, int bottom)
    {
        m_drawingTextInkTop = top;
        m_drawingTextInkBottom = bottom;
        m_hasDrawingTextInkBounds = true;
    }
    void ResetDrawingTextInkBounds() { m_hasDrawingTextInkBounds = false; }
    bool HasDrawingTextInkBounds() const { return m_hasDrawingTextInkBounds; }
    int GetDrawingTextInkTop() const { return m_drawingTextInkTop; }
    int GetDrawingTextInkBottom() const { return m_drawingTextInkBottom; }
 
    bool IsEmpty() const;
 
    //----------------//
    // Static methods //
    //----------------//
 
    static void AdjustToLyricSize(const Doc *doc, int &value);
 
    //----------//
    // Functors //
    //----------//
 
    FunctorCode Accept(Functor &functor) override;
    FunctorCode Accept(ConstFunctor &functor) const override;
    FunctorCode AcceptEnd(Functor &functor) override;
    FunctorCode AcceptEnd(ConstFunctor &functor) const override;
 
    bool CreateDefaultZone(Doc *doc);
 
private:
    //
public:
    int m_drawingVerseN;
    int m_drawingVoltaN;
    data_STAFFREL m_drawingVersePlace;
 
    Syl *m_nextWordSyl;
 
private:
    int m_drawingTextInkTop;
    int m_drawingTextInkBottom;
    bool m_hasDrawingTextInkBounds;
};
 
} // namespace vrv
 
#endif