-
Notifications
You must be signed in to change notification settings - Fork 123
/
Api.cs
413 lines (362 loc) · 14.1 KB
/
Api.cs
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
//-----------------------------------------------------------------------
// <copyright file="Api.cs" company="Google LLC">
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>
//-----------------------------------------------------------------------
namespace Google.XR.Cardboard
{
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using UnityEngine;
using UnityEngine.InputSystem;
using UnityEngine.InputSystem.Controls;
using UnityEngine.InputSystem.Utilities;
/// <summary>
/// Cardboard XR Plugin API.
/// </summary>
public static class Api
{
private static int _deviceParamsCount = -1;
private static ScreenOrientation _cachedScreenOrientation;
private static Rect _cachedScreenSafeArea;
/// <summary>
/// Whether a trigger touch started.
/// </summary>
private static bool _touchStarted = false;
/// <summary>
/// Tracks when the trigger touch sequence begins.
/// </summary>
private static double _startTouchStamp = 0.0;
/// <summary>
/// See MinTriggerHeldPressedTime property.
/// </summary>
private static double _minTriggerHeldPressedTime = 3.0;
/// <summary>
/// Gets a value indicating whether the close button is pressed this frame.
/// </summary>
public static bool IsCloseButtonPressed
{
get
{
if (!XRLoader._isStarted)
{
return false;
}
TouchControl touch = GetFirstTouchIfExists();
if (touch == null)
{
return false;
}
Vector2Int touchPosition = Vector2Int.RoundToInt(touch.position.ReadValue());
return touch.phase.ReadValue() == UnityEngine.InputSystem.TouchPhase.Began
&& Widget.CloseButtonRect.Contains(touchPosition);
}
}
/// <summary>
/// Gets a value indicating whether the gear button is pressed this frame.
/// </summary>
public static bool IsGearButtonPressed
{
get
{
if (!XRLoader._isStarted)
{
return false;
}
TouchControl touch = GetFirstTouchIfExists();
if (touch == null)
{
return false;
}
Vector2Int touchPosition = Vector2Int.RoundToInt(touch.position.ReadValue());
return touch.phase.ReadValue() == UnityEngine.InputSystem.TouchPhase.Began
&& Widget.GearButtonRect.Contains(touchPosition);
}
}
/// <summary>
/// Gets a value indicating whether the Cardboard trigger button is pressed this frame.
/// </summary>
public static bool IsTriggerPressed
{
get
{
if (!XRLoader._isStarted)
{
return false;
}
TouchControl touch = GetFirstTouchIfExists();
if (touch == null)
{
return false;
}
Vector2Int touchPosition = Vector2Int.RoundToInt(touch.position.ReadValue());
return touch.phase.ReadValue() == UnityEngine.InputSystem.TouchPhase.Began
&& !Widget.CloseButtonRect.Contains(touchPosition)
&& !Widget.GearButtonRect.Contains(touchPosition);
}
}
/// <summary>
/// Gets a value indicating whether Cardboard trigger button is held pressed.
/// </summary>
public static bool IsTriggerHeldPressed
{
get
{
if (!XRLoader._isStarted)
{
return false;
}
TouchControl touch = GetFirstTouchIfExists();
if (touch == null)
{
return false;
}
Vector2Int touchPosition = Vector2Int.RoundToInt(touch.position.ReadValue());
bool retVal = false;
UnityEngine.InputSystem.TouchPhase phase = touch.phase.ReadValue();
if (phase == UnityEngine.InputSystem.TouchPhase.Began
&& !Widget.CloseButtonRect.Contains(touchPosition)
&& !Widget.GearButtonRect.Contains(touchPosition))
{
_startTouchStamp = Time.time;
_touchStarted = true;
}
else if (phase == UnityEngine.InputSystem.TouchPhase.Ended && _touchStarted)
{
if ((Time.time - _startTouchStamp) > MinTriggerHeldPressedTime)
{
retVal = true;
}
_touchStarted = false;
}
else if (phase == UnityEngine.InputSystem.TouchPhase.Canceled)
{
// Any other phase to the touch sequence would cause to reset the time count,
// except Stationary which means the touch remains in the same position.
// The timer isn't reset when the UnityEngine.InputSystem.TouchPhase is equal
// to Moved so as to improve usability.
_touchStarted = false;
}
return retVal;
}
}
/// <summary>
/// Gets or sets the amount of time the trigger must be held active to be held pressed.
/// </summary>
public static double MinTriggerHeldPressedTime
{
get
{
return _minTriggerHeldPressedTime;
}
set
{
if (value <= 0.0)
{
Debug.LogError(
"[CardboardApi] Trying to set a negative value to "
+ "MinTriggerHeldPressedTime.");
}
else
{
_minTriggerHeldPressedTime = value;
}
}
}
/// <summary>
/// Evaluates whether or not device params are saved in the storage.
/// </summary>
///
/// <returns>Whether or not device parameters are found.</returns>
public static bool HasDeviceParams()
{
if (!XRLoader._isInitialized)
{
return false;
}
IntPtr encodedDeviceParams;
int size;
CardboardQrCode_getSavedDeviceParams(out encodedDeviceParams, out size);
if (size == 0)
{
Debug.Log("[CardboardApi] No device params found.");
return false;
}
Debug.Log("[CardboardApi] Device params found.");
CardboardQrCode_destroy(encodedDeviceParams);
_deviceParamsCount = CardboardQrCode_getDeviceParamsChangedCount();
return true;
}
/// <summary>
/// Starts QR Code scanning activity.
/// </summary>
public static void ScanDeviceParams()
{
if (!XRLoader._isInitialized)
{
return;
}
_deviceParamsCount = CardboardQrCode_getDeviceParamsChangedCount();
Debug.Log("[CardboardApi] QR Code scanning activity launched.");
CardboardQrCode_scanQrCodeAndSaveDeviceParams();
}
/// <summary>
/// Saves the encoded device parameters provided by an URI.
///
/// Expected URI format for:
/// - Cardboard Viewer v1: https://g.co/cardboard
/// - Cardboard Viewer v2: https://google.com/cardboard/cfd?p=deviceParams (for example,
/// https://google.com/cardboard/cfg?p=CgZHb29nbGUSEkNhcmRib2FyZCBJL08gMjAxNR0rGBU9JQHegj0qEAAASEIAAEhCAABIQgAASEJYADUpXA89OggeZnc-Ej6aPlAAYAM).
///
/// Redirection is also supported up to a maximum of 5 possible redirects before reaching
/// the proper pattern.
///
/// Only URIs using HTTPS protocol are supported.
/// </summary>
///
/// <param name="uri">
/// The URI string. See above for supported formats.
/// </param>
public static void SaveDeviceParams(string uri)
{
if (!XRLoader._isInitialized)
{
Debug.LogError(
"Please initialize Cardboard XR loader before calling this function.");
return;
}
IntPtr rawUri = Marshal.StringToHGlobalAuto(uri);
CardboardQrCode_saveDeviceParams(rawUri, uri.Length);
Marshal.FreeHGlobal(rawUri);
}
/// <summary>
/// Evaluates if device parameters changed from last time they were reloaded.
/// </summary>
///
/// <returns>true when device parameters changed.</returns>
public static bool HasNewDeviceParams()
{
// TODO(b/156501367): Move this logic to the XR display provider.
if (!XRLoader._isInitialized || _deviceParamsCount == -1)
{
return false;
}
return _deviceParamsCount != CardboardQrCode_getDeviceParamsChangedCount();
}
/// <summary>
/// Enables device parameter reconfiguration on next frame update.
/// </summary>
public static void ReloadDeviceParams()
{
if (!XRLoader._isInitialized)
{
return;
}
// TODO(b/156501367): Move this logic to the XR display provider.
Debug.Log("[CardboardApi] Reload device parameters.");
_deviceParamsCount = CardboardQrCode_getDeviceParamsChangedCount();
CardboardUnity_setDeviceParametersChanged();
}
/// <summary>
/// Updates screen parameters. This method must be called at framerate to ensure the current
/// screen orientation is properly taken into account by the head tracker.
/// </summary>
public static void UpdateScreenParams()
{
if (!XRLoader._isInitialized)
{
Debug.LogError(
"Please initialize Cardboard XR loader before calling this function.");
return;
}
// Reload devices param if either the viewport orientation or the safe area has changed
// since the last check.
if (_cachedScreenOrientation != Screen.orientation ||
_cachedScreenSafeArea != Screen.safeArea)
{
// Change the viewport orientation if it has changed.
if (_cachedScreenOrientation != Screen.orientation)
{
_cachedScreenOrientation = Screen.orientation;
XRLoader.SetViewportOrientation(_cachedScreenOrientation);
}
// Recalculate rectangles if the safe area has changed.
if (_cachedScreenSafeArea != Screen.safeArea)
{
_cachedScreenSafeArea = Screen.safeArea;
XRLoader.RecalculateRectangles(Screen.safeArea);
}
ReloadDeviceParams();
}
}
/// <summary>
/// Recenters the head tracker.
/// </summary>
public static void Recenter()
{
if (!XRLoader._isInitialized)
{
Debug.LogError(
"Please initialize Cardboard XR loader before calling this function.");
return;
}
CardboardUnity_recenterHeadTracker();
}
/// <summary>
/// Checks if the screen has been touched during the current frame.
/// </summary>
///
/// <returns>
/// The first touch of the screen during the current frame. Ir the screen hasn't been
/// touched, returns null.
/// </returns>
private static TouchControl GetFirstTouchIfExists()
{
Touchscreen touchScreen = Touchscreen.current;
if (touchScreen == null)
{
return null;
}
if (!touchScreen.enabled)
{
InputSystem.EnableDevice(touchScreen);
}
ReadOnlyArray<TouchControl> touches = touchScreen.touches;
if (touches.Count == 0)
{
return null;
}
return touches[0];
}
[DllImport(ApiConstants.CardboardApi)]
private static extern void CardboardQrCode_scanQrCodeAndSaveDeviceParams();
[DllImport(ApiConstants.CardboardApi)]
private static extern void CardboardQrCode_saveDeviceParams(
IntPtr uri, int size);
[DllImport(ApiConstants.CardboardApi)]
private static extern void CardboardQrCode_getSavedDeviceParams(
out IntPtr encodedDeviceParams, out int size);
[DllImport(ApiConstants.CardboardApi)]
private static extern void CardboardQrCode_destroy(IntPtr encodedDeviceParams);
[DllImport(ApiConstants.CardboardApi)]
private static extern int CardboardQrCode_getDeviceParamsChangedCount();
[DllImport(ApiConstants.CardboardApi)]
private static extern void CardboardUnity_setDeviceParametersChanged();
[DllImport(ApiConstants.CardboardApi)]
private static extern void CardboardUnity_recenterHeadTracker();
}
}