GRStaff Class Reference

A GRStaff represents a single line of music. More...

Inheritance diagram for GRStaff:

Public Member Functions
	GRStaff (GRSystemSlice *systemslice, float propRender)
virtual	~GRStaff ()
float	getDistance () const
GRSystem *	getGRSystem () const
GRSystemSlice *	getGRSystemSlice () const
GRStaff *	getPreviousStaff () const
GRStaff *	getNextStaff () const
int	getStaffNumber () const
GRGlue *	getEndGlue () const
GRGlue *	getStartGlue () const
GRGlue *	getSecondGlue () const
int	getFontSize () const
float	getStaffLSPACE () const
float	getSizeRatio () const
const GRStaffState *	getStaffState () const
GRStaffState &	getGRStaffState ()
const GRStaffState &	getGRStaffState () const
float	getXEndPosition (TYPE_TIMEPOSITION pos, TYPE_DURATION dur) const
const ARMeter *	getCurMeter () const
virtual float	getNotePosition (TYPE_PITCH pit, TYPE_REGISTER oct) const
virtual GDirection	getDefaultThroatDirection (TYPE_PITCH pit, TYPE_REGISTER oct) const
virtual int	getNumHelplines (TYPE_PITCH pit, TYPE_REGISTER oct) const
virtual VGColor	getNoteColor (TYPE_PITCH pit) const
virtual int	getNumlines () const
virtual unsigned char *	getStffrmtColRef () const
virtual float	getLineThickness () const
virtual float	getDredgeSize () const
virtual float	getMappingDredgeSize () const
virtual float	getKeyPosition (TYPE_PITCH pitch, int numkeys=1) const
virtual GRNote *	getLastNote () const
const GRNote *	getFirstNote () const
virtual GRBar *	getLastBar () const
virtual void	print (std::ostream &os) const
virtual void	accept (GRVisitor &visitor)
virtual void	setStaffFormat (const ARStaffFormat *staffrmt)
void	setStaffState (GRStaffState *state)
void	setInstrumentFormat (const GRStaffState &state)
void	setBarFormat (const ARBarFormat *barfrmt)
void	setNoteParameters (const GRNote *inNote)
void	setKeyParameters (GRKey *inKey)
void	setDistance (float distance)
void	setEndPosition (float newendpos)
void	setLength (float newlength)
GROctava *	AddOctava (const AROctava *aroct)
void	AddSecondGlue (GRGlue *myglue)
void	AddElementAt (GuidoPos pos, GRNotationElement *el)
GRRepeatBegin *	AddRepeatBegin (ARRepeatBegin *)
GRRepeatEnd *	AddRepeatEnd (ARRepeatEnd *)
GRDoubleBar *	AddDoubleBar (ARDoubleBar *ardbar, const TYPE_TIMEPOSITION &tp)
GRFinishBar *	AddFinishBar (ARFinishBar *arfbar, const TYPE_TIMEPOSITION &tp)
GRIntens *	AddIntens (const ARIntens *aintens)
GRText *	AddText (const ARText *atext)
GRKey *	AddKey (const ARKey *arkey)
GRBar *	AddBar (ARBar *abar, const TYPE_TIMEPOSITION &von)
GRMeter *	AddMeter (const ARMeter *armeter)
void	AddTag (GRNotationElement *grtag)
GRClef *	AddClef (const ARClef *)
GRInstrument *	AddInstrument (const ARInstrument *)
virtual AccList *	askAccidentals (TYPE_PITCH p_pit, TYPE_REGISTER p_oct, int p_acc, float detune=0.f)
virtual void	boundingBoxPreview ()
virtual void	updateBoundingBox ()
virtual void	FinishStaff ()
virtual float	FirstNoteORRestXPos () const
void	UpdateStaffState (GuidoPos pos)
void	TellNewStaff (GuidoPos pos)
void	createNewRods (GRStaffManager *staffmgr, int &startspr, int &endspr, float optForce)
void	CreateBeginElements (GRStaffManager *staffmgr, GRStaffState &state, int staffnum)
GuidoPos	EndStaff (const TYPE_TIMEPOSITION &tp, GRStaffManager *staffmgr, GuidoPos endpos=0, int lastline=0)
void	EndStaff (const TYPE_TIMEPOSITION &tp, GRSpring *spr)
void	BeginStaff (GRStaffManager *staffmgr)
void	addElementsToSprings ()
virtual void	OnDraw (VGDevice &hdc) const
virtual void	GetMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
void	setOnOff (bool onoff, TYPE_TIMEPOSITION tp)
void	setOnOff (bool onoff)
bool	isStaffBeginOn ()
bool	isStaffEndOn ()
void	setNextOnOff (bool onoff)
bool	isNextStaffOn ()
void	addNotationElement (GRNotationElement *notationElement)
void	checkSystemBar (const TYPE_TIMEPOSITION &tp)
void	generatePositions ()
float	currentLineThikness () const
float	getProportionnalRender () const
float	getStaffBottom () const
void	checkCollisions (TCollisions &state) const
void	checkMultiVoiceNotesCollision ()
float	getNotesDensity () const
size_t	getLyrics (std::vector< const GRNotationElement * > &list) const
void	inhibitNextReset2Key ()
Public Member Functions inherited from GRCompositeNotationElement
	GRCompositeNotationElement ()
virtual	~GRCompositeNotationElement ()
virtual void	setGRStaff (GRStaff *stf)
virtual GuidoPos	AddTail (GRNotationElement *)
NEPointerList *	getElements ()
const NEPointerList &	getElements () const
Public Member Functions inherited from GRNotationElement
	GRNotationElement ()
virtual	~GRNotationElement ()
GRStaff *	getGRStaff () const
GRSystemSlice *	getGRSystemSlice () 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	setHPosition (float nx)
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 unsigned int	getTextAlign () const
virtual const ARMusicalObject *	getAbstractRepresentation () 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)
const NEPointerList *	associated () const
virtual void	setIsInHeader (bool state)
virtual bool	isInHeader () const
virtual bool	isEmpty () const
virtual bool	isLyrics () const
virtual bool	isChordComma () const
virtual bool	checkCollisionWith () 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 &)
virtual const NVPoint &	getOffset () const
virtual const char *	getFont () const
virtual const char *	getFontAttrib () const
virtual const unsigned char *	getColRef () const
virtual float	getSize () const
virtual const NVPoint &	getReferencePosition () const
	Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position. More...
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	DebugPrintState (const char *info) const
void	DrawStaffUsingSymbolScale (VGDevice &hdc) const
void	DrawStaffUsingSymbolRepeat (VGDevice &hdc) const
void	DrawStaffUsingLines (VGDevice &hdc) const
void	DrawNotationElements (VGDevice &hdc) const
void	setClefParameters (GRClef *grclef, GRStaffState::clefstate cstate=GRStaffState::CLEFAUTO)
void	setMeterParameters (GRMeter *grmeter)
void	setStaffSize (float size)
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
GuidoPos	lastrodpos
GRRod *	lastrod
GRRod *	firstrod
GRGlue *	endglue
GRGlue *	startglue
GRGlue *	secglue
GRSystem *	mGrSystem
GRSystemSlice *	mGrSystemSlice
float	mLength
GRStaffState	mStaffState
float	avg_position
int	mNoteCount
Protected Attributes inherited from GRCompositeNotationElement
NEPointerList	mCompElements
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

Friends
class	GRPossibleBreakState
class	GRStaffState
class	GRStaffManager
class	GRVoiceManager

Additional Inherited Members
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)
Static Protected Attributes inherited from GObject
static std::map< ConstMusicalSymbolID, float >	sSymbolExtentMap
static NVPoint	sRefposNone

Detailed Description

A GRStaff represents a single line of music.

