wheel_menu.c File Reference

Data Structures
struct	wheelItemInfo_t
struct	wheelDrawInfo_t

Macros
#define	wheelAspectRatio   ((ringItems >= 10) ? (TFT_WIDTH + 60) : TFT_WIDTH) / TFT_HEIGHT
#define	PAD_FILL   5

Functions
wheelMenuRenderer_t *	initWheelMenu (const font_t *font, uint16_t anchorAngle, const rectangle_t *textBox)
	Initializes and returns a new wheel menu with the default settings.
void	deinitWheelMenu (wheelMenuRenderer_t *renderer)
	Deinitialize and free all memory associated with the wheel menu renderer.
void	wheelMenuSetColor (wheelMenuRenderer_t *renderer, paletteColor_t textColor)
	Set the text color for the selected item.
void	wheelMenuSetItemInfo (wheelMenuRenderer_t *renderer, const char *label, const wsg_t *icon, uint8_t position, wheelScrollDir_t scrollDir)
	Sets the icon and ring position for the item with the given label.
void	wheelMenuSetItemIcon (wheelMenuRenderer_t *renderer, const char *label, const wsg_t *icon)
	Set the icon for an item with the given label.
void	wheelMenuSetItemColor (wheelMenuRenderer_t *renderer, const char *label, paletteColor_t selectedBg, paletteColor_t unselectedBg)
	Set both the selected and unselected background colors for the item with the given laebl.
void	wheelMenuSetItemTextIcon (wheelMenuRenderer_t *renderer, const char *label, const char *textIcon)
	Set a short text string to use a very short text tring as an item's icon, instead of an image.
void	wheelMenuSetItemSize (wheelMenuRenderer_t *renderer, const char *label, int16_t w, int16_t h, wheelMenuShapeFlags_t shapeFlags)
	Set specific dimensions for a menu item.
void	drawWheelMenu (menu_t *menu, wheelMenuRenderer_t *renderer, int64_t elapsedUs)
	Draw the wheel menu onto the screen.
menu_t *	wheelMenuTouch (menu_t *menu, wheelMenuRenderer_t *renderer, uint16_t angle, uint16_t radius)
	Register a touchpad touch event with the wheel menu.
menu_t *	wheelMenuButton (menu_t *menu, wheelMenuRenderer_t *renderer, const buttonEvt_t *evt)
	Handle a button press, used for when a setting or option menu item can be scrolled.
menu_t *	wheelMenuTouchRelease (menu_t *menu, wheelMenuRenderer_t *renderer)
	Inform the wheel menu that the touchpad has been released, selecting the current item.
bool	wheelMenuActive (menu_t *menu, wheelMenuRenderer_t *renderer)
	Returns whether or not the wheel menu is active and should be drawn.

---

Data Structure Documentation

wheelItemInfo_t

struct wheelItemInfo_t

Data Fields
const char *	label
const wsg_t *	icon
uint8_t	position
wheelScrollDir_t	scroll
paletteColor_t	selectedBg
paletteColor_t	unselectedBg
const char *	textIcon
bool	customSize
int16_t	width
int16_t	height
wheelMenuShapeFlags_t	shapeFlags

wheelDrawInfo_t

struct wheelDrawInfo_t

Data Fields
int8_t	drawOrder
uint16_t	x
uint16_t	y
wheelMenuShapeFlags_t	shape
int16_t	w
int16_t	h
int16_t	r
bool	selected
const wsg_t *	wsg
paletteColor_t	bgColor
const char *	text

Macro Definition Documentation

wheelAspectRatio

#define wheelAspectRatio   ((ringItems >= 10) ? (TFT_WIDTH + 60) : TFT_WIDTH) / TFT_HEIGHT

PAD_FILL

#define PAD_FILL   5

Function Documentation

initWheelMenu()

wheelMenuRenderer_t * initWheelMenu	(	const font_t *	font,
		uint16_t	anchorAngle,
		const rectangle_t *	textBox )

Initializes and returns a new wheel menu with the default settings.

Parameters

font	The font to draw menu item labels with
anchorAngle	The angle where the center of the first item will be anchored
textBox	If non-NULL, defines the bounding box where the current item label will be written

Returns

A newly allocated wheel menu renderer

deinitWheelMenu()

void deinitWheelMenu

(

wheelMenuRenderer_t *

renderer

)

Deinitialize and free all memory associated with the wheel menu renderer.

Parameters

renderer

The whele menu renderer to deinitialize

wheelMenuSetColor()

