Drag[en]gine Game Engine  1.0
deInputSystem Class Reference

Input system acquiring input from the user. More...

#include <deInputSystem.h>

Inheritance diagram for deInputSystem:
deBaseSystem

Public Member Functions

Constructors and Destructors
 deInputSystem (deEngine *engine)
 Create input system. More...
 
virtual ~deInputSystem ()
 Clean up input system. More...
 
Management
deBaseInputModuleGetActiveModule () const
 Active module or NULL if none is active. More...
 
deInputEventQueueGetEventQueue () const
 Input queue. More...
 
void ClearEventQueues ()
 Clear event queues. More...
 
void ScreenSizeChanged ()
 Notify active input module screen size changed. More...
 
void AppActivationChanged ()
 Notify active input module Application activated or deactivated. More...
 
bool GetCaptureInputDevices () const
 Input devices are captured by the active input module if supported. More...
 
void SetCaptureInputDevices (bool captureInputDevices)
 Set if input devices are captured by the active input module if supported. More...
 
Overloadables
virtual void SetActiveModule (deLoadableModule *module)
 
virtual void ClearPermanents ()
 
virtual void PostStart ()
 
virtual void PreStop ()
 
- Public Member Functions inherited from deBaseSystem
 deBaseSystem (deEngine *engine, const char *systemName, int requiredModuleType)
 
virtual ~deBaseSystem ()
 
deEngineGetEngine () const
 
deLoadableModuleGetActiveLoadableModule () const
 
bool GetIsRunning () const
 
bool GetHasFailed () const
 
const char * GetSystemName () const
 
virtual bool CanStart ()
 
void SetHasFailed (bool hasFailed)
 
virtual void Start ()
 
virtual void Stop ()
 
void CheckAndActivateFirst (deModuleSystem::eModuleTypes type)
 
void LogInfo (const char *message)
 
void LogInfoFormat (const char *message,...)
 
void LogInfoFormatUsing (const char *message, va_list args)
 
void LogWarn (const char *message)
 
void LogWarnFormat (const char *message,...)
 
void LogWarnFormatUsing (const char *message, va_list args)
 
void LogError (const char *message)
 
void LogErrorFormat (const char *message,...)
 
void LogErrorFormatUsing (const char *message, va_list args)
 
void LogException (const deException &exception)
 

Detailed Description

Input system acquiring input from the user.

Supported input devices are all devices found on the host system which can be used to provide digital or analog input.

Constructor & Destructor Documentation

◆ deInputSystem()

deInputSystem::deInputSystem ( deEngine engine)

Create input system.

◆ ~deInputSystem()

virtual deInputSystem::~deInputSystem ( )
virtual

Clean up input system.

Member Function Documentation

◆ AppActivationChanged()

void deInputSystem::AppActivationChanged ( )

Notify active input module Application activated or deactivated.

Referenced by GetEventQueue().

◆ ClearEventQueues()

void deInputSystem::ClearEventQueues ( )

Clear event queues.

Referenced by GetEventQueue().

◆ ClearPermanents()

virtual void deInputSystem::ClearPermanents ( )
virtual

Clears cross references and links that could lead to memory leaks. Do not forget to call the super function.

Reimplemented from deBaseSystem.

Referenced by GetCaptureInputDevices().

◆ GetActiveModule()

deBaseInputModule* deInputSystem::GetActiveModule ( ) const
inline

Active module or NULL if none is active.

◆ GetCaptureInputDevices()

bool deInputSystem::GetCaptureInputDevices ( ) const
inline

Input devices are captured by the active input module if supported.

References ClearPermanents(), PostStart(), PreStop(), SetActiveModule(), and SetCaptureInputDevices().

◆ GetEventQueue()

deInputEventQueue& deInputSystem::GetEventQueue ( ) const
inline

◆ PostStart()

virtual void deInputSystem::PostStart ( )
virtual

Carry out here actions right after the system started up.

Reimplemented from deBaseSystem.

Referenced by GetCaptureInputDevices().

◆ PreStop()

virtual void deInputSystem::PreStop ( )
virtual

Carry out here actions right before the system shuts down.

Reimplemented from deBaseSystem.

Referenced by GetCaptureInputDevices().

◆ ScreenSizeChanged()

void deInputSystem::ScreenSizeChanged ( )

Notify active input module screen size changed.

Referenced by GetEventQueue().

◆ SetActiveModule()

virtual void deInputSystem::SetActiveModule ( deLoadableModule module)
virtual

Sets the active loadable module. Do not forget to call the super function.

Reimplemented from deBaseSystem.

Referenced by GetCaptureInputDevices().

◆ SetCaptureInputDevices()

void deInputSystem::SetCaptureInputDevices ( bool  captureInputDevices)

Set if input devices are captured by the active input module if supported.

Referenced by GetCaptureInputDevices().


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