Constructor & Destructor Documentation

GRStaff()

GRStaff::GRStaff	(	GRSystemSlice *	systemslice,
		float	propRender
	)

~GRStaff()

virtual GRStaff::~GRStaff ( )

virtual

Member Function Documentation

accept()

virtual void GRStaff::accept ( GRVisitor &  visitor )

virtual

Reimplemented from GRNotationElement.

AddBar()

GRBar* GRStaff::AddBar	(	ARBar *	abar,
		const TYPE_TIMEPOSITION &	von
	)

AddClef()

GRClef* GRStaff::AddClef

(

const ARClef *

)

AddDoubleBar()

GRDoubleBar* GRStaff::AddDoubleBar	(	ARDoubleBar *	ardbar,
		const TYPE_TIMEPOSITION &	tp
	)

AddElementAt()

void GRStaff::AddElementAt	(	GuidoPos	pos,
		GRNotationElement *	el
	)

addElementsToSprings()

void GRStaff::addElementsToSprings

(

)

AddFinishBar()

GRFinishBar* GRStaff::AddFinishBar	(	ARFinishBar *	arfbar,
		const TYPE_TIMEPOSITION &	tp
	)

AddInstrument()

GRInstrument* GRStaff::AddInstrument

(

const ARInstrument *

)

AddIntens()

GRIntens* GRStaff::AddIntens

(

const ARIntens *

aintens

)

AddKey()

GRKey* GRStaff::AddKey

(

const ARKey *

arkey

)

AddMeter()

GRMeter* GRStaff::AddMeter

(

const ARMeter *

armeter

)

addNotationElement()

void GRStaff::addNotationElement

(

GRNotationElement *

notationElement

)

AddOctava()

GROctava* GRStaff::AddOctava

(

const AROctava *

aroct

)

AddRepeatBegin()

GRRepeatBegin* GRStaff::AddRepeatBegin

(

ARRepeatBegin *

)

AddRepeatEnd()

GRRepeatEnd* GRStaff::AddRepeatEnd

(

ARRepeatEnd *

)

AddSecondGlue()

void GRStaff::AddSecondGlue

(

GRGlue *

myglue

)

AddTag()

void GRStaff::AddTag

(

GRNotationElement *

grtag

)

AddText()

GRText* GRStaff::AddText

(

const ARText *

atext

)

askAccidentals()

virtual AccList* GRStaff::askAccidentals ( TYPE_PITCH  p_pit, TYPE_REGISTER  p_oct, int  p_acc, float  detune = 0.f  )

virtual

BeginStaff()

void GRStaff::BeginStaff

(

GRStaffManager *

staffmgr

)

boundingBoxPreview()

virtual void GRStaff::boundingBoxPreview ( )

virtual

checkCollisions()

void GRStaff::checkCollisions

(

TCollisions &

state

)

const

checkMultiVoiceNotesCollision()

void GRStaff::checkMultiVoiceNotesCollision

(

)

checkSystemBar()

void GRStaff::checkSystemBar

(

const TYPE_TIMEPOSITION &

tp

)

CreateBeginElements()

void GRStaff::CreateBeginElements	(	GRStaffManager *	staffmgr,
		GRStaffState &	state,
		int	staffnum
	)

createNewRods()

void GRStaff::createNewRods	(	GRStaffManager *	staffmgr,
		int &	startspr,
		int &	endspr,
		float	optForce
	)

currentLineThikness()

float GRStaff::currentLineThikness

(

)

const

DebugPrintState()

void GRStaff::DebugPrintState ( const char *  info ) const

protected

DrawNotationElements()

void GRStaff::DrawNotationElements ( VGDevice &  hdc ) const

protected

DrawStaffUsingLines()

void GRStaff::DrawStaffUsingLines ( VGDevice &  hdc ) const

protected

DrawStaffUsingSymbolRepeat()

void GRStaff::DrawStaffUsingSymbolRepeat ( VGDevice &  hdc ) const

