-
Notifications
You must be signed in to change notification settings - Fork 369
Expand file tree
/
Copy pathTouchManager.cs
More file actions
337 lines (281 loc) · 12.4 KB
/
TouchManager.cs
File metadata and controls
337 lines (281 loc) · 12.4 KB
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/*
* @author Valentin Simonov / http://va.lent.in/
*/
using System;
using System.Collections.Generic;
using TouchScript.Devices.Display;
using TouchScript.Layers;
using TouchScript.Utils.Attributes;
using UnityEngine;
using Object = UnityEngine.Object;
namespace TouchScript
{
/// <summary>
/// A façade object to configure and hold parameters for an instance of <see cref="ITouchManager"/>. Contains constants used throughout the library.
/// <seealso cref="ITouchManager"/>
/// </summary>
/// <remarks>
/// <para>An instance of <see cref="TouchManager"/> may be added to a Unity scene to hold (i.e. serialize them to the scene) parameters needed to configure an instance of <see cref="ITouchManager"/> used in application. Which can be accessed via <see cref="TouchManager.Instance"/> static property.</para>
/// <para>Though it's not required it is a convenient way to configure <b>TouchScript</b> for your scene. You can use different configuration options for different scenes.</para>
/// </remarks>
/// <example>
/// This sample shows how to get Touch Manager instance and subscribe to events.
/// <code>
/// TouchManager.Instance.TouchesBegan +=
/// (sender, args) => { foreach (var touch in args.Touches) Debug.Log("Began: " + touch.Id); };
/// TouchManager.Instance.TouchesEnded +=
/// (sender, args) => { foreach (var touch in args.Touches) Debug.Log("Ended: " + touch.Id); };
/// </code>
/// </example>
[AddComponentMenu("TouchScript/Touch Manager")]
public sealed class TouchManager : MonoBehaviour
{
#region Constants
/// <summary>
/// Values of a bit-mask representing which Unity messages an instance of <see cref="TouchManager"/> will dispatch.
/// </summary>
[Flags]
public enum MessageType
{
/// <summary>
/// Touch frame started.
/// </summary>
FrameStarted = 1 << 0,
/// <summary>
/// Touch frame finished.
/// </summary>
FrameFinished = 1 << 1,
/// <summary>
/// Some touches have begun during the frame.
/// </summary>
TouchesBegan = 1 << 2,
/// <summary>
/// Some touches have moved during the frame.
/// </summary>
TouchesMoved = 1 << 3,
/// <summary>
/// Some touches have ended during the frame.
/// </summary>
TouchesEnded = 1 << 4,
/// <summary>
/// Some touches were cancelled during the frame.
/// </summary>
TouchesCancelled = 1 << 5
}
/// <summary>
/// Names of dispatched Unity messages.
/// </summary>
public enum MessageName
{
/// <summary>
/// Touch frame started.
/// </summary>
OnTouchFrameStarted = MessageType.FrameStarted,
/// <summary>
/// Touch frame finished.
/// </summary>
OnTouchFrameFinished = MessageType.FrameFinished,
/// <summary>
/// Some touches have begun during the frame.
/// </summary>
OnTouchesBegan = MessageType.TouchesBegan,
/// <summary>
/// Some touches have moved during the frame.
/// </summary>
OnTouchesMoved = MessageType.TouchesMoved,
/// <summary>
/// Some touches have ended during the frame.
/// </summary>
OnTouchesEnded = MessageType.TouchesEnded,
/// <summary>
/// Some touches were cancelled during the frame.
/// </summary>
OnTouchesCancelled = MessageType.TouchesCancelled
}
/// <summary>
/// Centimeter to inch ratio to be used in DPI calculations.
/// </summary>
public const float CM_TO_INCH = 0.393700787f;
/// <summary>
/// Inch to centimeter ratio to be used in DPI calculations.
/// </summary>
public const float INCH_TO_CM = 1 / CM_TO_INCH;
/// <summary>
/// The value used to represent an unknown state of a screen position. Use <see cref="TouchManager.IsInvalidPosition(Vector2)"/> to check if a point has unknown value.
/// </summary>
public static readonly Vector2 INVALID_2D_POSITION = new Vector2(float.NaN, float.NaN);
/// <summary>
/// The value used to represent an unknown state of a world position. Use <see cref="TouchManager.IsInvalidPosition(Vector3)"/> to check if a point has unknown value.
/// </summary>
public static readonly Vector3 INVALID_3D_POSITION = new Vector3(float.NaN, float.NaN, float.NaN);
/// <summary>
/// TouchScript version.
/// </summary>
public static readonly Version VERSION = new Version(6, 2);
#endregion
#region Public properties
/// <summary>
/// Gets the instance of <see cref="ITouchManager"/> implementation used in the application.
/// </summary>
/// <value>An instance of <see cref="ITouchManager"/> which is in charge of global touch input control in the application.</value>
public static ITouchManager Instance
{
get { return TouchManagerInstance.Instance; }
}
/// <summary>
/// Gets or sets current display device.
/// </summary>
/// <value>Object which holds properties of current display device, like DPI and others.</value>
/// <remarks>A shortcut for <see cref="ITouchManager.DisplayDevice"/> which is also serialized into scene.</remarks>
public IDisplayDevice DisplayDevice
{
get
{
if (Instance == null) return displayDevice as IDisplayDevice;
return Instance.DisplayDevice;
}
set
{
if (Instance == null)
{
displayDevice = value as Object;
return;
}
Instance.DisplayDevice = value;
}
}
/// <summary>
/// Gets or sets a value indicating whether Unity messages are sent when <see cref="ITouchManager"/> dispatches events.
/// </summary>
/// <value><c>true</c> if Unity messages are used; otherwise, <c>false</c>.</value>
/// <remarks>If Unity messages are used they are sent to an object set as a value of <see cref="SendMessageTarget"/> property or to TouchManager's GameObject if it's <c>null</c>.</remarks>
public bool UseSendMessage
{
get { return useSendMessage; }
set
{
if (value == useSendMessage) return;
useSendMessage = value;
updateSubscription();
}
}
/// <summary>
/// Gets or sets the bit-mask which indicates which events from an instance of <see cref="ITouchManager"/> are sent as Unity messages.
/// </summary>
/// <value>Bit-mask with corresponding bits for used events.</value>
public MessageType SendMessageEvents
{
get { return sendMessageEvents; }
set
{
if (sendMessageEvents == value) return;
sendMessageEvents = value;
updateSubscription();
}
}
/// <summary>
/// Gets or sets the SendMessage target GameObject.
/// </summary>
/// <value>Which GameObject to use to dispatch Unity messages. If <c>null</c>, TouchManager's GameObject is used.</value>
public GameObject SendMessageTarget
{
get { return sendMessageTarget; }
set
{
sendMessageTarget = value;
if (value == null) sendMessageTarget = gameObject;
}
}
#endregion
#region Public methods
/// <summary>
/// Determines whether a Vector2 represents an invalid position, i.e. if it is equal to <see cref="INVALID_2D_POSITION"/>.
/// </summary>
/// <param name="position">Screen position.</param>
/// <returns><c>true</c> if position is invalid; otherwise, <c>false</c>.</returns>
public static bool IsInvalidPosition(Vector2 position)
{
return position.Equals(INVALID_2D_POSITION);
}
/// <summary>
/// Determines whether a Vector3 represents an invalid position, i.e. if it is equal to <see cref="INVALID_3D_POSITION"/>.
/// </summary>
/// <param name="position">World position.</param>
/// <returns><c>true</c> if position is invalid; otherwise, <c>false</c>.</returns>
public static bool IsInvalidPosition(Vector3 position)
{
return position.Equals(INVALID_3D_POSITION);
}
#endregion
#region Private variables
[SerializeField]
private Object displayDevice;
[SerializeField]
[ToggleLeft]
private bool useSendMessage = false;
[SerializeField]
private MessageType sendMessageEvents = MessageType.TouchesBegan | MessageType.TouchesCancelled | MessageType.TouchesEnded | MessageType.TouchesMoved;
[SerializeField]
private GameObject sendMessageTarget;
[SerializeField]
private List<TouchLayer> layers = new List<TouchLayer>();
#endregion
#region Unity
private void OnEnable()
{
if (Instance == null) return;
Instance.DisplayDevice = displayDevice as IDisplayDevice;
for (var i = 0; i < layers.Count; i++)
{
Instance.AddLayer(layers[i], i);
}
updateSubscription();
}
#endregion
#region Private functions
private void updateSubscription()
{
if (!Application.isPlaying) return;
if (Instance == null) return;
if (sendMessageTarget == null) sendMessageTarget = gameObject;
Instance.FrameStarted -= frameStartedhandler;
Instance.FrameFinished -= frameFinishedHandler;
Instance.TouchesBegan -= touchesBeganHandler;
Instance.TouchesMoved -= touchesMovedHandler;
Instance.TouchesEnded -= touchesEndedHandler;
Instance.TouchesCancelled -= touchesCancelledHandler;
if (!useSendMessage) return;
if ((SendMessageEvents & MessageType.FrameStarted) != 0) Instance.FrameStarted += frameStartedhandler;
if ((SendMessageEvents & MessageType.FrameFinished) != 0) Instance.FrameFinished += frameFinishedHandler;
if ((SendMessageEvents & MessageType.TouchesBegan) != 0) Instance.TouchesBegan += touchesBeganHandler;
if ((SendMessageEvents & MessageType.TouchesMoved) != 0) Instance.TouchesMoved += touchesMovedHandler;
if ((SendMessageEvents & MessageType.TouchesEnded) != 0) Instance.TouchesEnded += touchesEndedHandler;
if ((SendMessageEvents & MessageType.TouchesCancelled) != 0) Instance.TouchesCancelled += touchesCancelledHandler;
}
private void touchesBeganHandler(object sender, TouchEventArgs e)
{
sendMessageTarget.SendMessage(MessageName.OnTouchesBegan.ToString(), e.Touches, SendMessageOptions.DontRequireReceiver);
}
private void touchesMovedHandler(object sender, TouchEventArgs e)
{
sendMessageTarget.SendMessage(MessageName.OnTouchesMoved.ToString(), e.Touches, SendMessageOptions.DontRequireReceiver);
}
private void touchesEndedHandler(object sender, TouchEventArgs e)
{
sendMessageTarget.SendMessage(MessageName.OnTouchesEnded.ToString(), e.Touches, SendMessageOptions.DontRequireReceiver);
}
private void touchesCancelledHandler(object sender, TouchEventArgs e)
{
sendMessageTarget.SendMessage(MessageName.OnTouchesCancelled.ToString(), e.Touches, SendMessageOptions.DontRequireReceiver);
}
private void frameStartedhandler(object sender, EventArgs e)
{
sendMessageTarget.SendMessage(MessageName.OnTouchFrameStarted.ToString(), SendMessageOptions.DontRequireReceiver);
}
private void frameFinishedHandler(object sender, EventArgs e)
{
sendMessageTarget.SendMessage(MessageName.OnTouchFrameFinished.ToString(), SendMessageOptions.DontRequireReceiver);
}
#endregion
}
}