aurorafw.core.input.events source code

1 /*
2                                     __
3                                    / _|
4   __ _ _   _ _ __ ___  _ __ __ _  | |_ ___  ___ ___
5  / _` | | | | '__/ _ \| '__/ _` | |  _/ _ \/ __/ __|
6 | (_| | |_| | | | (_) | | | (_| | | || (_) \__ \__ \
7  \__,_|\__,_|_|  \___/|_|  \__,_| |_| \___/|___/___/
8 
9 Copyright (C) 2018-2019 Aurora Free Open Source Software.
10 
11 This file is part of the Aurora Free Open Source Software. This
12 organization promote free and open source software that you can
13 redistribute and/or modify under the terms of the GNU Lesser General
14 Public License Version 3 as published by the Free Software Foundation or
15 (at your option) any later version approved by the Aurora Free Open Source
16 Software Organization. The license is available in the package root path
17 as 'LICENSE' file. Please review the following information to ensure the
18 GNU Lesser General Public License version 3 requirements will be met:
19 https://www.gnu.org/licenses/lgpl.html .
20 
21 Alternatively, this file may be used under the terms of the GNU General
22 Public License version 3 or later as published by the Free Software
23 Foundation. Please review the following information to ensure the GNU
24 General Public License requirements will be met:
25 http://www.gnu.org/licenses/gpl-3.0.html.
26 
27 NOTE: All products, services or anything associated to trademarks and
28 service marks used or referenced on this file are the property of their
29 respective companies/owners or its subsidiaries. Other names and brands
30 may be claimed as the property of others.
31 
32 For more info about intellectual property visit: aurorafoss.org or
33 directly send an email to: contact (at) aurorafoss.org .
34 */
35 
36 module aurorafw.core.input.events;
37 
38 import aurorafw.core.input.keys;
39 
40 
41 /**
42  * Keyboard Event
43  *
44  * This represents a keyboard event with keycode
45  * and input modifiers
46  *
47  * Examples:
48  * --------------------
49  * auto ke = KeyboardEvent(Keycode.A, InputModifier.Control | InputModifier.Alt);
50  * --------------------
51  */
52 struct KeyboardEvent {
53 	Keycode key;
54 	InputModifier mods;
55 }
56 
57 
58 /**
59  * Mouse Button Event
60  *
61  * This represents a mouse button event with
62  * button id and input modifiers
63  *
64  * Examples:
65  * --------------------
66  * auto mbe = MouseButtonEvent(InputButton.B1, InputModifier.None);
67  * --------------------
68  */
69 struct MouseButtonEvent {
70 	InputButton btn;
71 	InputModifier mods;
72 }
73 
74 
75 /**
76  * Mouse Motion Event
77  *
78  * This represents a mouse motion event with
79  * x and y position.
80  *
81  * Examples:
82  * --------------------
83  * auto mme = MouseMotionEvent(0.5, -0.4);
84  * --------------------
85  */
86 struct MouseMotionEvent {
87 	double xpos, ypos;
88 }
89 
90 
91 /**
92  * Mouse Scroll Event
93  *
94  * This represents a mouse scroll event with
95  * x and y position offset.
96  *
97  * Examples:
98  * --------------------
99  * auto mse = MouseScrollEvent(-1.0, 0);
100  * --------------------
101  */
102 struct MouseScrollEvent {
103 	double xoffset, yoffset;
104 }
105 
106 
107 /**
108  * Touch Finger Event
109  *
110  * This represents a touch finger event with,
111  * deslocated x and y, x and y position and
112  * finger ID
113  *
114  * Examples:
115  * --------------------
116  * auto tfe = TouchFingerEvent(1.0f, 1.0f, 0.5f, 0.4f, 1);
117  * --------------------
118  */
119 struct TouchFingerEvent {
120 	float dx, dy;
121 	float x, y;
122 	ubyte fingerID;
123 }