GUIDOLib  1.7.7
Guido Engine Internal Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ARKey Class Reference

Key signature. More...

Inheritance diagram for ARKey:
ARMTParameter ARMusicalTag ARMusicalObject ARVisitable ARNaturalKey

Public Member Functions

 ARKey (const TYPE_TIMEPOSITION &timeposition)
 
 ARKey (int p_keynumber)
 
 ARKey ()
 
 ARKey (const ARKey &key)
 
virtual ~ARKey ()
 
virtual bool operator== (const ARKey &k) const
 
virtual bool IsStateTag () const
 
virtual int getOrder () const
 
virtual const char * getParamsStr () const
 
virtual const char * getTagName () const
 
virtual std::string getGMNName () const
 
virtual void setTagParameters (const TagParameterMap &params)
 
int getKeyNumber () const
 
void setKeyNumber (int newnumber)
 
bool hideAutoNaturals () const
 
bool isHideAutoNaturalsSet () const
 
bool freeKey () const
 
virtual void getOctArray (int *) const
 
virtual void getFreeKeyArray (float *) const
 
ARMusicalObjectisARKey ()
 
- Public Member Functions inherited from ARMTParameter
 ARMTParameter (const TYPE_TIMEPOSITION &tp, const ARMTParameter *copy=0)
 
 ARMTParameter (int pid=-1, const ARMTParameter *copy=0)
 
virtual ~ARMTParameter ()
 
- Public Member Functions inherited from ARMusicalTag
 ARMusicalTag (const TYPE_TIMEPOSITION &tp, const ARMusicalTag *copy=0)
 
 ARMusicalTag (int pid=-1, const ARMusicalTag *copy=0)
 
virtual ~ARMusicalTag ()
 
virtual void accept (ARVisitor &visitor)
 
virtual bool MatchEndTag (const char *endstr)
 
void setAllowRange (int pallow)
 
void setIsAuto (bool isauto)
 
bool getIsAuto () const
 
void print (std::ostream &os) const
 
void setAssociation (ASSOCIATION p_assoc)
 
ASSOCIATION getAssociation () const
 
virtual RANGE getRangeSetting () const
 
virtual void setError (int i=1)
 
virtual int getError () const
 
int getID () const
 
void setID (int pid)
 
virtual void setRange (bool p)
 
virtual bool getRange () const
 
void setColor (const char *cp)
 
