gf::Action Class Reference

An action that can be triggered by different controls. More...

#include <gf/Action.h>

Public Member Functions
	Action (std::string name)
	Construct an action with a name. More...
	Action (const Action &)=delete
	Deleted copy constructor. More...
Action &	operator= (const Action &)=delete
	Deleted copy assignment. More...
const std::string &	getName () const
	Get the name of the action. More...
Type of the action
void	setContinuous ()
	Set the action continuous. More...
bool	isContinuous () const
	Check if the action is continuous. More...
void	setInstantaneous ()
	Set the action instantaneous. More...
bool	isInstantaneous () const
	Check if the action is instantaneous. More...
Controls for the action
void	addKeycodeKeyControl (Keycode code)
	Add a key control. More...
void	addScancodeKeyControl (Scancode code)
	Add a key control. More...
void	addMouseButtonControl (MouseButton button)
	Add a mouse button control. More...
void	addGamepadButtonControl (GamepadId id, GamepadButton button)
	Add a gamepad button control. More...
void	addGamepadAxisControl (GamepadId id, GamepadAxis axis, GamepadAxisDirection dir)
	Add a gamepad axis control. More...
void	addCloseControl ()
	Add a close control. More...
void	addControl (Control &control)
	Add a user-defined control. More...
State of the action
void	processEvent (const Event &event)
	Update the state of the action thanks to an event. More...
bool	isActive () const
	Check if the action is active. More...
void	reset ()
	Reset the state of the action. More...

Detailed Description

An action that can be triggered by different controls.

An action can be continuous or instantaneous. A continuous action is an action that is active as long as the user do not desactivate it. An instantaneous action is an action that is triggered only once when it is active. By default, the action is instantaneous.

See also

gf::Control

Constructor & Destructor Documentation

Action() [1/2]

gf::Action::Action ( std::string  name )

explicit

Construct an action with a name.

Parameters

name	the name of the action.

Action() [2/2]

gf::Action::Action ( const Action &  )

delete

Deleted copy constructor.

Member Function Documentation

addCloseControl()

void gf::Action::addCloseControl

(

)

Add a close control.

See also

CloseControl

addControl()

void gf::Action::addControl

(

Control &

control

)

Add a user-defined control.

Parameters

control

The control

addGamepadAxisControl()

void gf::Action::addGamepadAxisControl	(	GamepadId	id,
		GamepadAxis	axis,
		GamepadAxisDirection	dir
	)

Add a gamepad axis control.

Parameters

id	the id of the gamepad.
axis	the axis of the gamepad.
dir	the direction of the axis of the gamepad.

See also

GamepadAxisControl

addGamepadButtonControl()

void gf::Action::addGamepadButtonControl	(	GamepadId	id,
		GamepadButton	button
	)

Add a gamepad button control.

Parameters

id	the id of the gamepad.
button	the button of the gamepad

See also

GamepadButtonControl

addKeycodeKeyControl()

void gf::Action::addKeycodeKeyControl

(

Keycode

code

)

Add a key control.

Parameters

code	the keycode of the key

See also

KeycodeKeyControl

addMouseButtonControl()

void gf::Action::addMouseButtonControl

(

MouseButton

button

)

Add a mouse button control.

Parameters

button

the button of the mouse.

See also

MouseButtonControl

addScancodeKeyControl()

void gf::Action::addScancodeKeyControl

(

Scancode

code

)

Add a key control.

Parameters

code	the scancode of the key

See also

ScancodeKeyControl

getName()

const std::string & gf::Action::getName ( ) const

inline

Get the name of the action.

Returns

the name of the action.

isActive()

bool gf::Action::isActive

(

)

const

Check if the action is active.

An action is active if at least one of its control is active.

Returns

true if the action is active.

See also

Control::isActive()

isContinuous()

bool gf::Action::isContinuous

(

)

const

Check if the action is continuous.

Returns

true if the action is continuous.

isInstantaneous()

bool gf::Action::isInstantaneous

(

)

const

Check if the action is instantaneous.

Returns

true if the action is instantaneous.

operator=()

Action & gf::Action::operator= ( const Action &  )

delete

Deleted copy assignment.

processEvent()

void gf::Action::processEvent

(

const Event &

event

)

Update the state of the action thanks to an event.

Parameters

event

the event to update the action.

See also

Control::processEvent()

reset()

void gf::Action::reset

(

)

Reset the state of the action.

This function depends of the type of the action.

See also

setContinuous(), setInstantaneous(), Control::reset()

setContinuous()

void gf::Action::setContinuous

(

)

Set the action continuous.

A continuous action is an action that is active as long as the user do not desactivate it. A reset() call does not desactivate the action.

See also

reset(), setInstantaneous()

setInstantaneous()

void gf::Action::setInstantaneous

(

)

Set the action instantaneous.

An instantaneous action is an action that is active until the next reset() call.

See also

reset(), setContinuous()