merge with/from trunk at r35190
[blender.git] / intern / ghost / intern / GHOST_Event.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/intern/GHOST_Event.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_Event class.
32  */
33
34 #ifndef _GHOST_EVENT_H_
35 #define _GHOST_EVENT_H_
36
37 #include "GHOST_IEvent.h"
38
39 /* INTEGER CODES */
40 #if defined(__sgi) || defined (__sparc) || defined (__sparc__) || defined (__PPC__) || defined (__ppc__) || defined (__hppa__) || defined (__BIG_ENDIAN__)
41         /* Big Endian */
42 #define MAKE_ID(a,b,c,d) ( (int)(a)<<24 | (int)(b)<<16 | (c)<<8 | (d) )
43 #else
44         /* Little Endian */
45 #define MAKE_ID(a,b,c,d) ( (int)(d)<<24 | (int)(c)<<16 | (b)<<8 | (a) )
46 #endif
47
48 /**
49  * Base class for events received the operating system.
50  * @author      Maarten Gribnau
51  * @date        May 11, 2001
52  */
53 class GHOST_Event : public GHOST_IEvent
54 {
55 public:
56         /**
57          * Constructor.
58          * @param msec  The time this event was generated.
59          * @param type  The type of this event.
60          * @param window The generating window (or NULL if system event).
61          */
62         GHOST_Event(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window)
63                 : m_type(type), m_time(msec), m_window(window), m_data(0)
64         {
65         }
66
67         /**
68          * Returns the event type.
69          * @return The event type.
70          */
71         virtual GHOST_TEventType getType()
72         { 
73                 return m_type;
74         }
75
76         /**
77          * Returns the time this event was generated.
78          * @return The event generation time.
79          */
80         virtual GHOST_TUns64 getTime()
81         {
82                 return m_time;
83         }
84
85         virtual void setTime(GHOST_TUns64 t)
86         {
87                 m_time = t;
88         }
89         
90
91         /**
92          * Returns the window this event was generated on, 
93          * or NULL if it is a 'system' event.
94          * @return The generating window.
95          */
96         virtual GHOST_IWindow* getWindow()
97         {
98                 return m_window;
99         }
100
101         /**
102          * Returns the event data.
103          * @return The event data.
104          */
105         virtual GHOST_TEventDataPtr getData()
106         {
107                 return m_data;
108         }
109         
110         virtual void setPlaybackModifierKeys(GHOST_ModifierKeys keys)
111         {
112                 m_playmods = keys;
113         }
114
115         virtual void getPlaybackModifierKeys(GHOST_ModifierKeys &keys)
116         {
117                 keys = m_playmods;
118         }
119
120         virtual void setPlaybackCursor(GHOST_TInt32 mx, GHOST_TInt32 my)
121         {
122                 x = mx;
123                 y = my;
124         }
125
126         virtual void getPlaybackCursor(GHOST_TInt32 &mx, GHOST_TInt32 &my)
127         {
128                 mx = x;
129                 my = y;
130         }
131         
132 protected:
133         /** Type of this event. */
134         GHOST_TEventType m_type;
135         /** The time this event was generated. */
136         GHOST_TUns64 m_time;
137         /** Pointer to the generating window. */
138         GHOST_IWindow* m_window;
139         /** Pointer to the event data. */
140         GHOST_TEventDataPtr m_data;
141         
142         /** Modifier key state during event playback **/
143         GHOST_ModifierKeys m_playmods;
144         /** Mouse cursor state during event playback **/
145         GHOST_TInt32 x, y;
146 };
147
148 #endif // _GHOST_EVENT_H_
149