void setRGBColor (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
 
void setSize (float newsize)
 
virtual const TagParameterFloatgetSize () const
 
const TagParameterStringgetColor () const
 
const TagParameterRGBColorgetRGBColor () const
 
const TagParameterFloatgetDX () const
 
const TagParameterFloatgetDY () const
 
const ARMusicalObjectisARMusicalTag () const
 
template<typename T >
const T * getParameter (const char *param, bool usedefault=false) const
 
template<typename T >
const T * getParameter (const char *name1, const char *name2) const
 
template<typename T >
const T * getDefaultParameter (const char *param) const
 
virtual void setTagParameters (TagParametersList &params)
 
virtual void clearTagDefaultParameter (const char *param)
 
virtual const TagParameterMapgetTagParameters () const
 
virtual const TagParameterMapgetSupportedTagParameters () const
 
virtual void addTagParameter (STagParameterPtr param)
 
virtual void copyParameters (const TagParameterMap &map)
 
virtual void setupTagParameters (const TagParameterMap &map)
 
virtual void setIsInHeader (bool state)
 
virtual bool isInHeader () const
 
- Public Member Functions inherited from ARMusicalObject
 ARMusicalObject ()
 
 ARMusicalObject (const TYPE_TIMEPOSITION &relativeTimepositionOfMusicalObject)
 
 ARMusicalObject (const ARMusicalObject &armo)
 
virtual ~ARMusicalObject ()
 
virtual ARMusicalObjectCopy () const
 
virtual const TYPE_DURATIONgetDuration () const
 
virtual const TYPE_TIMEPOSITIONgetRelativeTimePosition () const
 
virtual TYPE_TIMEPOSITION getRelativeEndTimePosition () const
 
virtual void setRelativeTimePosition (const TYPE_TIMEPOSITION &newRelativeTimePosition)
 
virtual void setRelativeEndTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual void setDuration (const TYPE_DURATION &dur)
 
virtual bool isEventClass () const
 
virtual void browse (TimeUnwrap &mapper) const
 
virtual int getVoiceNum () const
 
virtual void printGMNName (std::ostream &os) const
 
virtual void setVoiceNum (int num)
 
virtual void setDrawGR (bool on)
 
virtual bool getDrawGR () const
 
virtual ARMusicalObjectisARRepeatBegin ()
 
virtual ARNoteisARNote ()
 
virtual const ARNoteisARNote () const
 
virtual ARTabisARTab ()
 
virtual const ARTabisARTab () const
 
virtual ARMusicalObjectisARCoda ()
 
virtual ARMusicalObjectisARSegno ()
 
virtual ARMusicalObjectisARNewPage ()
 
virtual ARMusicalObjectisARNewSystem ()
 
virtual ARMusicalObjectisARNaturalKey ()
 
virtual ARMusicalObjectisARBeamState ()
 
virtual ARMusicalObjectisARClef ()
 
virtual ARMusicalObjectisARFinishBar ()
 
virtual ARMusicalObjectisARMeter ()
 
virtual ARMusicalObjectisARRepeatEnd ()
 
virtual ARMusicalObjectisARRest ()
 
virtual ARMusicalObjectisARSecondGlue ()
 
virtual ARMusicalObjectisARPossibleBreak ()
 
virtual AROctavaisAROctava ()
 
virtual ARGraceisARGrace ()
 
virtual ARSpaceisARSpace ()
 
virtual ARTempoisARTempo ()
 
virtual const ARMusicalObjectisARDummyRangeEnd () const
 
virtual const ARMusicalObjectisARNoteFormat () const
 
virtual const ARMusicalObjectisARBar () const
 
virtual const ARMusicalObjectisARStaff () const
 
virtual const ARMusicalObjectisARJump () const
 
virtual const ARMusicalObjectisARChordComma () const
 
virtual const ARMusicalObjectisARUserChordTag () const
 
virtual bool isEmptyNote () const
 
- Public Member Functions inherited from ARVisitable
 ARVisitable ()
 
virtual ~ARVisitable ()
 

Static Public Member Functions

static float getAccidental (const char *&ptr)
 
static int getNote (const char *&ptr)
 
- Static Public Member Functions inherited from ARMusicalObject
static bool IsPowerOfTwoDenom (const TYPE_DURATION &dur)
 

Protected Attributes

bool fHideAutoNaturals
 if true -> don't show auto generated naturals at key signature changes More...
 
bool fIsFree
 
bool fHideAutoNaturalsSet = false
 
int fKeyNumber
 
float fAccarray [NUMNOTES]
 
int fOctarray [NUMNOTES]
 
- Protected Attributes inherited from ARMusicalTag
int id
 
bool isAuto
 
ASSOCIATION assoc
 
RANGE rangesetting
 
int error
 
bool mHasRange
 
- Protected Attributes inherited from ARMusicalObject
TYPE_TIMEPOSITION relativeTimePosition
 
int fVoiceNum
 
bool fDrawGR = true
 

Additional Inherited Members

- Public Types inherited from ARMusicalTag
enum  ORDER {
  kDontMove =-1, kStartOrder, kStaffOrder, kInstrumentOrder,
  kClefOrder, kKeyOrder, kMeterOrder, kTitleOrder,
  kComposerOrder, kFooterOrder, kSystemFormatOrder, kAccoladeOrder,
  kDefaultOrder
}
 
enum  ASSOCIATION {
  LA, RA, DC, EL,
  ER
}
 
enum  RANGE { NO, ONLY, RANGEDC }
 
- Protected Member Functions inherited from ARMusicalTag
virtual TagParameterMap checkTagParameters (TagParametersList &params, const std::string pTemplate)
 
virtual void checkUnitParameters (TagParameterMap &map)
 

Detailed Description

Key signature.

Constructor & Destructor Documentation

◆ ARKey() [1/4]

ARKey::ARKey ( const TYPE_TIMEPOSITION timeposition)

◆ ARKey() [2/4]

ARKey::ARKey ( int  p_keynumber)

◆ ARKey() [3/4]

ARKey::ARKey ( )

◆ ARKey() [4/4]

ARKey::ARKey ( const ARKey key)

◆ ~ARKey()

virtual ARKey::~ARKey ( )
inlinevirtual

Member Function Documentation

◆ freeKey()

bool ARKey::freeKey ( ) const
inline

◆ getAccidental()

static float ARKey::getAccidental ( const char *&  ptr)
static

◆ getFreeKeyArray()

virtual void ARKey::getFreeKeyArray ( float *  ) const
virtual

◆ getGMNName()

virtual std::string ARKey::getGMNName ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ getKeyNumber()

int ARKey::getKeyNumber ( ) const
inline

◆ getNote()

static int ARKey::getNote ( const char *&  ptr)
static

◆ getOctArray()

virtual void ARKey::getOctArray ( int *  ) const
virtual

◆ getOrder()

virtual int ARKey::getOrder ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ getParamsStr()

virtual const char* ARKey::getParamsStr ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

Reimplemented in ARNaturalKey.

◆ getTagName()

virtual const char* ARKey::getTagName ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

Reimplemented in ARNaturalKey.

◆ hideAutoNaturals()

bool ARKey::hideAutoNaturals ( ) const
inline

◆ isARKey()

ARMusicalObject* ARKey::isARKey ( )
inlinevirtual

Reimplemented from ARMusicalObject.

◆ isHideAutoNaturalsSet()

bool ARKey::isHideAutoNaturalsSet ( ) const
inline

◆ IsStateTag()

virtual bool ARKey::IsStateTag ( ) const
inlinevirtual

Reimplemented from ARMusicalTag.

◆ operator==()

virtual bool ARKey::operator== ( const ARKey k) const
virtual

◆ setKeyNumber()

void ARKey::setKeyNumber ( int  newnumber)
inline

◆ setTagParameters()

virtual void ARKey::setTagParameters ( const TagParameterMap params)
virtual

Reimplemented from ARMusicalTag.

Member Data Documentation

◆ fAccarray

float ARKey::fAccarray[NUMNOTES]
protected

◆ fHideAutoNaturals

bool ARKey::fHideAutoNaturals
protected

if true -> don't show auto generated naturals at key signature changes

◆ fHideAutoNaturalsSet

bool ARKey::fHideAutoNaturalsSet = false
protected

◆ fIsFree

bool ARKey::fIsFree
protected

◆ fKeyNumber

int ARKey::fKeyNumber
protected

◆ fOctarray

int ARKey::fOctarray[NUMNOTES]
protected

Guido Project Copyright © 2019 Grame-CNCM