File: virtual-mouse.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (90 lines) | stat: -rw-r--r-- 2,747 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef BACKENDS_KEYMAPPER_VIRTUAL_MOUSE_H
#define BACKENDS_KEYMAPPER_VIRTUAL_MOUSE_H

#include "common/scummsys.h"

#include "common/events.h"

namespace Common {

class EventDispatcher;
class Keymap;

/**
 * The Virtual Mouse can produce mouse move events on systems without a physical mouse.
 *
 * It is useful for moving the mouse cursor using a gamepad or a keyboard.
 *
 * This class defines a keymap with actions for moving the cursor in all four directions.
 * The keymapper produces custom backend events whenever keys bound to these actions are
 * pressed. This class handles the events through its EventObserver interface and produces
 * mouse move events when necesssary through its EventSource interface.
 */
class VirtualMouse : public EventSource, public EventObserver {
public:
	VirtualMouse(EventDispatcher *eventDispatcher);
	~VirtualMouse() override;

	// EventSource API
	bool pollEvent(Event &event) override;

	// EventObserver API
	bool notifyEvent(const Event &event) override;

	/** Add the virtual mouse keymapper actions to a keymap */
	void addActionsToKeymap(Keymap *keymap);

private:
	static const int32 kUpdateDelay = 12;
	static const int32 kDefaultScreenWidth = 640;

	enum {
		kCustomActionVirtualAxisUp    = 10000,
		kCustomActionVirtualAxisDown  = 10001,
		kCustomActionVirtualAxisLeft  = 10002,
		kCustomActionVirtualAxisRight = 10003,
		kCustomActionVirtualMouseSlow = 10004
	};

	void handleAxisMotion(int16 axisPositionX, int16 axisPositionY);
	float computeJoystickMouseSpeedFactor() const;

	EventDispatcher *_eventDispatcher;

	int16 _inputAxisPositionX;
	int16 _inputAxisPositionY;

	float _mouseVelocityX;
	float _mouseVelocityY;
	float _slowModifier;

	float _subPixelRemainderX;
	float _subPixelRemainderY;

	uint32 _lastUpdateMillis;
};

} // End of namespace Common

#endif // #ifndef BACKENDS_KEYMAPPER_VIRTUAL_MOUSE_H