void wheelMenuSetColor	(	wheelMenuRenderer_t *	renderer,
		paletteColor_t	textColor )

Set the text color for the selected item.

Parameters

renderer	The wheel menu renderer
textColor	The text color for the selected item

wheelMenuSetItemInfo()

void wheelMenuSetItemInfo	(	wheelMenuRenderer_t *	renderer,
		const char *	label,
		const wsg_t *	icon,
		uint8_t	position,
		wheelScrollDir_t	scrollDir )

Sets the icon and ring position for the item with the given label.

Parameters

renderer	The wheel menu renderer
label	The label of the item to set the icon and position for
icon	The icon to use when drawing the menu item
position	The order of the item in the ring, centered around the anchor angle
scrollDir	Which axis this item should be scrollable in

wheelMenuSetItemIcon()

void wheelMenuSetItemIcon	(	wheelMenuRenderer_t *	renderer,
		const char *	label,
		const wsg_t *	icon )

Set the icon for an item with the given label.

Parameters

renderer	The wheel menu renderer
label	The label of the item to set the icon and position for
icon	The icon to use when drawing the menu item

wheelMenuSetItemColor()

void wheelMenuSetItemColor	(	wheelMenuRenderer_t *	renderer,
		const char *	label,
		paletteColor_t	selectedBg,
		paletteColor_t	unselectedBg )

Set both the selected and unselected background colors for the item with the given laebl.

Parameters

renderer	The wheel menu renderer
label	The label of the item to set the color of
selectedBg	The background color for the item when selected
unselectedBg	The background color for the item when not selected

wheelMenuSetItemTextIcon()

void wheelMenuSetItemTextIcon	(	wheelMenuRenderer_t *	renderer,
		const char *	label,
		const char *	textIcon )

Set a short text string to use a very short text tring as an item's icon, instead of an image.

Parameters

renderer	The wheel menu renderer
label	The label to set the icon for
textIcon	The short text string to draw as the icon text

wheelMenuSetItemSize()

void wheelMenuSetItemSize	(	wheelMenuRenderer_t *	renderer,
		const char *	label,
		int16_t	w,
		int16_t	h,
		wheelMenuShapeFlags_t	shapeFlags )

Set specific dimensions for a menu item.

Parameters

renderer	The whee lmenu renderer
label	The label of the item to configure dimensions for
w	The width of the item, or a negative number for "fit to content"
h	The height of the item, or a negative number for "fit to content"
shapeFlags	Extra flags for configuring the shape of the item

drawWheelMenu()

void drawWheelMenu	(	menu_t *	menu,
		wheelMenuRenderer_t *	renderer,
		int64_t	elapsedUs )

Draw the wheel menu onto the screen.

Parameters

menu	The current top-level menu to render
renderer	The wheel menu rendrer
elapsedUs	The number of microseconds elapsed since the last frame was drawn

wheelMenuTouch()

menu_t * wheelMenuTouch	(	menu_t *	menu,
		wheelMenuRenderer_t *	renderer,
		uint16_t	angle,
		uint16_t	radius )

Register a touchpad touch event with the wheel menu.

Parameters

menu	The menu touched
renderer	The wheel menu renderer
angle	The touchpad touch angle
radius	The touchpad touch radius

Returns

menu_t* The current top-level menu, menuButton() would return

wheelMenuButton()

menu_t * wheelMenuButton	(	menu_t *	menu,
		wheelMenuRenderer_t *	renderer,
		const buttonEvt_t *	evt )

Handle a button press, used for when a setting or option menu item can be scrolled.

The direction of the scroll depends on the wheelScrollDir_t value passed to wheelMenuSetItemInfo()

Parameters

menu	The menu to accept the button
renderer	The wheel menu renderer
evt	The button event to be handled

Returns

menu_t* The new top-level menu after handling the button press

wheelMenuTouchRelease()

menu_t * wheelMenuTouchRelease	(	menu_t *	menu,
		wheelMenuRenderer_t *	renderer )

Inform the wheel menu that the touchpad has been released, selecting the current item.

Parameters

menu	The menu released
renderer	The wheel menu renderer

Returns

menu_t* The current top-level menu, as returned by menuButton()

wheelMenuActive()

bool wheelMenuActive	(	menu_t *	menu,
		wheelMenuRenderer_t *	renderer )

Returns whether or not the wheel menu is active and should be drawn.

Parameters

menu	The menu
renderer	The wheel menu renderer

Returns

true if the wheel menu is active

false if the wheel menu is not active