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

Key notation tag. More...

Inheritance diagram for GRKey:
GRARCompositeNotationElement GRTag GRARNotationElement GRNotationElement GObject GRVisitable

Public Member Functions

virtual bool operator== (const GRKey &key) const
 
virtual bool operator== (const GRTag &tag) const
 
 GRKey (GRStaff *staff, const ARKey *arkey, int p_natural, bool ownsAR)
 
virtual ~GRKey ()
 
virtual void accept (GRVisitor &visitor)
 
virtual void setGRStaff (GRStaff *stf)
 
int getKeyArray (float *KeyArray)
 
void getOctArray (int *ctArray)
 
virtual void updateBoundingBox ()
 
virtual void setHPosition (GCoord nx)
 
virtual void setPosition (const NVPoint &point)
 
virtual void OnDraw (VGDevice &dev) const
 
virtual void recalcVerticalPosition ()
 
- Public Member Functions inherited from GRARCompositeNotationElement
 GRARCompositeNotationElement (const ARMusicalObject *ar, bool ownsAR=false)
 
virtual ~GRARCompositeNotationElement ()
 
virtual void addToOffset (const NVPoint &inOfset)
 
GuidoPos First () const
 
GuidoPos Last () const
 
GRNotationElementGetNext (GuidoPos &ioPos) const
 
GRNotationElementGetTail () const
 
GuidoPos AddTail (GRNotationElement *el)
 
void RemoveElement (GRNotationElement *el)
 
void DrawSubElements (VGDevice &hdc) const
 
void GetSubElementsMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
 
void RemoveAllSubElements ()
 
GuidoPos SetTailPosition (GuidoPos pos)
 
NEPointerListGetCompositeElements ()
 
const NEPointerListGetCompositeElements () const
 
- Public Member Functions inherited from GRARNotationElement
 GRARNotationElement (const ARMusicalObject *abstractRepresentationOfNotationElement, bool p_ownsAR=false)
 
virtual ~GRARNotationElement ()
 
virtual const ARMusicalObjectgetAbstractRepresentation ()
 
virtual const ARMusicalObjectgetAbstractRepresentation () const
 
virtual void setOwnership (bool ownsAR)
 
virtual bool isChordComma () const
 
- Public Member Functions inherited from GRNotationElement
 GRNotationElement ()
 
virtual ~GRNotationElement ()
 
GRStaffgetGRStaff () const
 
GRSystemSlicegetGRSystemSlice () const
 
virtual int getStaffNumber () const
 
virtual void tellPosition (GObject *caller, const NVPoint &point)
 
virtual float getLeftSpace () const
 
virtual float getRightSpace () const
 
virtual void setLeftSpace (float lspace)
 
virtual void setRightSpace (float rspace)
 
virtual void setNeedsSpring (int inFlag)
 
virtual int getNeedsSpring () const
 
virtual int getSpringID () const
 
virtual void tellSpringID (int inSpringID)
 
NEPointerListgetAssociations ()
 
const NEPointerListgetAssociations () const
 
virtual void removeAssociation (const NEPointerList &nl)
 
virtual void removeAssociation (GRNotationElement *el)
 
void FreeAssociatedList ()
 
virtual NVPoint getTieEnd () const
 
virtual NVPoint getTieStart () const
 
virtual NVRect getAssociatedBoundingBox () const
 
void addToBoundingBox (GRNotationElement *in)
 
void OnDrawSymbol (VGDevice &hdc, unsigned int inSymbol, float inOffsetX=0, float inOffsetY=0, float inFontSize=0) const
 
void OnDrawText (VGDevice &hdc, NVPoint pos, const char *cp, int inCharCount=-1) const
 
void OnDrawText (VGDevice &hdc, const char *cp, int inCharCount=-1) const
 
void DrawSymbol (VGDevice &hdc, unsigned int inSymbol, float x=0, float y=0, float size=0) const
 
void DrawNumericSymbols (VGDevice &hdc, const char *symbols, float x, float y, float size, float spacing=DEFAULTNUMERICSPACE) const
 
void Show (bool status)
 
bool GetShow () const
 
