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

Graphial representation of a staff clef. More...

Inheritance diagram for GRClef:
GRTagARNotationElement GRTag GRARNotationElement GRNotationElement GObject GRVisitable

Public Member Functions

 GRClef (const ARClef *arClef, GRStaff *curstaff, bool ownsAR=false)
 
virtual ~GRClef ()
 
virtual bool operator== (const GRTag &tag) const
 
virtual bool operator== (const GRClef &clef) const
 
virtual void accept (GRVisitor &visitor)
 
virtual void OnDraw (VGDevice &hdc) const
 
virtual const NVPoint & getReferencePosition () const
 Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position. More...
 
virtual unsigned int getTextAlign () const
 
virtual bool checkCollisionWith () const
 
const ARClef * getARClef () const
 
TYPE_PITCH getBasePitch () const
 
TYPE_REGISTER getBaseOct () const
 
int getBaseLine () const
 
virtual void setHPosition (float inX)
 
virtual void GetMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
 
- Public Member Functions inherited from GRTagARNotationElement
 GRTagARNotationElement (const ARMusicalObject *el, float curLSPACE, bool ownsAR=false)
 
virtual ~GRTagARNotationElement ()
 
virtual const NVPoint & getOffset () const
 
virtual float getSize () const
 
virtual const char * getFont () const
 
virtual const char * getFontAttrib () const
 
virtual int getFontSize () const
 
virtual const unsigned char * getColRef () const
 
- 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 float getSConst () 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)
 
- Public Member Functions inherited from GRARNotationElement
 GRARNotationElement (const ARMusicalObject *abstractRepresentationOfNotationElement, bool p_ownsAR=false)
 
virtual ~GRARNotationElement ()
 
virtual const ARMusicalObject * getAbstractRepresentation ()
 
virtual const ARMusicalObject * getAbstractRepresentation () const
 
virtual void setOwnership (bool ownsAR)
 
virtual bool isChordComma () const
 
- Public Member Functions inherited from GRNotationElement
 GRNotationElement ()
 
virtual ~GRNotationElement ()
 
GRStaff * getGRStaff () const
 
virtual void setGRStaff (GRStaff *in)
 
GRSystemSlice * getGRSystemSlice () 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 setPosition (const NVPoint &newPosition)
 
virtual void setNeedsSpring (int inFlag)
 
virtual int getNeedsSpring () const
 
virtual int getSpringID () const
 
virtual void tellSpringID (int inSpringID)
 
NEPointerList * getAssociations ()
 
const NEPointerList * getAssociations () 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 const TYPE_DURATION & getDuration () 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_TIMEPOSITION & getRelativeTimePosition () const
 
virtual void setDrawOnOff (bool onoff)
 
virtual bool getDrawOnOff ()
 
virtual TYPE_TIMEPOSITION getRelativeEndTimePosition () const
 
virtual void recalcVerticalPosition ()
 
virtual void addAssociation (GRNotationElement *grnot)
 
virtual void print (std::ostream &os) const
 
const NEPointerList * associated () const
 
virtual void setIsInHeader (bool state)
 
virtual bool isInHeader () const
 
virtual bool isEmpty () const
 
virtual bool isLyrics () const
 
virtual const GRText * isText () const
 
virtual const GRSingleNote * isSingleNote () const
 
virtual GRSingleNote * isSingleNote ()
 
virtual const GRNote * isGRNote () const
 
virtual const GRRest * isRest () const
 
virtual const GREvent * isGREvent () const
 
virtual GREvent * isGREvent ()
 
virtual const GRGlue * isGRGlue () const
 
virtual const GRTempo * isGRTempo () const
 
virtual const GRTrill * isGRTrill () const
 
virtual const GRBar * isGRBar () const
 
virtual const GRDynamics * isGRDynamic () const
 
virtual GRFingering * isGRFingering ()
 
virtual GRSlur * isGRSlur ()
 
virtual const GRHarmony * isGRHarmony () const
 
- Public Member Functions inherited from GObject
virtual ~GObject ()
 
virtual void addToOffset (const NVPoint &)
 
const NVPoint & getPosition () const
 
const NVRect & getBoundingBox () const
 
void addToBoundingBox (const NVRect &in)
 
NVRect & getReferenceBoundingBox ()
 
virtual bool isGREventClass () const
 
virtual void DrawBoundingBox (VGDevice &hdc, const VGColor &inBrushColor) const
 
- Public Member Functions inherited from GRVisitable
virtual ~GRVisitable ()
 

Protected Member Functions

void DrawTAB (VGDevice &hdc, float size, float lspace) const
 
- 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

TYPE_PITCH mClefBasePitch
 
TYPE_REGISTER mClefBaseOctave
 
int mClefStaffLine
 
const char * mOctaveStr = nullptr
 
NVPoint mOctaveOffset
 
bool mDoubleTreble
 
- Protected Attributes inherited from GRTag
int isautotag
 
