ControlEventHandler Class Reference

Abstract class for handling controls (similar to a GUIEventHandler, but for PVLE's controls). More...

#include <ControlMapper.h>

Inheritance diagram for ControlEventHandler:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool handleEvent (NetControlEvent *pEvent, TNL::EventConnection *pConnection)=0
 Handle "one-shot" events (Key pressed for firing, for example).
virtual void onAddedToControler (Controler *pControler)
 Callback invoked when this event handler is associated with a Controler.
virtual void onRemovedFromControler (const Controler *pControler)

Protected Member Functions

virtual ~ControlEventHandler ()
 Protected destructor forces the object to be deleted by being dereferenced.


Detailed Description

Abstract class for handling controls (similar to a GUIEventHandler, but for PVLE's controls).

Author:
Sukender
Version:
0.2.0

Definition at line 54 of file ControlMapper.h.


Constructor & Destructor Documentation

virtual ControlEventHandler::~ControlEventHandler (  )  [inline, protected, virtual]

Protected destructor forces the object to be deleted by being dereferenced.

Also avoids the object from beeing created on the stack.

Definition at line 70 of file ControlMapper.h.


Member Function Documentation

virtual bool ControlEventHandler::handleEvent ( NetControlEvent pEvent,
TNL::EventConnection pConnection 
) [pure virtual]

Handle "one-shot" events (Key pressed for firing, for example).

If pConnection parameter is not NULL, then the event should be considered as a client event (generally sent instead if processed).

Returns:
true if the event is handled, ie. should not be processed by other handlers. Returning true DOES NOT MEAN that the corresponding (mapped) OSG input is handled ! Handling controls is different from OSG.
Warning:
This is called on event thread (generally GFX thread).

Implemented in HumanMatrixGetter.

virtual void ControlEventHandler::onAddedToControler ( Controler pControler  )  [inline, virtual]

Callback invoked when this event handler is associated with a Controler.

Reimplemented in ControlHandler.

Definition at line 64 of file ControlMapper.h.

Referenced by ControlMapper::addHandlerBack(), and ControlMapper::replaceHandler().

virtual void ControlEventHandler::onRemovedFromControler ( const Controler pControler  )  [inline, virtual]

Reimplemented in ControlHandler.

Definition at line 65 of file ControlMapper.h.

Referenced by ControlMapper::removeHandler(), and ControlMapper::replaceHandler().


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

Generated on Sun Jan 17 11:39:27 2010 for PVLE (Pro-Vocation Light Engine) by  doxygen 1.5.9