virtual void SendMap (const NVRect &r, MapCollector &f, TYPE_TIMEPOSITION date, TYPE_DURATION dur, GuidoElementType type, MapInfos &infos) const
 
virtual void SendMap (MapCollector &f, TYPE_TIMEPOSITION date, TYPE_DURATION dur, GuidoElementType type, MapInfos &infos) const
 
virtual unsigned int getTextAlign () const
 
virtual const TYPE_DURATIONgetDuration () const
 
virtual void setDuration (const TYPE_TIMEPOSITION &dur)
 
virtual void setRelativeTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual void setRelativeEndTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual const TYPE_TIMEPOSITIONgetRelativeTimePosition () const
 
virtual void setDrawOnOff (bool onoff)
 
virtual bool getDrawOnOff ()
 
virtual TYPE_TIMEPOSITION getRelativeEndTimePosition () const
 
virtual void addAssociation (GRNotationElement *grnot)
 
virtual void print (std::ostream &os) const
 
const NEPointerListassociated () const
 
virtual void setIsInHeader (bool state)
 
virtual bool isInHeader () const
 
virtual bool isEmpty () const
 
virtual bool isLyrics () const
 
virtual bool checkCollisionWith () const
 
virtual const GRTextisText () const
 
virtual const GRSingleNoteisSingleNote () const
 
virtual GRSingleNoteisSingleNote ()
 
virtual const GRNoteisGRNote () const
 
virtual const GRRestisRest () const
 
virtual const GREventisGREvent () const
 
virtual GREventisGREvent ()
 
virtual const GRGlueisGRGlue () const
 
virtual const GRTempoisGRTempo () const
 
virtual const GRTrillisGRTrill () const
 
virtual const GRBarisGRBar () const
 
virtual const GRDynamicsisGRDynamic () const
 
virtual GRFingeringisGRFingering ()
 
virtual GRSlurisGRSlur ()
 
virtual const GRHarmonyisGRHarmony () const
 
- Public Member Functions inherited from GObject
virtual ~GObject ()
 
virtual const NVPointgetOffset () const
 
virtual const char * getFont () const
 
virtual const char * getFontAttrib () const
 
virtual const unsigned char * getColRef () const
 
virtual int getFontSize () const
 
virtual float getSize () const
 
virtual const NVPointgetReferencePosition () const
 Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position. More...
 
const NVPointgetPosition () const
 
const NVRectgetBoundingBox () const
 
void addToBoundingBox (const NVRect &in)
 
NVRectgetReferenceBoundingBox ()
 
virtual bool isGREventClass () const
 
virtual void GetMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
 
virtual void DrawBoundingBox (VGDevice &hdc, const VGColor &inBrushColor) const
 
- Public Member Functions inherited from GRVisitable
virtual ~GRVisitable ()
 
- Public Member Functions inherited from GRTag
 GRTag (const ARMusicalTag *artag=0, float curLSPACE=50.0f)
 
virtual ~GRTag ()
 
virtual bool operator!= (const GRTag &tag) const
 
int getIsAuto () const
 
bool IsStateTag () const
 
virtual const NVPointgetOffset () const
 
virtual float getSize () const
 
virtual float getSConst () const
 
virtual const char * getFont () const
 
virtual const char * getFontAttrib () const
 
virtual int getFontSize () const
 
virtual const unsigned char * getColRef () const
 
virtual void setSConst (float val)
 
void setTagType (TAGTYPE ntyp)
 
TAGTYPE getTagType () const
 
void setError (int p_error)
 
int getError () const
 
virtual void StaffFinished (GRStaff *grstaff=0)
 
virtual void StaffBegin (GRStaff *grstaff=0)
 
virtual void RangeEnd (GRStaff *grstaff=0)
 

Static Public Member Functions

static int getNonFreeKeyArray (int pnumkeys, float *KeyArray)
 
- Static Public Member Functions inherited from GRNotationElement
static int ComparePos (const GRNotationElement *g1, const GRNotationElement *g2)
 
- Static Public Member Functions inherited from GObject
static bool positionIsOnStaffLine (float inPositionY, float inLSpace)
 
static float GetSymbolExtent (unsigned int inSymbol)
 

Protected Member Functions

virtual void createAccidentals ()
 