float sconst
 
unsigned char * mColRef
 
std::string fFontName
 
std::string fFontAttrib
 
int fFontSize
 
float mTagSize
 
NVPoint mTagOffset
 
- Protected Attributes inherited from GRARNotationElement
const ARMusicalObject * mAbstractRepresentation
 
bool mOwnsAR
 
- Protected Attributes inherited from GRNotationElement
unsigned int mSymbol
 
GRStaff * mGrStaff
 
int mNeedsSpring
 
int mSpringID
 
float mLeftSpace
 
float mRightSpace
 
bool mDraw
 
bool mShow
 
bool mIsInHeader
 
TYPE_DURATION mDurationOfGR
 
NEPointerList * mAssociated
 
- Protected Attributes inherited from GObject
NVPoint mPosition
 
NVRect mBoundingBox
 
NVRect mMapping
 

Static Protected Attributes

static NVPoint refposPerc
 
static NVPoint refposTreble
 
static NVPoint refposAlto
 
static NVPoint refposBass
 
static unsigned int sClefTextAlign
 
- Static Protected Attributes inherited from GObject
static std::map< ConstMusicalSymbolID, float > sSymbolExtentMap
 
static NVPoint sRefposNone
 

Additional Inherited Members

- Public Types inherited from GRTag
enum  TAGTYPE {
  VOICETAG, STAFFTAG, SYSTEMTAG, PAGETAG,
  VOICEANDSYSTEMTAG
}
 
- 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)
 

Detailed Description

Graphial representation of a staff clef.

Constructor & Destructor Documentation

◆ GRClef()

GRClef::GRClef ( const ARClef *  arClef,
GRStaff *  curstaff,
bool  ownsAR = false 
)

◆ ~GRClef()

virtual GRClef::~GRClef ( )
inlinevirtual

Member Function Documentation

◆ accept()

virtual void GRClef::accept ( GRVisitor &  visitor)
virtual

Reimplemented from GRNotationElement.

◆ checkCollisionWith()

virtual bool GRClef::checkCollisionWith ( ) const
inlinevirtual

Reimplemented from GRNotationElement.

◆ DrawTAB()

void GRClef::DrawTAB ( VGDevice &  hdc,
float  size,
float  lspace 
) const
protected

◆ getARClef()

const ARClef* GRClef::getARClef ( ) const

◆ getBaseLine()

int GRClef::getBaseLine ( ) const
inline

◆ getBaseOct()

TYPE_REGISTER GRClef::getBaseOct ( ) const
inline

◆ getBasePitch()

TYPE_PITCH GRClef::getBasePitch ( ) const
inline

◆ GetMap()

virtual void GRClef::GetMap ( GuidoElementSelector  sel,
MapCollector &  f,
MapInfos &  infos 
) const
virtual

Reimplemented from GObject.

◆ getReferencePosition()

virtual const NVPoint& GRClef::getReferencePosition ( ) const
virtual

Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position.

It is used for "generic" drawing of graphical symbols from a notation-font. Each symbol has to set the reference position according to font-symbol etc... the refpos is always specified using the "regular" fontsize; when the size parameter is different, the actual offset must be calculated during drawing.

Reimplemented from GObject.

◆ getTextAlign()

virtual unsigned int GRClef::getTextAlign ( ) const
inlinevirtual

Reimplemented from GRNotationElement.

◆ OnDraw()

virtual void GRClef::OnDraw ( VGDevice &  hdc) const
virtual

Reimplemented from GRNotationElement.

◆ operator==() [1/2]

virtual bool GRClef::operator== ( const GRClef &  clef) const
virtual

◆ operator==() [2/2]

virtual bool GRClef::operator== ( const GRTag &  tag) const
virtual

Reimplemented from GRTag.

◆ setHPosition()

virtual void GRClef::setHPosition ( float  inX)
virtual

Reimplemented from GRNotationElement.

Member Data Documentation

◆ mClefBaseOctave

TYPE_REGISTER GRClef::mClefBaseOctave
protected

◆ mClefBasePitch

TYPE_PITCH GRClef::mClefBasePitch
protected

◆ mClefStaffLine

int GRClef::mClefStaffLine
protected

◆ mDoubleTreble

bool GRClef::mDoubleTreble
protected

◆ mOctaveOffset

NVPoint GRClef::mOctaveOffset
protected

◆ mOctaveStr

const char* GRClef::mOctaveStr = nullptr
protected

◆ refposAlto

NVPoint GRClef::refposAlto
staticprotected

◆ refposBass

NVPoint GRClef::refposBass
staticprotected

◆ refposPerc

NVPoint GRClef::refposPerc
staticprotected

◆ refposTreble

NVPoint GRClef::refposTreble
staticprotected

◆ sClefTextAlign

unsigned int GRClef::sClefTextAlign
staticprotected
Guido Project Copyright © 2019 Grame-CNCM