events.h

Go to the documentation of this file.
00001 /*
00002  * events.h
00003  *
00004  * Copyright (C) 2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  */
00031 
00032 #ifndef AESOP_GLUT_APP_EVENTS_H__
00033 #define AESOP_GLUT_APP_EVENTS_H__
00034 
00035 // includes --------------------------------------------------------------------
00036 #include "common/common.h"
00037 
00038 
00039 // forward declarations
00040 class Datahash;
00041 
00042 
00043 namespace aesop {
00044 
00045 /// \ingroup glut_app
00046 /*@{*/
00047 
00048 
00049 /// where is the given event coming from?
00050 enum eDevice {
00051         eDevice_Keyboard        = 1,    ///< event is from keyboard
00052         eDevice_Mouse           = 2,    ///< event is from mouse
00053         eDevice_Gamepad         = 3,    ///< event is from gamepad
00054 
00055         // keep this last!
00056         eDevice_Invalid         = 0
00057 };
00058 
00059 
00060 
00061 /// what is the nature of the given event?
00062 enum eEvent {
00063         eEvent_Press            = 1,    ///< this is a button press
00064         eEvent_Release          = 2,    ///< this is a button release
00065 
00066         // keep this last!
00067         eEvent_Invalid          = 0
00068 };
00069 
00070 
00071 
00072 /// A general events event.  Typicaly this is a button press or release.
00073 struct event_t {
00074         // constructor, manipulators
00075         event_t(void) throw() { this->clear(); }
00076         void clear(void) throw() {
00077                         device = eDevice_Invalid;
00078                         event = eEvent_Invalid;
00079                         item = -1;
00080                 }
00081 
00082         // data fields
00083         eDevice                 device;
00084         eEvent                  event;
00085         int                     item;   ///< key or button index on device
00086 };
00087 
00088 
00089 
00090 };      // aesop namespace
00091 
00092 #endif  // AESOP_GLUT_APP_EVENTS_H__
00093