GuiTrigger Class Reference

Menu input trigger management. Determine if action is neccessary based on input data by comparing controller input data to a specific trigger element. More...

#include <gui_trigger.h>

Public Member Functions
	GuiTrigger ()
	Constructor. More...
	~GuiTrigger ()
	Destructor. More...
void	SetSimpleTrigger (s32 ch, u32 wiibtns, u16 gcbtns=0, u16 wiidrcbtns=0)
void	SetHeldTrigger (s32 ch, u32 wiibtns, u16 gcbtns=0, u16 wiidrcbtns=0)
void	SetButtonOnlyTrigger (s32 ch, u32 wiibtns, u16 gcbtns=0, u16 wiidrcbtns=0)
void	SetButtonOnlyInFocusTrigger (s32 ch, u32 wiibtns, u16 gcbtns=0, u16 wiidrcbtns=0)
s8	WPAD_Stick (u8 stick, int axis)
s8	WPAD_StickX (u8 stick)
s8	WPAD_StickY (u8 stick)
void	TurnWiimote (bool sideways)
bool	Left ()
bool	Right ()
bool	Up ()
bool	Down ()

Public Attributes
WPADData	wpaddata
	Wii controller trigger data.
PADData	pad
	GameCube controller trigger data.
GamePadData	wiidrcdata
	Wii U Gamepad trigger data.
WPADData *	wpad
	Wii controller trigger.
bool	WiimoteTurned
	Wiimote orientation.
s32	chan
	Trigger controller channel (0-3, -1 for all)
TRIGGER	type
	trigger type (TRIGGER::SIMPLE, TRIGGER::HELD, TRIGGER::BUTTON_ONLY, TRIGGER::BUTTON_ONLY_IN_FOCUS)

Detailed Description

Menu input trigger management. Determine if action is neccessary based on input data by comparing controller input data to a specific trigger element.

Constructor & Destructor Documentation

GuiTrigger()

GuiTrigger::GuiTrigger

(

)

Constructor.

Constructor for the GuiTrigger class.

~GuiTrigger()

GuiTrigger::~GuiTrigger

(

)

Destructor.

Destructor for the GuiTrigger class.

Member Function Documentation

Down()

bool GuiTrigger::Down

(

)

Move menu selection down (via pad/joystick). Allows scroll delay and button overriding

Returns

true if selection should be moved down, false otherwise

Left()

bool GuiTrigger::Left

(

)

Move menu selection left (via pad/joystick). Allows scroll delay and button overriding

Returns

true if selection should be moved left, false otherwise

Right()

bool GuiTrigger::Right

(

)

Move menu selection right (via pad/joystick). Allows scroll delay and button overriding

Returns

true if selection should be moved right, false otherwise

SetButtonOnlyInFocusTrigger()

void GuiTrigger::SetButtonOnlyInFocusTrigger	(	s32	ch,
		u32	wiibtns,
		u16	gcbtns = 0,
		u16	wiidrcbtns = 0
	)

Sets a button-only trigger. Requires: trigger button is pressed and parent window of element is in focus

Parameters

ch	Controller channel number
wiibtns	Wii controller trigger button(s) - classic controller buttons are considered separately
gcbtns	GameCube controller trigger button(s)
wiidrcbtns	Wii U Gamepad trigger button(s)

Sets a button trigger. Requires:

• Trigger button is pressed
• Parent window is in focus

SetButtonOnlyTrigger()

void GuiTrigger::SetButtonOnlyTrigger	(	s32	ch,
		u32	wiibtns,
		u16	gcbtns = 0,
		u16	wiidrcbtns = 0
	)

Sets a button-only trigger. Requires: Trigger button is pressed

Parameters

ch	Controller channel number
wiibtns	Wii controller trigger button(s) - classic controller buttons are considered separately
gcbtns	GameCube controller trigger button(s)
wiidrcbtns	Wii U Gamepad trigger button(s)

Sets a button trigger. Requires:

• Trigger button is pressed

SetHeldTrigger()

void GuiTrigger::SetHeldTrigger	(	s32	ch,
		u32	wiibtns,
		u16	gcbtns = 0,
		u16	wiidrcbtns = 0
	)

Sets a held trigger. Requires: element is selected, and trigger button is pressed

Parameters

ch	Controller channel number
wiibtns	Wii controller trigger button(s) - classic controller buttons are considered separately
gcbtns	GameCube controller trigger button(s)
wiidrcbtns	Wii U Gamepad trigger button(s)

Sets a held trigger. Requires:

• Element is selected
• Trigger button is pressed and held

SetSimpleTrigger()

void GuiTrigger::SetSimpleTrigger	(	s32	ch,
		u32	wiibtns,
		u16	gcbtns = 0,
		u16	wiidrcbtns = 0
	)

Sets a simple trigger. Requires: element is selected, and trigger button is pressed

Parameters

ch	Controller channel number
wiibtns	Wii controller trigger button(s) - classic controller buttons are considered separately
gcbtns	GameCube controller trigger button(s)
wiidrcbtns	Wii U Gamepad trigger button(s)

Sets a simple trigger. Requires:

• Element is selected
• Trigger button is pressed

TurnWiimote()

void GuiTrigger::TurnWiimote

(

bool

sideways

)

Sets Wiimote orientation

Parameters

sideways

Whether to use it turned sideways

Up()

bool GuiTrigger::Up

(

)

Move menu selection up (via pad/joystick). Allows scroll delay and button overriding

Returns

true if selection should be moved up, false otherwise

WPAD_Stick()

s8 GuiTrigger::WPAD_Stick	(	u8	stick,
		int	axis
	)

Get X or Y value from Wii Joystick (classic, nunchuk) input

Parameters

stick	Controller stick (left = 0, right = 1)
axis	Controller stick axis (x-axis = 0, y-axis = 1)

Returns

Stick value

WPAD_StickX()

s8 GuiTrigger::WPAD_StickX

(

u8

stick

)

Get X value from Wii Joystick (classic, nunchuk) input

Parameters

stick

Controller stick (left = 0, right = 1)

Returns

Stick value

WPAD_StickY()

s8 GuiTrigger::WPAD_StickY

(

u8

stick

)

Get Y value from Wii Joystick (classic, nunchuk) input

Parameters

stick

Controller stick (left = 0, right = 1)

Returns

Stick value

---

The documentation for this class was generated from the following files:

• source/libwiigui/gui_trigger.h
• source/libwiigui/gui_trigger.cpp