ARTuplet.h

#ifndef ARTuplet_H
#define ARTuplet_H
 
/*
  GUIDO Library
  Copyright (C) 2002  Holger Hoos, Juergen Kilian, Kai Renz
  Copyright (C) 2004 Grame
 
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr
 
*/
 
#include <string>
 
#include "ARMTParameter.h"
#include "ARPositionTag.h"
#include "TagParameterFloat.h"
 
class ARBase;
class TagParameterString;
 
/*@mkdoc
 
@group:Notes
 
@tagname:\tuplet
@tagalias:
@tagtype:R
@tagnotation:control tuplets format
@tagdesc
@tagend
 
@params:
@param:format:string:a format string for shape control:*none*:false
@param:position:string:below or above:above:true
@param:dy1:unit:displacement of the left anchor point:0:true
@param:dy2:unit:displacement of the right anchor point:0:true
@param:lineThickness:float:the tuplet line thickness (if any):4:true
@param:bold:boolean:to use bold font:false:true
@param:textSize:float:the text size:1:true
@param:dispNote:string:a note duration:*none*:true
@paramdesc
- the **format** string must be in "x", "-x-", "x:y", "-x:y-", or "--"
where 'x' and 'y' are the numbers and '-' denotes the presence of left and right tuplet braces.
- **textSize** is a ratio: 1 is for nominal size
- **dispNote** is similar to [\displayDuration](#displayduration): it forces the notes appearance whatever their duration. The **dispNote** string must be in the form "/n", where n is a number (e.g. "/16" to display sixteenth notes)
 
See the [notes](@EXAMPLES/notes/) example.
@paramend
 
*/
 
#define kDefaultThickness   4.f
 
class ARTuplet :  public ARMTParameter, public ARPositionTag
{
    public:
                        ARTuplet(); 
        virtual        ~ARTuplet() {}
 
                void        setAuto();
        const std::string   getName() const { return fTupletFormat; }
 
        virtual void  setTagParameters (const TagParameterMap& params);
 
        virtual const char* getParamsStr() const    { return kARTupletParams; };
        virtual const char* getTagName() const      { return "ARTuplet"; };
        virtual std::string getGMNName() const      { return "\\tuplet"; };
        virtual bool MatchEndTag(const char * s);
 
            void  setupTuplet( ARBase * inBase );
            void  parseTupletFormatString();
 
            int   getNumerator()    const { return fBaseNumerator; }
            int   getDenominator()  const { return fBaseDenominator; }
 
            int  isPositionAbove() const;
            float getDy1()          const { return fDy1 ? fDy1->getValue() : 0.f; }
            float getDy2()          const { return fDy2 ? fDy2->getValue() : 0.f; }
            float getThickness()    const { return fLineThickness; }
            float defaultThickness()const { return kDefaultThickness; }
            bool  isTextBold()      const { return fTextBold; }
            float getTextSize()     const { return fTextSize; }
            bool  getLeftBrace()    const { return fLeftBrace; }
            bool  getRightBrace()   const { return fRightBrace; }
            const std::string& getDispNote()  const { return fDispNote; }
            bool  isDySet()         const { return (fDy1 && fDy1->TagIsSet()) || (fDy2 && fDy2->TagIsSet()); }
 
    protected:
        std::string fTupletFormat;  // format string <"-x:y-">
        const TagParameterString* fPosition;
        const TagParameterFloat* fDy1;
        const TagParameterFloat* fDy2;
        float       fLineThickness;
        bool        fTextBold;
        float       fTextSize;
        std::string fDispNote;
 
        int   fBaseNumerator;
        int   fBaseDenominator;
        bool  fLeftBrace;
        bool  fRightBrace;
};
 
#endif