GUIDOLib  1.6.8
A Music Score Rendering Engine
Functions
Reduced proportional representation

Functions

RProportional * GuidoAR2RProportional (ARHandler arh)
 Creates a new reduced proportional representation from AR. More...
 
RProportional * GuidoMidi2RProportional (const char *midiFileName)
 Creates a new reduced proportional representation from a midi file. More...
 
GuidoErrCode GuidoDestroyRProportional (RProportional *pr)
 Destroys a reduced proportional representation and releases all the associated ressources. More...
 
GuidoErrCode GuidoRProportionalSetLimits (RProportional *pr, GuidoDate start, GuidoDate end, int lowpitch, int highpitch)
 Sets limits to a reduced proportional representation (start/end date, lower/higher pitch) More...
 
GuidoErrCode GuidoRProportionalDrawDurationLines (RProportional *pr, bool enabled)
 Enables or disable duration lines (enabled by default) More...
 
GuidoErrCode GuidoRProportionalEnableAutoVoicesColoration (RProportional *pr, bool enabled)
 Enables or not the automatic voices coloration (not enabled by default) If a color is manually set with GuidoRProportionalSetColorToVoice, automatic color will not be applied for this voice. More...
 
GuidoErrCode GuidoRProportionalSetRGBColorToVoice (RProportional *pr, int voiceNum, int r, int g, int b, int a=255)
 Sets a RGB color to a voice (first voice is number 1) (black by default) More...
 
GuidoErrCode GuidoRProportionalSetHtmlColorToVoice (RProportional *pr, int voiceNum, const char *color)
 Sets a html color to a voice (first voice is number 1) (black by default) More...
 
GuidoErrCode GuidoRProportionalRemoveColorToVoice (RProportional *pr, int voiceNum)
 remove a color to a voice (first voice is number 1) (black by default) More...
 
GuidoErrCode GuidoRProportionalEnableMeasureBars (RProportional *pr, bool enabled)
 Enables or disable measure bars (false by default) More...
 
GuidoErrCode GuidoRProportionalGetMap (const RProportional *pr, int width, int height, Time2GraphicMap &outmap)
 Gets a reduced proportional representation map. More...
 
GuidoErrCode GuidoRProportionalOnDraw (RProportional *pr, int width, int height, VGDevice *dev)
 Draw the reduced proportional representation on a VGDevice. More...
 

Detailed Description

Function Documentation

◆ GuidoAR2RProportional()

RProportional* GuidoAR2RProportional ( ARHandler  arh)

Creates a new reduced proportional representation from AR.

Parameters
arhan AR handler
Returns
a guido reduced proportional representation.

◆ GuidoDestroyRProportional()

GuidoErrCode GuidoDestroyRProportional ( RProportional *  pr)

Destroys a reduced proportional representation and releases all the associated ressources.

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
Returns
a Guido error code

◆ GuidoMidi2RProportional()

RProportional* GuidoMidi2RProportional ( const char *  midiFileName)

Creates a new reduced proportional representation from a midi file.

Parameters
midiFileNamea midi file name
Returns
a guido reduced proportional representation.

◆ GuidoRProportionalDrawDurationLines()

GuidoErrCode GuidoRProportionalDrawDurationLines ( RProportional *  pr,
bool  enabled 
)

Enables or disable duration lines (enabled by default)

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional
enableda boolean value
Returns
a Guido error code

◆ GuidoRProportionalEnableAutoVoicesColoration()

GuidoErrCode GuidoRProportionalEnableAutoVoicesColoration ( RProportional *  pr,
bool  enabled 
)

Enables or not the automatic voices coloration (not enabled by default) If a color is manually set with GuidoRProportionalSetColorToVoice, automatic color will not be applied for this voice.

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional
enableda boolean corresponding to the color state
Returns
a Guido error code

◆ GuidoRProportionalEnableMeasureBars()

GuidoErrCode GuidoRProportionalEnableMeasureBars ( RProportional *  pr,
bool  enabled 
)

Enables or disable measure bars (false by default)

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
enableda boolean corresponding to the measure bars draw state
Returns
a Guido error code

◆ GuidoRProportionalGetMap()

GuidoErrCode GuidoRProportionalGetMap ( const RProportional *  pr,
int  width,
int  height,
Time2GraphicMap outmap 
)

Gets a reduced proportional representation map.

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
widththe width of the piano roll (-1 to set the default width : 1024)
heightthe height of the canvas (-1 to set the default height : 512)
outmapon output: a time to graphic map
Returns
a Guido error code (returns guidoErrBadParameter if keyboard width is higher than width param)

◆ GuidoRProportionalOnDraw()

GuidoErrCode GuidoRProportionalOnDraw ( RProportional *  pr,
int  width,
int  height,
VGDevice dev 
)

Draw the reduced proportional representation on a VGDevice.

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
widththe drawing area width (-1 to set the default width : 1024)
heightthe drawing area height (-1 to set the default height : 512)
devthe graphic device
Returns
a Guido error code

◆ GuidoRProportionalRemoveColorToVoice()

GuidoErrCode GuidoRProportionalRemoveColorToVoice ( RProportional *  pr,
int  voiceNum 
)

remove a color to a voice (first voice is number 1) (black by default)

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
voiceNumthe voice number (first voice is number 1)
Returns
a Guido error code

◆ GuidoRProportionalSetHtmlColorToVoice()

GuidoErrCode GuidoRProportionalSetHtmlColorToVoice ( RProportional *  pr,
int  voiceNum,
const char *  color 
)

Sets a html color to a voice (first voice is number 1) (black by default)

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
voiceNumthe voice number (first voice is number 1)
colorthe html color (constants are defined in Colors.h)
Returns
a Guido error code

◆ GuidoRProportionalSetLimits()

GuidoErrCode GuidoRProportionalSetLimits ( RProportional *  pr,
GuidoDate  start,
GuidoDate  end,
int  lowpitch,
int  highpitch 
)

Sets limits to a reduced proportional representation (start/end date, lower/higher pitch)

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
startdate (GuidoDate) (0/0 to adjust automatically start date to the score's start date)
enddate (GuidoDate) (0/0 to adjust automatically end date to the score's end date)
lowpitchminimal pitch (midi notation) (-1 to adjust automatically min pitch to the score's minimal pitch)
highpitchmaximal pitch (midi notation) (-1 to adjust automatically max pitch to the score's maximal pitch) Remark : minimal range pitch accepted is 1 octave.
Returns
a Guido error code

◆ GuidoRProportionalSetRGBColorToVoice()

GuidoErrCode GuidoRProportionalSetRGBColorToVoice ( RProportional *  pr,
int  voiceNum,
int  r,
int  g,
int  b,
int  a = 255 
)

Sets a RGB color to a voice (first voice is number 1) (black by default)

Parameters
pra reduced proportional representation previously created with GuidoAR2RProportional or GuidoMidi2RProportional
voiceNumthe voice number (first voice is number 1)
rthe red param of RGB color
gthe green param of RGB color
bthe blue param of RGB color
athe alpha param of RGB color
Returns
a Guido error code

Guido Project Copyright © 2019 Grame-CNCM