Changeset 3286 for code/branches/core4/src/core/input/InputHandler.h

Timestamp:

Jul 13, 2009, 8:54:43 PM (15 years ago)

Author:

rgrieder

Message:

Added and adjusted documentation for the devices.
Also removed one last ugliness where the InputManager was called from within a device (which should not even know about the InputManager).

File:

• code/branches/core4/src/core/input/InputHandler.h (modified) (3 diffs)

code/branches/core4/src/core/input/InputHandler.h

@@ -26 +26 @@
  *
  */
-
-/**
-@file
-@brief
-    Declarations of various interface classes for the input management.
-*/
 
 #ifndef _InputHandler_H__
@@ -100 +94 @@
     /**
     @brief
+        Base class for all input handlers like KeyBinder, InputBuffer, etc.
+
+        Derive from this class if you wish to receive input events.
+        But keep in mind that this is pointless wihtout first having an InputState.
+    @note
+        The definitions for the button events with the weird arguments are simply
+        to avoid redunant code in the input devices.
     */
     class _CoreExport InputHandler
@@ -140 +141 @@
         virtual void allDevicesUpdated(float dt) { }
 
+        //! Use this input handler if you want to occupy a device in an input state.
         static InputHandler EMPTY;
     };