ARTStem.h

#ifndef ARTStem_H
#define ARTStem_H
 
/*
  GUIDO Library
  Copyright (C) 2002  Holger Hoos, Juergen Kilian, Kai Renz
  Copyright (C) 2002-2017 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 "ARMTParameter.h"
#include "ARPositionTag.h"
 
class TagParameterFloat;
 
 
/*@mkdoc
 
@group:Notes
 
@tagname:\stemsOff
@tagalias:
@tagtype:P
@tagnotation:disable stems drawing
@tagdesc
See the [notes](@EXAMPLES/notes/) example.
@tagend
 
@tagname:\stemsAuto
@tagalias:
@tagtype:P
@tagnotation:cancel \stemsOff and enable automatic stems direction
@tagdesc
@tagend
@params:
@param:length:unit:the stem length:7.0:true
@paramdesc
See the [notes](@EXAMPLES/notes/) example.
@paramend
 
@tagname:\stemsDown
@tagalias:
@tagtype:P
@tagnotation:force stem direction to down
@tagdesc
@tagend
@params:
@param:length:unit:the stem length:7.0:true
@paramdesc
See the [4 voices](@EXAMPLES/4voices/) example. <br />
See the [notes](@EXAMPLES/notes/) example.
@paramend
 
@tagname:\stemsUp
@tagalias:
@tagtype:P
@tagnotation:force stem direction to up
@tagdesc
@tagend
@params:
@param:length:unit:the stem length:7.0:true
@paramdesc
See the [4 voices](@EXAMPLES/4voices/) example. <br />
See the [notes](@EXAMPLES/notes/) example.
@paramend
 
*/
 
 
class ARTStem : public ARMTParameter, public ARPositionTag
{
    public:
 
        enum STEMSTATE { UP ,DOWN ,AUTO, OFF };
 
        virtual bool IsStateTag() const { return true; }
 
                 ARTStem( int st = ARTStem::AUTO, const ARTStem * p_savestem = NULL, const ARTStem * p_copystem = NULL);
                 ARTStem(const ARTStem * tstem);
        virtual ~ARTStem() {}
 
 
        virtual ARMusicalObject * Copy() const      { return new ARTStem(this); }
 
        virtual const char* getParamsStr() const    { return kARTStemParams; };
        virtual const char* getTagName() const      { return "ARTStem"; };
        virtual std::string getGMNName() const;
 
        const TagParameterFloat *   getLength() const; // { return mTpfLength; }
        virtual const STEMSTATE     getStemState() const    { return mStemState; }
        virtual ARMusicalObject *   getEndTag() const       { return new ARTStem(AUTO, NULL, mSaveStem); }
 
    private:
        const ARTStem * mSaveStem;
        STEMSTATE mStemState;
};
 
#endif