Guido Score Map Adapter

A C++ interface to the Guido score map API. More...

Functions
virtual	~GuidoScoreMapAdapter ()
GuidoErrCode	getMap (CGRHandler gr, int pagenum, float width, float height, GuidoElementSelector sel, MapCollector &f)
	Retrieves the graphic to time mapping. More...
Time2GraphicMap	getPageMap (CGRHandler gr, int pagenum, float w, float h)
	Retrieves a guido page graphic to time mapping. More...
Time2GraphicMap	getStaffMap (CGRHandler gr, int pagenum, float w, float h, int staff)
	Retrieves a guido staff graphic to time mapping. More...
Time2GraphicMap	getVoiceMap (CGRHandler gr, int pagenum, float w, float h, int voice)
	Retrieves a guido voice graphic to time mapping. More...
Time2GraphicMap	getSystemMap (CGRHandler gr, int pagenum, float w, float h)
	Retrieves a guido system graphic to time mapping. More...
bool	getTime (const GuidoDate &date, const Time2GraphicMap map, TimeSegment &t, FloatRect &r)
	Retrieves a time segment and the associated graphic segment in a mapping. More...
bool	getPoint (float x, float y, const Time2GraphicMap map, TimeSegment &t, FloatRect &r)
	Retrieves a time segment and the associated graphic segment in a mapping. More...
GuidoErrCode	getTimeMap (CARHandler gr, TimeMapCollector &f)
	Retrieves the rolled to unrolled time mapping. More...
TTime2TimeMap	getTime2TimeMap (CARHandler ar)

Variables
class_export	GuidoScoreMapAdapter

Detailed Description

A C++ interface to the Guido score map API.

A C++ class to manipulate score map of GuidoEngine.

Function Documentation

getMap()

GuidoErrCode getMap	(	CGRHandler	gr,
		int	pagenum,
		float	width,
		float	height,
		GuidoElementSelector	sel,
		MapCollector &	f
	)

Retrieves the graphic to time mapping.

Parameters

gr	a Guido opaque handle to a GR structure.
pagenum	a page index, starting from 1.
width	the page width.
height	the page height.
sel	GuidoeElementSelector to filter undesired objects out.
f	a MapCollector object that will be called for each selected element or null if error

Returns

a Guido error code

getPageMap()

Time2GraphicMap getPageMap	(	CGRHandler	gr,
		int	pagenum,
		float	w,
		float	h
	)

Retrieves a guido page graphic to time mapping.

Parameters

gr	a Guido opaque handle to a GR structure.
pagenum	a page index, starting from 1.
w	the page width.
h	the page height.

Returns

contains the mapping on output or null if error

getPoint()

bool getPoint	(	float	x,
		float	y,
		const Time2GraphicMap	map,
		TimeSegment &	t,
		FloatRect &	r
	)

Retrieves a time segment and the associated graphic segment in a mapping.

Parameters

x	a point x coordinate
y	a point y coordinate
map	a time to graphic map.
r	on output, the graphic segment containing the point (note that segments are right and bottom opened)
t	on output, the time segment associated to the graphic segment

Returns

false when there is no segment containing the point.

getStaffMap()

Time2GraphicMap getStaffMap	(	CGRHandler	gr,
		int	pagenum,
		float	w,
		float	h,
		int	staff
	)

Retrieves a guido staff graphic to time mapping.

Parameters

gr	a Guido opaque handle to a GR structure.
pagenum	a page index, starting from 1.
w	the page width.
h	the page height.
staff	the staff index (starting from 1).

Returns

outmap contains the mapping on output or null if error

getSystemMap()

Time2GraphicMap getSystemMap	(	CGRHandler	gr,
		int	pagenum,
		float	w,
		float	h
	)

Retrieves a guido system graphic to time mapping.

Parameters

gr	a Guido opaque handle to a GR structure.
pagenum	a page index, starting from 1.
w	the page width.
h	the page height.

Returns

outmap contains the mapping on output or null if error

getTime()

bool getTime	(	const GuidoDate &	date,
		const Time2GraphicMap	map,
		TimeSegment &	t,
		FloatRect &	r
	)

Retrieves a time segment and the associated graphic segment in a mapping.

Parameters

date	a date used to select the container time segment
map	a time to graphic map.
t	on output, the time segment containing the date (note that segments are right opened)
r	on output, the graphic segment associated to the time segment

Returns

false when there is no segment containing the date.

getTime2TimeMap()

TTime2TimeMap getTime2TimeMap

(

CARHandler

ar

)

getTimeMap()

GuidoErrCode getTimeMap	(	CARHandler	gr,
		TimeMapCollector &	f
	)

Retrieves the rolled to unrolled time mapping.

Parameters

gr	a Guido opaque handle to a GR structure.
f	a TimeMapCollector object that will be called for each time segment or null if error.

Returns

a Guido error code

getVoiceMap()

Time2GraphicMap getVoiceMap	(	CGRHandler	gr,
		int	pagenum,
		float	w,
		float	h,
		int	voice
	)

Retrieves a guido voice graphic to time mapping.

Parameters

gr	a Guido opaque handle to a GR structure.
pagenum	a page index, starting from 1.
w	the page width.
h	the page height.
voice	the voice index (starting from 1).

Returns

outmap contains the mapping on output or null if error

~GuidoScoreMapAdapter()

virtual ~GuidoScoreMapAdapter ( )

virtual

Variable Documentation

GuidoScoreMapAdapter

class_export GuidoScoreMapAdapter

Initial value:

{
    public:
        GuidoScoreMapAdapter()