ARTHead.h

#ifndef ARTHead_H
#define ARTHead_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 <string>
 
#include "ARMTParameter.h"
#include "ARPositionTag.h"
 
/*@mkdoc
 
@group:Notes
 
@tagname:\headsCenter
@tagtype:RP
@tagnotation:moves the notehead centered on the stem
@tagdesc
The **\headsCenter** tag supports both a range and a position form.
For the latter, it is is applied up to the next *head* specification or to the end of the voice.
 
See the [notes](@EXAMPLES/notes/) example.
@tagend
 
@tagname:\headsLeft
@tagtype:RP
@tagnotation:force the notehead to the left of the stem
@tagdesc
The **\headsLeft** tag supports both a range and a position form.
For the latter, it is is applied up to the next *head* specification or to the end of the voice.
 
See the [notes](@EXAMPLES/notes/) example.
@tagend
 
@tagname:\headsRight
@tagtype:RP
@tagnotation:force the notehead to the right of the stem
@tagdesc
The **\headsRight** tag supports both a range and a position form.
For the latter, it is is applied up to the next *head* specification or to the end of the voice.
 
See the [notes](@EXAMPLES/notes/) example.
@tagend
 
@tagname:\headsNormal
@tagtype:RP
@tagnotation:cancel a previous *head* specification and reverts to normal head position.
@tagdesc
The **\headsNormal** tag supports both a range and a position form.
For the latter, it is is applied up to the next *head* specification or to the end of the voice.
@tagend
 
@tagname:\headsReverse
@tagtype:RP
@tagnotation:moves the notehead on the opposite side of the normal position
@tagdesc
The **\headsReverse** tag supports both a range and a position form.
For the latter, it is is applied up to the next *head* specification or to the end of the voice.
@tagend
 
*/
 
class ARTHead : public ARMTParameter, public ARPositionTag
{
    public:
        enum HEADSTATE { NOTSET, NORMAL, REVERSE, CENTER,  RIGHT, LEFT };
 
                 ARTHead(int st = ARTHead::NOTSET, const ARTHead * p_savehead = NULL, const ARTHead * p_copyhead = NULL);
                 ARTHead(const ARTHead & arthead);
        virtual ~ARTHead() { }
 
        ARMusicalObject * Copy() const              { return new ARTHead(*this); }
 
        virtual bool IsStateTag() const             { return true; }
        virtual const char* getTagName() const      { return "ARTHead"; };
        virtual std::string getGMNName() const;
 
        virtual const HEADSTATE getHeadState() const    { return  fHeadState; }
        virtual ARMusicalObject * getEndTag() const     { return new ARTHead(NOTSET,NULL,fSavedHead);   }
 
    private:
        const ARTHead * fSavedHead;
        HEADSTATE       fHeadState;
};
 
#endif