protected

DrawStaffUsingSymbolScale()

void GRStaff::DrawStaffUsingSymbolScale ( VGDevice &  hdc ) const

protected

EndStaff() [1/2]

void GRStaff::EndStaff	(	const TYPE_TIMEPOSITION &	tp,
		GRSpring *	spr
	)

EndStaff() [2/2]

GuidoPos GRStaff::EndStaff	(	const TYPE_TIMEPOSITION &	tp,
		GRStaffManager *	staffmgr,
		GuidoPos	endpos = 0,
		int	lastline = 0
	)

FinishStaff()

virtual void GRStaff::FinishStaff ( )

virtual

FirstNoteORRestXPos()

virtual float GRStaff::FirstNoteORRestXPos ( ) const

virtual

generatePositions()

void GRStaff::generatePositions

(

)

getCurMeter()

const ARMeter* GRStaff::getCurMeter ( ) const

inline

getDefaultThroatDirection()

virtual GDirection GRStaff::getDefaultThroatDirection ( TYPE_PITCH  pit, TYPE_REGISTER  oct  ) const

virtual

getDistance()

float GRStaff::getDistance

(

)

const

getDredgeSize()

virtual float GRStaff::getDredgeSize ( ) const

virtual

getEndGlue()

GRGlue* GRStaff::getEndGlue

(

)

const

getFirstNote()

const GRNote* GRStaff::getFirstNote

(

)

const

getFontSize()

int GRStaff::getFontSize ( ) const

virtual

Reimplemented from GObject.

getGRStaffState() [1/2]

GRStaffState& GRStaff::getGRStaffState ( )

inline

getGRStaffState() [2/2]

const GRStaffState& GRStaff::getGRStaffState ( ) const

inline

getGRSystem()

GRSystem* GRStaff::getGRSystem

(

)

const

getGRSystemSlice()

GRSystemSlice* GRStaff::getGRSystemSlice

(

)

const

getKeyPosition()

virtual float GRStaff::getKeyPosition ( TYPE_PITCH  pitch, int  numkeys = 1  ) const

virtual

getLastBar()

virtual GRBar* GRStaff::getLastBar ( ) const

virtual

getLastNote()

virtual GRNote* GRStaff::getLastNote ( ) const

virtual

getLineThickness()

virtual float GRStaff::getLineThickness ( ) const

inlinevirtual

getLyrics()

size_t GRStaff::getLyrics

(

std::vector< const GRNotationElement * > &

list

)

const

GetMap()

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

virtual

Reimplemented from GObject.

getMappingDredgeSize()

virtual float GRStaff::getMappingDredgeSize ( ) const

virtual

getNextStaff()

GRStaff* GRStaff::getNextStaff

(

)

const

getNoteColor()

virtual VGColor GRStaff::getNoteColor ( TYPE_PITCH  pit ) const

virtual

getNotePosition()

virtual float GRStaff::getNotePosition ( TYPE_PITCH  pit, TYPE_REGISTER  oct  ) const

virtual

getNotesDensity()

float GRStaff::getNotesDensity

(

)

const

getNumHelplines()

virtual int GRStaff::getNumHelplines ( TYPE_PITCH  pit, TYPE_REGISTER  oct  ) const

virtual

getNumlines()

virtual int GRStaff::getNumlines ( ) const

inlinevirtual

getPreviousStaff()

GRStaff* GRStaff::getPreviousStaff

(

)

const

getProportionnalRender()

float GRStaff::getProportionnalRender ( ) const

inline

getSecondGlue()

GRGlue* GRStaff::getSecondGlue

(

)

const

getSizeRatio()

float GRStaff::getSizeRatio ( ) const

inline

getStaffBottom()

float GRStaff::getStaffBottom

(

)

const

getStaffLSPACE()

float GRStaff::getStaffLSPACE ( ) const

inline

getStaffNumber()

int GRStaff::getStaffNumber ( ) const

