svn merge -r36529:36564 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / intern / ghost / intern / GHOST_EventWheel.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_EventWheel.h
30  *  \ingroup GHOSTeel.h
31  * Declaration of GHOST_EventWheel class.
32  */
33
34 #ifndef _GHOST_EVENT_WHEEL_H_
35 #define _GHOST_EVENT_WHEEL_H_
36
37 #include "GHOST_Event.h"
38
39 /**
40  * Mouse wheel event.
41  * The displacement of the mouse wheel is counted in ticks.
42  * A positive value means the wheel is turned away from the user.
43  * @author      Maarten Gribnau
44  * @date        May 11, 2001
45  */
46 class GHOST_EventWheel : public GHOST_Event
47 {
48 public:
49         /**
50          * Constructor.
51          * @param msec          The time this event was generated.
52          * @param type          The type of this event.
53          * @param z                     The displacement of the mouse wheel.
54          */
55         GHOST_EventWheel(GHOST_TUns64 msec, GHOST_IWindow* window, GHOST_TInt32 z)
56                 : GHOST_Event(msec, GHOST_kEventWheel, window)
57         {
58                 m_wheelEventData.z = z;
59                 m_data = &m_wheelEventData;
60         }
61
62         GHOST_EventWheel(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow* window, char buf[256])
63                 : GHOST_Event(msec, type, window)
64         {
65                 int z;
66                 sscanf(buf, "wheel: %d", &z);
67                 
68                 m_wheelEventData.z = z;
69                 m_data = &m_wheelEventData;
70         }
71         
72         virtual int serialize(char buf[256])
73         {
74                 sprintf(buf, "wheel: %d", m_wheelEventData.z);
75                 
76                 return 0;
77         }
78 protected:
79         /** The z-displacement of the mouse wheel. */
80         GHOST_TEventWheelData m_wheelEventData;
81 };
82
83
84 #endif // _GHOST_EVENT_WHEEL_H_
85