OSDL: OSDL::MVC::Controller Class Reference

As these controllers have to be able to listen to various input devices, all specific method handlers (such as axisChanged) have to be defined. Their default implementation is basically a do-nothing method, only adding logs if in debug mode. This way, the controllers being instanciated in the application, which are child classes of these OSDL::Events::Controller, just have to override the handlers corresponding to the specific events they want to listen to : not defining an handler does not prevent from instanciating the controller.

These controllers must have a total control of the input devices they are linked to. This hinders abstracting events to simplify their management : for example, one cannot say that an increasing joystick axis value means in all cases the same as, say, the mouse being pushed forward or the right arrow key being pressed.

Therefore the controllers are tightly linked to the input devices, and they will be in charge of converting these low level input events into higher level object-specific events.

One of the consequences is that for event propagation an abstract Ceylan::Controller is not suitable : one cannot call such specific methods like axisChanged. That is the explanation too for the OSDL::Events::Controller::getActualController method.

Some basic abstraction efforts are done, though. For example, according to the keyboard mode (raw or text), the controller is notified differently for more versality.

Similarly, if a controller is linked with a classical joystick, the joystick actual direction will be reported thanks to the joystickLeft, joystickRight, joystickUp and joystickDown methods instead of the unspecialized axisChanged method. Same thing for joystick{First|Second}Button{Pressed|Released}.

However, most modelings of AI behaviours will have to fit into the controller interface. Basically, the AI of, say, a driver, should be uncoupled from the physics that apply to his car. In this case, the driver is only a particular controller for that car, and its only options may be for him to steer the wheel or press the gas pedal. Whatever is the cause of these actions, this is the task of the model to take them into account and update the object state accordingly.

AI-based controllers may inherit from active objects, so that they can be scheduled as well.

Definition at line 86 of file OSDLController.h.


Public Member Functions
	Controller () throw ()
	Constructs a new controller.
	Controller (Ceylan::Model &model) throw ()
	Constructs a controller that will send events to the specified model.
virtual	~Controller () throw ()
	Virtual destructor.
virtual void	keyboardFocusGained (const FocusEvent &keyboardFocusEvent) throw ()
	Called whenever a keyboard linked to this controller has gained focus.
virtual void	keyboardFocusLost (const FocusEvent &keyboardFocusEvent) throw ()
	Called whenever a keyboard linked to this controller has lost focus.
virtual void	rawKeyPressed (const KeyboardEvent &keyboardPressedEvent) throw ()
	Called whenever a raw key linked to this controller has been pressed.
virtual void	rawKeyReleased (const KeyboardEvent &keyboardReleasedEvent) throw ()
	Called whenever a raw key linked to this controller has been released.
virtual void	unicodeSelected (const KeyboardEvent &keyboardPressedEvent) throw ()
	Called whenever a Unicode character linked to this controller has been selected.
virtual void	mouseFocusGained (const FocusEvent &mouseFocusEvent) throw ()
	Called whenever a mouse linked to this controller has gained focus.
virtual void	mouseFocusLost (const FocusEvent &mouseFocusEvent) throw ()
	Called whenever a mouse linked to this controller has lost focus.
virtual void	mouseMoved (const MouseMotionEvent &mouseMotionEvent) throw ()
	Called whenever a mouse linked to this controller moved.
virtual void	mouseButtonPressed (const MouseButtonEvent &mouseButtonPressedEvent) throw ()
	Called whenever a mouse linked to this controller had one of its buttons pressed.
virtual void	mouseButtonReleased (const MouseButtonEvent &mouseButtonReleasedEvent) throw ()
	Called whenever a mouse linked to this controller had one of its buttons released.
virtual void	joystickAxisChanged (const JoystickAxisEvent &joystickAxisEvent) throw ()
	Called whenever a joystick linked to this controller had one of its axes changed.
virtual void	joystickTrackballChanged (const JoystickTrackballEvent &joystickTrackballEvent) throw ()
	Called whenever a joystick linked to this controller had one of its trackballs changed.
virtual void	joystickHatChanged (const JoystickHatEvent &joystickHatChangedEvent) throw ()
	Called whenever a joystick linked to this controller had one of its hats changed.
virtual void	joystickButtonPressed (const JoystickButtonEvent &joystickButtonPressedEvent) throw ()
	Called whenever a joystick linked to this controller had one of its buttons pressed.
virtual void	joystickButtonReleased (const JoystickButtonEvent &joystickButtonReleasedEvent) throw ()
	Called whenever a joystick linked to this controller had one of its buttons changed.
virtual void	joystickLeft (Events::AxisPosition leftExtent) throw ()
	Called whenever the classical joystick linked to this controller is pushed to the left.
virtual void	joystickRight (Events::AxisPosition rightExtent) throw ()
	Called whenever the classical joystick linked to this controller is pushed to the right.
virtual void	joystickUp (Events::AxisPosition upExtent) throw ()
	Called whenever the classical joystick linked to this controller is pushed up.
virtual void	joystickDown (Events::AxisPosition downExtent) throw ()
	Called whenever the classical joystick linked to this controller is pushed down.
virtual void	joystickFirstButtonPressed () throw ()
	Called whenever the first button of the classical joystick linked to this controller, if any, is pressed.
virtual void	joystickFirstButtonReleased () throw ()
	Called whenever the first button of the classical joystick linked to this controller, if any, is released.
virtual void	joystickSecondButtonPressed () throw ()
	Called whenever the second button of the classical joystick linked to this controller, if any, is pressed.
virtual void	joystickSecondButtonReleased () throw ()
	Called whenever the second button of the classical joystick linked to this controller, if any, is released.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const throw ()
	Returns an user-friendly description of the state of this object.
Private Member Functions
	Controller (const Controller &source) throw ()
	Copy constructor made private to ensure that it will never be called.
Controller &	operator= (const Controller &source) throw ()
	Assignment operator made private to ensure that it will never be called.

Constructor & Destructor Documentation

Controller::Controller ( ) throw ()

Constructs a new controller.

Definition at line 34 of file OSDLController.cc.

Controller::Controller ( Ceylan::Model & model ) throw () [explicit]

Constructs a controller that will send events to the specified model.

Definition at line 41 of file OSDLController.cc.

Controller::~Controller ( ) throw () [virtual]

Virtual destructor.

Definition at line 48 of file OSDLController.cc.

OSDL::MVC::Controller::Controller ( const Controller & source ) throw () [explicit, private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

Member Function Documentation

void Controller::keyboardFocusGained ( const FocusEvent & keyboardFocusEvent ) throw () [virtual]

Called whenever a keyboard linked to this controller has gained focus.

Note:: This method is meant to be overriden so that this controller can react to this event.

Definition at line 58 of file OSDLController.cc.

OSDL::MVC::Controller Class Reference

Detailed Description

Public Member Functions

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation