gf::Control Class Reference

A physical control. More...

#include <gf/Control.h>

Inheritance diagram for gf::Control:

Public Member Functions
	Control ()
	Construct a control. More...
virtual	~Control ()
	Destroy the control. More...
bool	isActive () const
	Check if the control is active. More...
void	setActive (bool active=true)
	Change the active state of the control. More...
void	reset ()
	Desactivate the control. More...
virtual void	processEvent (const Event &event)=0
	Update the state of the control thanks to an event. More...

Detailed Description

A physical control.

Constructor & Destructor Documentation

Control()

gf::Control::Control ( )

inline

Construct a control.

~Control()

virtual gf::Control::~Control ( )

virtual

Destroy the control.

Member Function Documentation

isActive()

bool gf::Control::isActive ( ) const

inline

Check if the control is active.

Returns

true if the control is active.

See also

Action::isActive()

processEvent()

virtual void gf::Control::processEvent ( const Event &  event )

pure virtual

Update the state of the control thanks to an event.

Parameters

event

The event to update the control.

See also

Action::processEvent()

Implemented in gf::KonamiGamepadControl, gf::KonamiKeyboardControl, gf::CloseControl, gf::GamepadAxisControl, gf::GamepadButtonControl, gf::MouseButtonControl, gf::ScancodeKeyControl, and gf::KeycodeKeyControl.

reset()

void gf::Control::reset ( )

inline

Desactivate the control.

This call is equivalent to:

this.setActive(false);

See also

Action::reset()

setActive()

void gf::Control::setActive ( bool  active = true )

inline

Change the active state of the control.

Parameters

active

The new state of the control.