virtual

Reimplemented from GRNotationElement.

getStaffState()

const GRStaffState* GRStaff::getStaffState ( ) const

inline

getStartGlue()

GRGlue* GRStaff::getStartGlue

(

)

const

getStffrmtColRef()

virtual unsigned char* GRStaff::getStffrmtColRef ( ) const

inlinevirtual

getXEndPosition()

float GRStaff::getXEndPosition	(	TYPE_TIMEPOSITION	pos,
		TYPE_DURATION	dur
	)		const

inhibitNextReset2Key()

void GRStaff::inhibitNextReset2Key ( )

inline

isNextStaffOn()

bool GRStaff::isNextStaffOn ( )

inline

isStaffBeginOn()

bool GRStaff::isStaffBeginOn

(

)

isStaffEndOn()

bool GRStaff::isStaffEndOn

(

)

OnDraw()

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

virtual

Reimplemented from GRNotationElement.

print()

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

virtual

Reimplemented from GRNotationElement.

setBarFormat()

void GRStaff::setBarFormat

(

const ARBarFormat *

barfrmt

)

setClefParameters()

void GRStaff::setClefParameters ( GRClef *  grclef, GRStaffState::clefstate  cstate = GRStaffState::CLEFAUTO  )

protected

setDistance()

void GRStaff::setDistance ( float  distance )

inline

setEndPosition()

void GRStaff::setEndPosition ( float  newendpos )

inline

setInstrumentFormat()

void GRStaff::setInstrumentFormat

(

const GRStaffState &

state

)

setKeyParameters()

void GRStaff::setKeyParameters

(

GRKey *

inKey

)

setLength()

void GRStaff::setLength ( float  newlength )

inline

setMeterParameters()

void GRStaff::setMeterParameters ( GRMeter *  grmeter )

protected

setNextOnOff()

void GRStaff::setNextOnOff ( bool  onoff )

inline

setNoteParameters()

void GRStaff::setNoteParameters

(

const GRNote *

inNote

)

setOnOff() [1/2]

void GRStaff::setOnOff

(

bool

onoff

)

setOnOff() [2/2]

void GRStaff::setOnOff	(	bool	onoff,
		TYPE_TIMEPOSITION	tp
	)

setStaffFormat()

virtual void GRStaff::setStaffFormat ( const ARStaffFormat *  staffrmt )

virtual

setStaffSize()

void GRStaff::setStaffSize ( float  size )

inlineprotected

setStaffState()

void GRStaff::setStaffState

(

GRStaffState *

state

)

TellNewStaff()

void GRStaff::TellNewStaff

(

GuidoPos

pos

)

updateBoundingBox()

virtual void GRStaff::updateBoundingBox ( )

virtual

Implements GRCompositeNotationElement.

UpdateStaffState()

void GRStaff::UpdateStaffState

(

GuidoPos

pos

)

Friends And Related Function Documentation

GRPossibleBreakState

friend class GRPossibleBreakState

friend

GRStaffManager

friend class GRStaffManager

friend

GRStaffState

friend class GRStaffState

friend

GRVoiceManager

friend class GRVoiceManager

friend

Member Data Documentation

avg_position

float GRStaff::avg_position

protected

endglue

GRGlue* GRStaff::endglue

protected

firstrod

GRRod* GRStaff::firstrod

protected

lastrod

GRRod* GRStaff::lastrod

protected

lastrodpos

GuidoPos GRStaff::lastrodpos

protected

mGrSystem

GRSystem* GRStaff::mGrSystem

protected

mGrSystemSlice

GRSystemSlice* GRStaff::mGrSystemSlice

protected

mLength

float GRStaff::mLength

protected

mNoteCount

int GRStaff::mNoteCount

protected

mStaffState

GRStaffState GRStaff::mStaffState

protected

secglue

GRGlue* GRStaff::secglue

protected

startglue

GRGlue* GRStaff::startglue

protected