"""
ggame events are objects that are created by the ggame system as a result of
some user action (mouse, keyboard). If the ggame application has called
:meth:`~ggame.app.App.listenKeyEvent` or :meth:`~ggame.app.App.listenMouseEvent` then
an appropriate Event object is instantiated by ggame and returned to a
user-provided handler function. The ggame user code should examine the
attributes of the Event object to find out more information about the event that
occurred.
"""
import traceback
class _Event:
def __init__(self, hwevent):
self.hwevent = hwevent
self.type = hwevent.type
"""String representing the type of received system event."""
self.consumed = False
"""
Set the `consumed` member of the event to prevent the event
from being received by any more handler methods.
"""
def route(self, evtlist):
"""
Execute all callbacks configured for this event.
"""
for callback in reversed(evtlist):
if not self.consumed:
try:
callback(self)
except BaseException:
traceback.print_exc()
raise
[docs]
class MouseEvent(_Event):
"""
A MouseEvent object encapsulates information about a user mouse
action that is being reported by the system. This class is not instantiated
by the ggame user.
"""
mousemove = "mousemove"
mousedown = "mousedown"
mouseup = "mouseup"
click = "click"
dblclick = "dblclick"
mousewheel = "wheel"
def __init__(self, app, hwevent):
"""
The event is initialized by the system, with a `hwevent` input parameter.
"""
super().__init__(hwevent)
self.wheeldelta = 0
"""Integer representing up/down motion of the scroll wheel."""
if self.type == self.mousewheel:
self.wheeldelta = hwevent.deltaY
else:
self.wheeldelta = 0
rect = app.win.renderer.view.getBoundingClientRect()
xscale = app.win.width / rect.width
yscale = app.win.height / rect.height
self.x = (hwevent.clientX - rect.left) * xscale
"""The window x-coordinate of the mouse pointer when the event occurred."""
self.y = (hwevent.clientY - rect.top) * yscale
"""The window y-coordinate of the mouse pointer when the event occurred."""
[docs]
class KeyEvent(_Event):
"""
A KeyEvent object encapsulates information regarding a user keyboard
action that is being reported by the system. This class is not instantiated
by the ggame user.
"""
no_location = 0
right_location = 2
left_location = 1
keydown = "keydown"
keyup = "keyup"
keypress = "keypress"
keys = {
8: "backspace",
9: "tab",
13: "enter",
16: "shift",
17: "ctrl",
18: "alt",
19: "pause/break",
20: "caps lock",
27: "escape",
32: "space",
33: "page up",
34: "page down",
35: "end",
36: "home",
37: "left arrow",
38: "up arrow",
39: "right arrow",
40: "down arrow",
45: "insert",
46: "delete",
48: "0",
49: "1",
50: "2",
51: "3",
52: "4",
53: "5",
54: "6",
55: "7",
56: "8",
57: "9",
65: "a",
66: "b",
67: "c",
68: "d",
69: "e",
70: "f",
71: "g",
72: "h",
73: "i",
74: "j",
75: "k",
76: "l",
77: "m",
78: "n",
79: "o",
80: "p",
81: "q",
82: "r",
83: "s",
84: "t",
85: "u",
86: "v",
87: "w",
88: "x",
89: "y",
90: "z",
91: "left window key",
92: "right window key",
93: "select key",
96: "numpad 0",
97: "numpad 1",
98: "numpad 2",
99: "numpad 3",
100: "numpad 4",
101: "numpad 5",
102: "numpad 6",
103: "numpad 7",
104: "numpad 8",
105: "numpad 9",
106: "multiply",
107: "add",
109: "subtract",
110: "decimal point",
111: "divide",
112: "f1",
113: "f2",
114: "f3",
115: "f4",
116: "f5",
117: "f6",
118: "f7",
119: "f8",
120: "f9",
121: "f10",
122: "f11",
123: "f12",
144: "num lock",
145: "scroll lock",
186: "semicolon",
187: "equal sign",
188: "comma",
189: "dash",
190: "period",
191: "forward slash",
192: "grave accent",
219: "open bracket",
220: "back slash",
221: "close bracket",
222: "single quote",
}
"""Dictionary mapping key code integers to textual key description."""
def __init__(self, hwevent):
"""
The event is initialized by the system, with a `hwevent` input parameter.
"""
super().__init__(hwevent)
self.keynum = hwevent.keyCode
"""The `keynum` attribute identifies a keycode (number)."""
self.key = self.keys[hwevent.keyCode]
"""
The `key` attribute identifes the key in text form (e.g. 'back slash').
The list of key numbers and description strings follows::
8: 'backspace',
9: 'tab',
13: 'enter',
16: 'shift',
17: 'ctrl',
18: 'alt',
19: 'pause/break',
20: 'caps lock',
27: 'escape',
32: 'space',
33: 'page up',
34: 'page down',
35: 'end',
36: 'home',
37: 'left arrow',
38: 'up arrow',
39: 'right arrow',
40: 'down arrow',
45: 'insert',
46: 'delete',
48: '0',
49: '1',
50: '2',
51: '3',
52: '4',
53: '5',
54: '6',
55: '7',
56: '8',
57: '9',
65: 'a',
66: 'b',
67: 'c',
68: 'd',
69: 'e',
70: 'f',
71: 'g',
72: 'h',
73: 'i',
74: 'j',
75: 'k',
76: 'l',
77: 'm',
78: 'n',
79: 'o',
80: 'p',
81: 'q',
82: 'r',
83: 's',
84: 't',
85: 'u',
86: 'v',
87: 'w',
88: 'x',
89: 'y',
90: 'z',
91: 'left window key',
92: 'right window key',
93: 'select key',
96: 'numpad 0',
97: 'numpad 1',
98: 'numpad 2',
99: 'numpad 3',
100: 'numpad 4',
101: 'numpad 5',
102: 'numpad 6',
103: 'numpad 7',
104: 'numpad 8',
105: 'numpad 9',
106: 'multiply',
107: 'add',
109: 'subtract',
110: 'decimal point',
111: 'divide',
112: 'f1',
113: 'f2',
114: 'f3',
115: 'f4',
116: 'f5',
117: 'f6',
118: 'f7',
119: 'f8',
120: 'f9',
121: 'f10',
122: 'f11',
123: 'f12',
144: 'num lock',
145: 'scroll lock',
186: 'semicolon',
187: 'equal sign',
188: 'comma',
189: 'dash',
190: 'period',
191: 'forward slash',
192: 'grave accent',
219: 'open bracket',
220: 'back slash',
221: 'close bracket',
222: 'single quote'
"""