- Protected Member Functions inherited from GRNotationElement
void DrawExtents (VGDevice &hdc, const VGColor &inColor) const
 
- Protected Member Functions inherited from GObject
 GObject ()
 
 GObject (const GObject &in)
 

Protected Attributes

int mNatural
 
int mNumKeys
 
float mkarray [NUMNOTES]
 
int mOctarray [NUMNOTES]
 
float mCurLSPACE
 
- Protected Attributes inherited from GRARNotationElement
const ARMusicalObjectmAbstractRepresentation
 
bool mOwnsAR
 
- Protected Attributes inherited from GRNotationElement
unsigned int mSymbol
 
GRStaffmGrStaff
 
int mNeedsSpring
 
int mSpringID
 
float mLeftSpace
 
float mRightSpace
 
bool mDraw
 
bool mShow
 
bool mIsInHeader
 
TYPE_DURATION mDurationOfGR
 
NEPointerListmAssociated
 
- Protected Attributes inherited from GObject
NVPoint mPosition
 
NVRect mBoundingBox
 
NVRect mMapping
 
- Protected Attributes inherited from GRTag
int isautotag
 
float sconst
 
unsigned char * mColRef
 
std::string fFontName
 
std::string fFontAttrib
 
int fFontSize
 
float mTagSize
 
NVPoint mTagOffset
 

Additional Inherited Members

- Public Types inherited from GRTag
enum  TAGTYPE {
  VOICETAG, STAFFTAG, SYSTEMTAG, PAGETAG,
  VOICEANDSYSTEMTAG
}
 
- Static Protected Attributes inherited from GObject
static std::map< ConstMusicalSymbolID, float > sSymbolExtentMap
 
static NVPoint sRefposNone
 

Detailed Description

Key notation tag.

Constructor & Destructor Documentation

◆ GRKey()

GRKey::GRKey ( GRStaff staff,
const ARKey arkey,
int  p_natural,
bool  ownsAR 
)

◆ ~GRKey()

virtual GRKey::~GRKey ( )
virtual

Member Function Documentation

◆ accept()

virtual void GRKey::accept ( GRVisitor visitor)
virtual

Reimplemented from GRNotationElement.

◆ createAccidentals()

virtual void GRKey::createAccidentals ( )
protectedvirtual

◆ getKeyArray()

int GRKey::getKeyArray ( float *  KeyArray)

◆ getNonFreeKeyArray()

static int GRKey::getNonFreeKeyArray ( int  pnumkeys,
float *  KeyArray 
)
static

◆ getOctArray()

void GRKey::getOctArray ( int *  ctArray)

◆ OnDraw()

virtual void GRKey::OnDraw ( VGDevice dev) const
virtual

Reimplemented from GRNotationElement.

◆ operator==() [1/2]

virtual bool GRKey::operator== ( const GRKey key) const
virtual

◆ operator==() [2/2]

virtual bool GRKey::operator== ( const GRTag tag) const
virtual

Reimplemented from GRTag.

◆ recalcVerticalPosition()

virtual void GRKey::recalcVerticalPosition ( )
virtual

Reimplemented from GRNotationElement.

◆ setGRStaff()

virtual void GRKey::setGRStaff ( GRStaff stf)
virtual

Reimplemented from GRARCompositeNotationElement.

◆ setHPosition()

virtual void GRKey::setHPosition ( GCoord  nx)
virtual

Reimplemented from GRARCompositeNotationElement.

◆ setPosition()

virtual void GRKey::setPosition ( const NVPoint point)
virtual

Reimplemented from GRARCompositeNotationElement.

◆ updateBoundingBox()

virtual void GRKey::updateBoundingBox ( )
virtual

Reimplemented from GRARCompositeNotationElement.

Member Data Documentation

◆ mCurLSPACE

float GRKey::mCurLSPACE
protected

◆ mkarray

float GRKey::mkarray[NUMNOTES]
protected

◆ mNatural

int GRKey::mNatural
protected

◆ mNumKeys

int GRKey::mNumKeys
protected

◆ mOctarray

int GRKey::mOctarray[NUMNOTES]
protected

Guido Project Copyright © 2019 Grame-CNCM