GuiTrigger Class Reference

Input-condition matcher attached to a GuiElement (via setSimpleTrigger() etc.) and evaluated against an InputController - the isClicked()/ isHeld()/isReleased() methods GuiElement::update() calls each frame. More...

#include <GuiTrigger.h>

Public Member Functions
void	setPrimaryTrigger (int ch=-1)
	Semantic Triggers.
void	setSecondaryTrigger (int ch=-1)
void	setSimpleTrigger (int ch, uint32_t buttonMask)
	Sets a simple trigger.
void	setHeldTrigger (int ch, uint32_t buttonMask)
	Sets a held trigger.
void	setButtonOnlyTrigger (int ch, uint32_t buttonMask)
	Sets a button-only trigger.
void	setButtonOnlyInFocusTrigger (int ch, uint32_t buttonMask)
	Sets a button-only trigger.
bool	isClicked (const InputController *controller) const
bool	isHeld (const InputController *controller) const
bool	isReleased (const InputController *controller) const
TRIGGER_TYPE	getType () const
	Accessors.
int	getChannel () const

Detailed Description

Input-condition matcher attached to a GuiElement (via setSimpleTrigger() etc.) and evaluated against an InputController - the isClicked()/ isHeld()/isReleased() methods GuiElement::update() calls each frame.

Definition at line 34 of file GuiTrigger.h.

Constructor & Destructor Documentation

GuiTrigger()

GuiTrigger::GuiTrigger

(

)

Definition at line 9 of file GuiTrigger.cpp.

Member Function Documentation

getChannel()

int GuiTrigger::getChannel ( ) const

inline

Returns

the channel this trigger was configured for (-1 for any channel)

Definition at line 75 of file GuiTrigger.h.

getType()

TRIGGER_TYPE GuiTrigger::getType ( ) const

inline

Accessors.

Definition at line 73 of file GuiTrigger.h.

isClicked()

bool GuiTrigger::isClicked

(

const InputController *

controller

)

const

Returns

true if this trigger's condition is currently met on controller

Definition at line 81 of file GuiTrigger.cpp.

isHeld()

bool GuiTrigger::isHeld

(

const InputController *

controller

)

const

Returns

true if this trigger's condition is currently met on controller

Definition at line 90 of file GuiTrigger.cpp.

isReleased()

bool GuiTrigger::isReleased

(

const InputController *

controller

)

const

Returns

true if this trigger's condition was met on controller last frame but not this frame

Definition at line 99 of file GuiTrigger.cpp.

setButtonOnlyInFocusTrigger()

void GuiTrigger::setButtonOnlyInFocusTrigger	(	int	ch,
		uint32_t	buttonMask )

Sets a button-only trigger.

Requires: trigger button is pressed and parent window is in focus

Parameters

ch	Controller channel number (-1 for any channel)
buttonMask	Logical GuiButton bitmask

Definition at line 51 of file GuiTrigger.cpp.

setButtonOnlyTrigger()

void GuiTrigger::setButtonOnlyTrigger	(	int	ch,
		uint32_t	buttonMask )

Sets a button-only trigger.

Requires: Trigger button is pressed

Parameters

ch	Controller channel number (-1 for any channel)
buttonMask	Logical GuiButton bitmask

Definition at line 44 of file GuiTrigger.cpp.

setHeldTrigger()

void GuiTrigger::setHeldTrigger	(	int	ch,
		uint32_t	buttonMask )

Sets a held trigger.

Requires: element is selected, and trigger button is held

Parameters

ch	Controller channel number (-1 for any channel)
buttonMask	Logical GuiButton bitmask

Definition at line 37 of file GuiTrigger.cpp.

setPrimaryTrigger()

void GuiTrigger::setPrimaryTrigger

(

int

ch = -1

)

Semantic Triggers.

Definition at line 16 of file GuiTrigger.cpp.

setSecondaryTrigger()

void GuiTrigger::setSecondaryTrigger

(

int

ch = -1

)

Parameters

ch	Controller channel number (-1 for any channel)

Definition at line 23 of file GuiTrigger.cpp.

setSimpleTrigger()

void GuiTrigger::setSimpleTrigger	(	int	ch,
		uint32_t	buttonMask )

Sets a simple trigger.

Requires: element is selected, and trigger button is pressed

Parameters

ch	Controller channel number (-1 for any channel)
buttonMask	Logical GuiButton bitmask

Definition at line 30 of file GuiTrigger.cpp.

---

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

• source/libgui/GuiTrigger.h
• source/libgui/GuiTrigger.cpp