| 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 | 2
| var registerComponent = require('../core/component').registerComponent;
var bind = require('../utils/bind');
var isControllerPresent = require('../utils/tracked-controls').isControllerPresent;
var TOUCH_CONTROLLER_MODEL_BASE_URL = 'https://cdn.aframe.io/controllers/oculus/oculus-touch-controller-';
var TOUCH_CONTROLLER_MODEL_OBJ_URL_L = TOUCH_CONTROLLER_MODEL_BASE_URL + 'left.obj';
var TOUCH_CONTROLLER_MODEL_OBJ_MTL_L = TOUCH_CONTROLLER_MODEL_BASE_URL + 'left.mtl';
var TOUCH_CONTROLLER_MODEL_OBJ_URL_R = TOUCH_CONTROLLER_MODEL_BASE_URL + 'right.obj';
var TOUCH_CONTROLLER_MODEL_OBJ_MTL_R = TOUCH_CONTROLLER_MODEL_BASE_URL + 'right.mtl';
var GAMEPAD_ID_PREFIX = 'Oculus Touch';
var PIVOT_OFFSET = {x: 0, y: -0.015, z: 0.04};
// currently, browser bugs prevent capacitive touch events from firing on trigger and grip;
// however those have analog values, and this (below button-down values) can be used to fake them
var EMULATED_TOUCH_THRESHOLD = 0.001;
/**
* Oculus Touch Controls Component
* Interfaces with Oculus Touch controllers and maps Gamepad events to
* common controller buttons: trackpad, trigger, grip, menu and system
* It loads a controller model and highlights the pressed buttons
*/
module.exports.Component = registerComponent('oculus-touch-controls', {
schema: {
hand: {default: 'left'},
buttonColor: {type: 'color', default: '#999'}, // Off-white.
buttonTouchColor: {type: 'color', default: '#8AB'},
buttonHighlightColor: {type: 'color', default: '#2DF'}, // Light blue.
model: { default: true },
rotationOffset: {default: 0} // no default offset; -999 is sentinel value to auto-determine based on hand
},
// buttonId
// 0 - thumbstick
// 1 - trigger ( intensity value from 0.5 to 1 )
// 2 - grip
// 3 - menu ( dispatch but better for menu options )
// 4 - system ( never dispatched on this layer )
mapping: {
'left': {
axis0: 'thumbstick',
axis1: 'thumbstick',
button0: 'thumbstick',
button1: 'trigger',
button2: 'grip',
button3: 'X',
button4: 'Y',
button5: 'surface'
},
'right': {
axis0: 'thumbstick',
axis1: 'thumbstick',
button0: 'thumbstick',
button1: 'trigger',
button2: 'grip',
button3: 'A',
button4: 'B',
button5: 'surface'
}
},
bindMethods: function () {
this.onModelLoaded = bind(this.onModelLoaded, this);
this.onControllersUpdate = bind(this.onControllersUpdate, this);
this.checkIfControllerPresent = bind(this.checkIfControllerPresent, this);
},
init: function () {
var self = this;
this.animationActive = 'pointing';
this.onButtonChanged = bind(this.onButtonChanged, this);
this.onButtonDown = function (evt) { self.onButtonEvent(evt.detail.id, 'down'); };
this.onButtonUp = function (evt) { self.onButtonEvent(evt.detail.id, 'up'); };
this.onButtonTouchStart = function (evt) { self.onButtonEvent(evt.detail.id, 'touchstart'); };
this.onButtonTouchEnd = function (evt) { self.onButtonEvent(evt.detail.id, 'touchend'); };
this.controllerPresent = false;
this.everGotGamepadEvent = false;
this.lastControllerCheck = 0;
this.previousButtonValues = {};
this.bindMethods();
this.isControllerPresent = isControllerPresent; // to allow mock
},
addEventListeners: function () {
var el = this.el;
el.addEventListener('buttonchanged', this.onButtonChanged);
el.addEventListener('buttondown', this.onButtonDown);
el.addEventListener('buttonup', this.onButtonUp);
el.addEventListener('touchstart', this.onButtonTouchStart);
el.addEventListener('touchend', this.onButtonTouchEnd);
el.addEventListener('model-loaded', this.onModelLoaded);
el.sceneEl.addEventListener('controllersupdated', this.onControllersUpdate, false);
window.addEventListener('gamepadconnected', this.checkIfControllerPresent, false);
window.addEventListener('gamepaddisconnected', this.checkIfControllerPresent, false);
},
removeEventListeners: function () {
var el = this.el;
el.removeEventListener('buttonchanged', this.onButtonChanged);
el.removeEventListener('buttondown', this.onButtonDown);
el.removeEventListener('buttonup', this.onButtonUp);
el.removeEventListener('touchstart', this.onButtonTouchStart);
el.removeEventListener('touchend', this.onButtonTouchEnd);
el.removeEventListener('model-loaded', this.onModelLoaded);
el.sceneEl.removeEventListener('controllersupdated', this.onControllersUpdate, false);
window.removeEventListener('gamepadconnected', this.checkIfControllerPresent, false);
window.removeEventListener('gamepaddisconnected', this.checkIfControllerPresent, false);
},
checkIfControllerPresent: function () {
var data = this.data;
var isPresent = this.isControllerPresent(this.el.sceneEl, GAMEPAD_ID_PREFIX, { hand: data.hand });
if (isPresent === this.controllerPresent) { return; }
this.controllerPresent = isPresent;
if (isPresent) { this.injectTrackedControls(); } // inject track-controls
},
play: function () {
this.checkIfControllerPresent();
this.addEventListeners();
},
pause: function () {
this.removeEventListeners();
},
updateControllerModel: function () {
var objUrl, mtlUrl;
if (!this.data.model) { return; }
if (this.data.hand === 'right') {
objUrl = 'url(' + TOUCH_CONTROLLER_MODEL_OBJ_URL_R + ')';
mtlUrl = 'url(' + TOUCH_CONTROLLER_MODEL_OBJ_MTL_R + ')';
} else {
objUrl = 'url(' + TOUCH_CONTROLLER_MODEL_OBJ_URL_L + ')';
mtlUrl = 'url(' + TOUCH_CONTROLLER_MODEL_OBJ_MTL_L + ')';
}
this.el.setAttribute('obj-model', {obj: objUrl, mtl: mtlUrl});
},
injectTrackedControls: function () {
var el = this.el;
var data = this.data;
var isRightHand = data.hand === 'right';
// since each hand is named differently, avoid enumeration
el.setAttribute('tracked-controls', {
id: isRightHand ? 'Oculus Touch (Right)' : 'Oculus Touch (Left)',
controller: 0,
rotationOffset: data.rotationOffset !== -999 ? data.rotationOffset : isRightHand ? -90 : 90
});
this.updateControllerModel();
},
onControllersUpdate: function () {
if (!this.everGotGamepadEvent) { this.checkIfControllerPresent(); }
},
// currently, browser bugs prevent capacitive touch events from firing on trigger and grip;
// however those have analog values, and this (below button-down values) can be used to fake them
isEmulatedTouchEvent: function (analogValue) {
return analogValue && (analogValue >= EMULATED_TOUCH_THRESHOLD);
},
onButtonChanged: function (evt) {
var button = this.mapping[this.data.hand]['button' + evt.detail.id];
var buttonMeshes = this.buttonMeshes;
var isPreviousValueEmulatedTouch;
var analogValue;
var isEmulatedTouch;
// at the moment, if trigger or grip,
// touch events aren't happening (touched is stuck true);
// synthesize touch events from very low analog values
if (button !== 'trigger' && button !== 'grip') { return; }
analogValue = evt.detail.state.value;
isPreviousValueEmulatedTouch = this.isEmulatedTouchEvent(this.previousButtonValues[button]);
this.previousButtonValues[button] = analogValue;
isEmulatedTouch = this.isEmulatedTouchEvent(analogValue);
if (isEmulatedTouch !== isPreviousValueEmulatedTouch) {
(isEmulatedTouch ? this.onButtonTouchStart : this.onButtonTouchEnd)(evt);
}
if (!buttonMeshes) { return; }
if (button === 'trigger' && buttonMeshes.trigger) {
buttonMeshes.trigger.rotation.x = -analogValue * (Math.PI / 24);
}
if (button === 'grip' && buttonMeshes.grip) {
buttonMeshes.grip.rotation.y = (this.data.hand === 'left' ? -1 : 1) * analogValue * (Math.PI / 60);
}
},
onModelLoaded: function (evt) {
var controllerObject3D = evt.detail.model;
var buttonMeshes;
if (!this.data.model) { return; }
var leftHand = this.data.hand === 'left';
buttonMeshes = this.buttonMeshes = {};
buttonMeshes.grip = controllerObject3D.getObjectByName(leftHand ? 'buttonHand_oculus-touch-controller-left.004' : 'buttonHand_oculus-touch-controller-right.005');
buttonMeshes.thumbstick = controllerObject3D.getObjectByName(leftHand ? 'stick_oculus-touch-controller-left.007' : 'stick_oculus-touch-controller-right.004');
buttonMeshes.trigger = controllerObject3D.getObjectByName(leftHand ? 'buttonTrigger_oculus-touch-controller-left.005' : 'buttonTrigger_oculus-touch-controller-right.006');
buttonMeshes.X = controllerObject3D.getObjectByName('buttonX_oculus-touch-controller-left.002');
buttonMeshes.A = controllerObject3D.getObjectByName('buttonA_oculus-touch-controller-right.002');
buttonMeshes.Y = controllerObject3D.getObjectByName('buttonY_oculus-touch-controller-left.001');
buttonMeshes.B = controllerObject3D.getObjectByName('buttonB_oculus-touch-controller-right.003');
// Offset pivot point
controllerObject3D.position = PIVOT_OFFSET;
},
onButtonEvent: function (id, evtName) {
var buttonName = this.mapping[this.data.hand]['button' + id];
var i;
if (Array.isArray(buttonName)) {
for (i = 0; i < buttonName.length; i++) {
this.el.emit(buttonName[i] + evtName);
}
} else {
this.el.emit(buttonName + evtName);
}
this.updateModel(buttonName, evtName);
},
updateModel: function (buttonName, evtName) {
var i;
if (Array.isArray(buttonName)) {
for (i = 0; i < buttonName.length; i++) {
this.updateButtonModel(buttonName[i], evtName);
}
} else {
this.updateButtonModel(buttonName, evtName);
}
},
updateButtonModel: function (buttonName, state) {
var color = (state === 'up' || state === 'touchend') ? this.data.buttonColor : state === 'touchstart' ? this.data.buttonTouchColor : this.data.buttonHighlightColor;
var buttonMeshes = this.buttonMeshes;
if (!this.data.model) { return; }
if (buttonMeshes && buttonMeshes[buttonName]) {
buttonMeshes[buttonName].material.color.set(color);
}
}
});
|