tuplet.h

// Name:        tuplet.h
// Author:      Rodolfo Zitellini
// Created:     26/06/2012
// Copyright (c) Authors and others. All rights reserved.
 
#ifndef __VRV_TUPLET_H__
#define __VRV_TUPLET_H__
 
#include "atts_cmn.h"
#include "atts_shared.h"
#include "atts_visual.h"
#include "layerelement.h"
 
namespace vrv {
 
class Note;
class TupletBracket;
 
// Helper enum classes
enum class MelodicDirection { None, Up, Down };
 
//----------------------------------------------------------------------------
// Tuplet
//----------------------------------------------------------------------------
 
class Tuplet : public LayerElement,
               public ObjectListInterface,
               public AttColor,
               public AttDurationRatio,
               public AttNumberPlacement,
               public AttTupletVis {
public:
    Tuplet();
    virtual ~Tuplet();
    Object *Clone() const override { return new Tuplet(*this); }
    void Reset() override;
    std::string GetClassName() const override { return "tuplet"; }
 
    bool IsSupportedChild(ClassId classId) override;
 
    void AddChild(Object *object) override;
 
    LayerElement *GetDrawingLeft() { return m_drawingLeft; }
    const LayerElement *GetDrawingLeft() const { return m_drawingLeft; }
    void SetDrawingLeft(LayerElement *drawingLeft) { m_drawingLeft = drawingLeft; }
    LayerElement *GetDrawingRight() { return m_drawingRight; }
    const LayerElement *GetDrawingRight() const { return m_drawingRight; }
    void SetDrawingRight(LayerElement *drawingRight) { m_drawingRight = drawingRight; }
    data_STAFFREL_basic GetDrawingBracketPos() const { return m_drawingBracketPos; }
    void SetDrawingBracketPos(data_STAFFREL_basic bracketPos) { m_drawingBracketPos = bracketPos; }
    data_STAFFREL_basic GetDrawingNumPos() const { return m_drawingNumPos; }
    void SetDrawingNumPos(data_STAFFREL_basic numPos) { m_drawingNumPos = numPos; }
 
    Beam *GetBracketAlignedBeam() { return m_bracketAlignedBeam; }
    const Beam *GetBracketAlignedBeam() const { return m_bracketAlignedBeam; }
    void SetBracketAlignedBeam(Beam *alignedBeam) { m_bracketAlignedBeam = alignedBeam; }
    Beam *GetNumAlignedBeam() { return m_numAlignedBeam; }
    const Beam *GetNumAlignedBeam() const { return m_numAlignedBeam; }
    void SetNumAlignedBeam(Beam *alignedBeam) { m_numAlignedBeam = alignedBeam; }
 
    const std::set<const FloatingCurvePositioner *> &GetInnerSlurs() const { return m_innerSlurs; }
    void AddInnerSlur(const FloatingCurvePositioner *slur) { m_innerSlurs.insert(slur); }
    void ResetInnerSlurs() { m_innerSlurs.clear(); }
 
    MelodicDirection GetMelodicDirection() const;
 
    void CalcDrawingBracketAndNumPos(bool tupletNumHead);
 
    void GetDrawingLeftRightXRel(int &xRelLeft, int &xRelRight, const Doc *doc) const;
 
    void CalculateTupletNumCrossStaff(LayerElement *layerElement);
 
    bool HasValidTupletNumPosition(const Staff *preferredStaff, const Staff *otherStaff) const;
 
    //----------//
    // Functors //
    //----------//
 
    FunctorCode Accept(Functor &functor) override;
    FunctorCode Accept(ConstFunctor &functor) const override;
    FunctorCode AcceptEnd(Functor &functor) override;
    FunctorCode AcceptEnd(ConstFunctor &functor) const override;
 
protected:
    void FilterList(ListOfConstObjects &childList) const override;
 
private:
    //
public:
    //
private:
    LayerElement *m_drawingLeft;
    LayerElement *m_drawingRight;
    data_STAFFREL_basic m_drawingBracketPos;
    data_STAFFREL_basic m_drawingNumPos;
    Beam *m_bracketAlignedBeam;
    Beam *m_numAlignedBeam;
    std::set<const FloatingCurvePositioner *> m_innerSlurs;
};
 
} // namespace vrv
 
#endif