# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLMISC::IInputDevice Struct Reference

Base class that wrap to a device. More...

#include <input_device.h>

Inheritance diagram for NLMISC::IInputDevice:

NLMISC::IGameDevice NLMISC::IKeyboardDevice NLMISC::IMouseDevice List of all members.

Public Methods

virtual bool setBufferSize (uint size)=0
 Set the buffer size for this device (the number of samples it can retains). More...

virtual uint getBufferSize () const=0
 Get the buffer size for this device. More...

virtual ~IInputDevice ()
Device server specifics. You usually don't want to call these
virtual void begin (CEventServer *server)
 For device server usage : Called at the beginning of each events retrieval. More...

virtual void poll (CInputDeviceServer *dev)=0
 For device server usage : Poll all events from that device, and notify them to the given device server, so that they can be sorted between devices. More...

virtual void submit (IInputDeviceEvent *deviceEvent, CEventServer *server)=0
 For device server usage : Process an event (eventually update this device state), and translate the message to a IEventServerMessage. More...

virtual void transitionOccured (CEventServer *server, const IInputDeviceEvent *nextMessage)
 For device server usage : Says that the next message is for another device, or that it is the last message that will be received. More...


Detailed Description

Base class that wrap to a device.

Author:
Nicolas Vizerie , Nevrax France
Date:
2002

Definition at line 48 of file input_device.h.


Constructor & Destructor Documentation

virtual NLMISC::IInputDevice::~IInputDevice   [inline, virtual]
 

Definition at line 85 of file input_device.h.


Member Function Documentation

virtual void NLMISC::IInputDevice::begin CEventServer   server [inline, virtual]
 

For device server usage : Called at the beginning of each events retrieval.

If a device doesn't support buffered datas, the state changes can be directly send to the event server. The default does nothing.

Definition at line 64 of file input_device.h.

virtual uint NLMISC::IInputDevice::getBufferSize   const [pure virtual]
 

Get the buffer size for this device.

virtual void NLMISC::IInputDevice::poll CInputDeviceServer   dev [pure virtual]
 

For device server usage : Poll all events from that device, and notify them to the given device server, so that they can be sorted between devices.

This retrieves messages, but do not process them.

virtual bool NLMISC::IInputDevice::setBufferSize uint    size [pure virtual]
 

Set the buffer size for this device (the number of samples it can retains).

This return true if the size could be set

virtual void NLMISC::IInputDevice::submit IInputDeviceEvent   deviceEvent,
CEventServer   server
[pure virtual]
 

For device server usage : Process an event (eventually update this device state), and translate the message to a IEventServerMessage.

virtual void NLMISC::IInputDevice::transitionOccured CEventServer   server,
const IInputDeviceEvent   nextMessage
[inline, virtual]
 

For device server usage : Says that the next message is for another device, or that it is the last message that will be received.

This allow to pack several messages in one (for example, to sum up mouse moves until a click occurs) The default does nothing. The next message can be used to get a time stamp for example. It may be NULL is no next message is available

Definition at line 81 of file input_device.h.


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