Graph

Detailed Description

Graph window. Used to display highly customizable graphs.

GWIN allows it to easily draw graphs.

Precondition

GFX_USE_GWIN must be set to GFXON in your gfxconf.h

GWIN_NEED_GRAPH must be set to GFXON in your gfxconf.h

Functions
GHandle	gwinGGraphCreate (GDisplay *g, GGraphObject *gg, const GWindowInit *pInit)
	Create a graph window. More...
void	gwinGraphSetStyle (GHandle gh, const GGraphStyle *pstyle)
	Set the style of the graphing operations. More...
void	gwinGraphSetOrigin (GHandle gh, gCoord x, gCoord y)
	Set the origin for graphing operations. More...
void	gwinGraphDrawAxis (GHandle gh)
	Draw the axis and the background grid. More...
void	gwinGraphStartSet (GHandle gh)
	Start a new set of graphing data. More...
void	gwinGraphDrawPoint (GHandle gh, gCoord x, gCoord y)
	Draw a graph point. More...
void	gwinGraphDrawPoints (GHandle gh, const gPoint *points, unsigned count)
	Draw multiple graph points. More...

Function Documentation

gwinGGraphCreate()

GHandle gwinGGraphCreate	(	GDisplay *	g,
		GGraphObject *	gg,
		const GWindowInit *	pInit
	)

Create a graph window.

Returns

NULL if there is no resultant drawing area, otherwise a window handle.

Parameters

[in]	g	The GDisplay to display this window on
[in]	gg	The GGraphObject structure to initialise. If this is NULL the structure is dynamically allocated.
[in]	pInit	The initialization parameters to use

Note

The drawing color and the background color get set to the current defaults. If you haven't called gwinSetDefaultColor() or gwinSetDefaultBgColor() then these are GFX_WHITE and GFX_BLACK respectively.

The font gets set to the current default font. If you haven't called gwinSetDefaultFont() then there is no default font and text drawing operations will no nothing.

The dimensions and position may be changed to fit on the real screen.

A graph does not save the drawing state. It is not automatically redrawn if the window is moved or its visibility state is changed.

The coordinate system within the window for graphing operations (but not for any other drawing operation) is relative to the bottom left corner and then shifted right and up by the specified graphing x and y origin. Note that this system is inverted in the y direction relative to the display. This gives the best graphing arrangement ie. increasing y values are closer to the top of the display.

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGraphDrawAxis()

void gwinGraphDrawAxis

(

GHandle

gh

)

Draw the axis and the background grid.

Parameters

[in]

gh

The window handle (must be a graph window)

Note

The graph is not automatically cleared. You must do that first by calling gwinClear().

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGraphDrawPoint()

void gwinGraphDrawPoint	(	GHandle	gh,
		gCoord	x,
		gCoord	y
	)

Draw a graph point.

A graph point and a line connecting to the previous point will be drawn.

Parameters

[in]	gh	The window handle (must be a graph window)
[in]	x,y	The new point for the graph.

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGraphDrawPoints()

void gwinGraphDrawPoints	(	GHandle	gh,
		const gPoint *	points,
		unsigned	count
	)

Draw multiple graph points.

A graph point and a line connecting to each previous point will be drawn.

Parameters

[in]	gh	The window handle (must be a graph window)
[in]	points	The array of points for the graph.
[in]	count	The number of points in the array.

Note

This is slightly more efficient than calling gwinGraphDrawPoint() repeatedly.

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGraphSetOrigin()

void gwinGraphSetOrigin	(	GHandle	gh,
		gCoord	x,
		gCoord	y
	)

Set the origin for graphing operations.

Parameters

[in]	gh	The window handle (must be a graph window)
[in]	x,y	The new origin for the graph (in graph coordinates relative to the bottom left corner).

Note

The graph is not automatically redrawn. The new origin will apply to any new drawing operations.

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGraphSetStyle()

void gwinGraphSetStyle	(	GHandle	gh,
		const GGraphStyle *	pstyle
	)

Set the style of the graphing operations.

Parameters

[in]	gh	The window handle (must be a graph window)
[in]	pstyle	The graph style to set.

Note

The graph is not automatically redrawn. The new style will apply to any new drawing operations.

Function Class: Normal API, this function can be invoked by regular system threads.

gwinGraphStartSet()

void gwinGraphStartSet

(

GHandle

gh

)

Start a new set of graphing data.

This prevents a line being drawn from the last data point to the next point to be drawn.

Parameters

[in]

gh

The window handle (must be a graph window)

Function Class: Normal API, this function can be invoked by regular system threads.