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

Articulations: staccato, accent, marcato, tenuto, fermata, breath-mark, harmonics. More...

Inheritance diagram for GRArticulation:
GRTagARNotationElement GRTag GRARNotationElement GRNotationElement GObject GRVisitable

Public Types

enum  {
  kFlagStaccato = 1, kFlagStaccmo = 2, kFlagTenuto = 4, kFlagAccent = 8,
  kFlagMarcato = 16, kFlagMarcatoUp = 32, kFlagMarcatoDown = 64, kFlagFermataUp = 128,
  kFlagFermataDown = 256, kFlagBreathMark = 512, kFlagPizz = 1024, kFlagHarmonic = 2048,
  kFlagBow = 4096
}
 
- Public Types inherited from GRTag
enum  TAGTYPE {
  VOICETAG, STAFFTAG, SYSTEMTAG, PAGETAG,
  VOICEANDSYSTEMTAG
}
 

Public Member Functions

 GRArticulation (const ARMusicalTag *inTag, float curLSPACE, bool ownsar=false)
 
virtual ~GRArticulation ()
 
virtual const NVPointgetReferencePosition () const
 Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position. More...
 
virtual void setPosition (const NVPoint &point)
 
virtual void tellPosition (GObject *caller, const NVPoint &inPos)
 
virtual void accept (GRVisitor &visitor)
 
virtual void OnDraw (VGDevice &hdc) const
 
int getArticulationType () const
 
void print (std::ostream &os) const
 
- Public Member Functions inherited from GRTagARNotationElement
 GRTagARNotationElement (const ARMusicalObject *el, float curLSPACE, bool ownsAR=false)
 
virtual ~GRTagARNotationElement ()
 
virtual const NVPointgetOffset () 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
 
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 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
 
virtual void setGRStaff (GRStaff *in)
 
GRSystemSlicegetGRSystemSlice () const
 
virtual int getStaffNumber () const
 
virtual float getLeftSpace () const
 
virtual float getRightSpace () const
 
virtual void setLeftSpace (float lspace)
 
virtual void setRightSpace (float rspace)
 
virtual void setHPosition (float nx)
 
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 recalcVerticalPosition ()
 
virtual void addAssociation (GRNotationElement *grnot)
 
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 void addToOffset (const NVPoint &)
 
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 ()
 

Static Public Member Functions

static bool compare (GRArticulation *i, GRArticulation *j)
 
- 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

void placeStaccato (const GREvent *inParent, NVPoint &ioPos)
 
void placeStaccmo (const GREvent *inParent, NVPoint &ioPos)
 
void placePizz (const GREvent *inParent, NVPoint &ioPos)
 
void placeAccent (const GREvent *inParent, NVPoint &ioPos)
 
void placeAccentAbove (const GREvent *inParent, NVPoint &ioPos)
 
void placeAccentBelow (const GREvent *inParent, NVPoint &ioPos)
 
void placeMarcato (const GREvent *inParent, NVPoint &ioPos)
 
void placeMarcatoAbove (const GREvent *inParent, NVPoint &ioPos)
 
void placeMarcatoBelow (const GREvent *inParent, NVPoint &ioPos)
 
void placeTenuto (const GREvent *inParent, NVPoint &ioPos)
 
void placeFermataAbove (const GREvent *inParent, NVPoint &ioPos)
 
void placeFermataBelow (const GREvent *inParent, NVPoint &ioPos)
 
void placeHarmonic (const GREvent *inParent, NVPoint &ioPos)
 
void placeBow (const GREvent *inParent, NVPoint &ioPos)
 
void placeBowBelow (const GREvent *inParent, NVPoint &ioPos)
 
void placeBowAbove (const GREvent *inParent, NVPoint &ioPos)
 
int getPlacement (const GREvent *inParent) 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

int mArticulationFlag
 
- 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 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
 

Static Protected Attributes

static std::map< int, int > sOrdering
 
- Static Protected Attributes inherited from GObject
static std::map< ConstMusicalSymbolID, float > sSymbolExtentMap
 
static NVPoint sRefposNone
 

Detailed Description

Articulations: staccato, accent, marcato, tenuto, fermata, breath-mark, harmonics.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kFlagStaccato 
kFlagStaccmo 
kFlagTenuto 
kFlagAccent 
kFlagMarcato 
kFlagMarcatoUp 
kFlagMarcatoDown 
kFlagFermataUp 
kFlagFermataDown 
kFlagBreathMark 
kFlagPizz 
kFlagHarmonic 
kFlagBow 

Constructor & Destructor Documentation

◆ GRArticulation()

GRArticulation::GRArticulation ( const ARMusicalTag inTag,
float  curLSPACE,
bool  ownsar = false 
)

◆ ~GRArticulation()

virtual GRArticulation::~GRArticulation ( )
inlinevirtual

Member Function Documentation

◆ accept()

virtual void GRArticulation::accept ( GRVisitor visitor)
virtual

Reimplemented from GRNotationElement.

◆ compare()

static bool GRArticulation::compare ( GRArticulation i,
GRArticulation j 
)
inlinestatic

◆ getArticulationType()

int GRArticulation::getArticulationType ( ) const
inline

◆ getPlacement()

int GRArticulation::getPlacement ( const GREvent inParent) const
protected

◆ getReferencePosition()

virtual const NVPoint& GRArticulation::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.

◆ OnDraw()

virtual void GRArticulation::OnDraw ( VGDevice hdc) const
virtual

Reimplemented from GRNotationElement.

◆ placeAccent()

void GRArticulation::placeAccent ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeAccentAbove()

void GRArticulation::placeAccentAbove ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeAccentBelow()

void GRArticulation::placeAccentBelow ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeBow()

void GRArticulation::placeBow ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeBowAbove()

void GRArticulation::placeBowAbove ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeBowBelow()

void GRArticulation::placeBowBelow ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeFermataAbove()

void GRArticulation::placeFermataAbove ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeFermataBelow()

void GRArticulation::placeFermataBelow ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeHarmonic()

void GRArticulation::placeHarmonic ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeMarcato()

void GRArticulation::placeMarcato ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeMarcatoAbove()

void GRArticulation::placeMarcatoAbove ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeMarcatoBelow()

void GRArticulation::placeMarcatoBelow ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placePizz()

void GRArticulation::placePizz ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeStaccato()

void GRArticulation::placeStaccato ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeStaccmo()

void GRArticulation::placeStaccmo ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ placeTenuto()

void GRArticulation::placeTenuto ( const GREvent inParent,
NVPoint ioPos 
)
protected

◆ print()

void GRArticulation::print ( std::ostream &  os) const
virtual

Reimplemented from GRNotationElement.

◆ setPosition()

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

Reimplemented from GRNotationElement.

◆ tellPosition()

virtual void GRArticulation::tellPosition ( GObject caller,
const NVPoint inPos 
)
virtual

Reimplemented from GRNotationElement.

Member Data Documentation

◆ mArticulationFlag

int GRArticulation::mArticulationFlag
protected

◆ sOrdering

std::map<int,int> GRArticulation::sOrdering
staticprotected

Guido Project Copyright © 2019 Grame-CNCM