// // virtualKeyboard.js // examples // // Created by Thijs Wenker on 11/18/14. // Copyright 2014 High Fidelity, Inc. // // Control a virtual keyboard using your favorite HMD. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html // const KBD_UPPERCASE_DEFAULT = 0; const KBD_LOWERCASE_DEFAULT = 1; const KBD_UPPERCASE_HOVER = 2; const KBD_LOWERCASE_HOVER = 3; const KBD_BACKGROUND = 4; const KEYBOARD_URL = "http://test.thoys.nl/hifi/images/virtualKeyboard/keyboard.svg"; const CURSOR_URL = "http://test.thoys.nl/hifi/images/virtualKeyboard/cursor.svg"; const KEYBOARD_WIDTH = 1174.7; const KEYBOARD_HEIGHT = 434.1; const CURSOR_WIDTH = 33.9; const CURSOR_HEIGHT = 33.9; // VIEW_ANGLE can be adjusted to your likings, the smaller the faster movement. // Try setting it to 60 if it goes too fast for you. const VIEW_ANGLE = 30.0; const VIEW_ANGLE_BY_TWO = VIEW_ANGLE / 2; const BOUND_X = 0; const BOUND_Y = 1; const BOUND_W = 2; const BOUND_H = 3; const KEY_STATE_LOWER = 0; const KEY_STATE_UPPER = 1; var windowDimensions = Controller.getViewportDimensions(); var cursor = null; var keyboard = new Keyboard(); var text = null; keyboard.onKeyPress = function() { print("Key press event test"); }; keyboard.onFullyLoaded = function() { print("Virtual-keyboard fully loaded."); var dimensions = Controller.getViewportDimensions(); text = Overlays.addOverlay("text", { x: 0, y: dimensions.y - keyboard.height() - 60, width: dimensions.x, height: 50, backgroundColor: { red: 255, green: 255, blue: 255}, color: { red: 0, green: 0, blue: 0}, topMargin: 10, leftMargin: 8, font: {size: 28}, text: "", alpha: 0.8 }); // the cursor is being loaded after the keyboard, else it will be on the background of the keyboard cursor = new Cursor(); cursor.onUpdate = function(position) { keyboard.setFocusPosition(position.x, position.y); }; }; function KeyboardKey(keyboard, key_properties) { var tthis = this; this._focus = false; this._beingpressed = false; this.event = key_properties.event != undefined ? key_properties.event : 'keypress'; this.bounds = key_properties.bounds; this.states = key_properties.states; this.keyboard = keyboard; this.key_state = key_properties.key_state != undefined ? key_properties.key_state : KBD_LOWERCASE_DEFAULT; // one overlay per bound vector [this.bounds] this.overlays = []; this.getKeyEvent = function() { if (tthis.event == 'keypress') { var state = tthis.states[(tthis.keyboard.shift ? 1 : 2) % tthis.states.length]; return {key: state.charCode, char: state.char, event: tthis.event}; } return {event: tthis.event}; }; this.containsCoord = function(x, y) { for (var i = 0; i < this.bounds.length; i++) { if (x >= this.bounds[i][BOUND_X] && x <= (this.bounds[i][BOUND_X] + this.bounds[i][BOUND_W]) && y >= this.bounds[i][BOUND_Y] && y <= (this.bounds[i][BOUND_Y] + this.bounds[i][BOUND_H])) { return true; } } return false; }; this.updateState = function() { tthis.setState(eval('KBD_' + (tthis.keyboard.shift ? 'UPPERCASE' : 'LOWERCASE') + '_' + (tthis._focus ? 'HOVER' : 'DEFAULT'))); }; this.updateColor = function() { var colorIntensity = this._beingpressed ? 128 : 255; for (var i = 0; i < tthis.bounds.length; i++) { Overlays.editOverlay(tthis.overlays[i], {color: {red: colorIntensity, green: colorIntensity, blue: colorIntensity}} ); } }; this.press = function() { tthis._beingpressed = true; tthis.updateColor(); }; this.release = function() { tthis._beingpressed = false; tthis.updateColor(); }; this.blur = function() { tthis._focus = false; tthis.updateState(); }; this.focus = function() { tthis._focus = true; tthis.updateState(); }; this.setState = function(state) { tthis.key_state = state; for (var i = 0; i < tthis.bounds.length; i++) { Overlays.editOverlay(tthis.overlays[i], { subImage: {width: tthis.bounds[i][BOUND_W], height: tthis.bounds[i][BOUND_H], x: tthis.bounds[i][BOUND_X], y: (KEYBOARD_HEIGHT * tthis.key_state) + tthis.bounds[i][BOUND_Y]} }); } }; this.rescale = function() { for (var i = 0; i < tthis.bounds.length; i++) { Overlays.editOverlay(tthis.overlays[i], { x: tthis.keyboard.getX() + tthis.bounds[i][BOUND_X] * keyboard.scale, y: tthis.keyboard.getY() + tthis.bounds[i][BOUND_Y] * keyboard.scale, width: this.bounds[i][BOUND_W] * keyboard.scale, height: this.bounds[i][BOUND_H] * keyboard.scale }); } }; this.remove = function() { for (var i = 0; i < this.overlays.length; i++) { Overlays.deleteOverlay(this.overlays[i]); } }; this.isLoaded = function() { for (var i = 0; i < this.overlays.length; i++) { if (!Overlays.isLoaded(this.overlays[i])) { return false; } } return true; }; for (var i = 0; i < this.bounds.length; i++) { var newOverlay = Overlays.cloneOverlay(this.keyboard.background); Overlays.editOverlay(newOverlay, { x: this.keyboard.getX() + this.bounds[i][BOUND_X] * keyboard.scale, y: this.keyboard.getY() + this.bounds[i][BOUND_Y] * keyboard.scale, width: this.bounds[i][BOUND_W] * keyboard.scale, height: this.bounds[i][BOUND_H] * keyboard.scale, subImage: {width: this.bounds[i][BOUND_W], height: this.bounds[i][BOUND_H], x: this.bounds[i][BOUND_X], y: (KEYBOARD_HEIGHT * this.key_state) + this.bounds[i][BOUND_Y]}, alpha: 1 }); this.overlays.push(newOverlay); } } function Keyboard() { var tthis = this; this.focussed_key = -1; this.scale = windowDimensions.x / KEYBOARD_WIDTH; this.shift = false; this.width = function() { return KEYBOARD_WIDTH * tthis.scale; }; this.height = function() { return KEYBOARD_HEIGHT * tthis.scale; }; this.getX = function() { return (windowDimensions.x / 2) - (this.width() / 2); }; this.getY = function() { return windowDimensions.y - this.height(); }; this.background = Overlays.addOverlay("image", { x: this.getX(), y: this.getY(), width: this.width(), height: this.height(), subImage: {width: KEYBOARD_WIDTH, height: KEYBOARD_HEIGHT, y: KEYBOARD_HEIGHT * KBD_BACKGROUND}, imageURL: KEYBOARD_URL, alpha: 1 }); this.rescale = function() { this.scale = windowDimensions.x / KEYBOARD_WIDTH; Overlays.editOverlay(tthis.background, { x: this.getX(), y: this.getY(), width: this.width(), height: this.height() }); for (var i = 0; i < tthis.keys.length; i++) { tthis.keys[i].rescale(); } }; this.setFocusPosition = function(x, y) { // set to local unscaled position var localx = (x - tthis.getX()) / tthis.scale; var localy = (y - tthis.getY()) / tthis.scale; var new_focus_key = -1; if (localx >= 0 && localy >= 0 && localx <= KEYBOARD_WIDTH && localy <= KEYBOARD_HEIGHT) { for (var i = 0; i < tthis.keys.length; i++) { if (tthis.keys[i].containsCoord(localx, localy)) { //print(tthis.keys[i].states[0].char); new_focus_key = i; break; } } } if (new_focus_key != tthis.focussed_key) { if (tthis.focussed_key != -1) { tthis.keys[tthis.focussed_key].blur(); } tthis.focussed_key = new_focus_key; if (tthis.focussed_key != -1) { tthis.keys[tthis.focussed_key].focus(); } } return tthis; }; this.pressFocussedKey = function() { if (tthis.focussed_key != -1) { if (tthis.keys[tthis.focussed_key].event == 'shift') { tthis.toggleShift(); } else { tthis.keys[tthis.focussed_key].press(); } if (this.onKeyPress != null) { this.onKeyPress(tthis.keys[tthis.focussed_key].getKeyEvent()); } } return tthis; }; this.releaseKeys = function() { for (var i = 0; i < tthis.keys.length; i++) { if (tthis.keys[i]._beingpressed) { if (tthis.keys[i].event != 'shift') { tthis.keys[i].release(); } if (this.onKeyRelease != null) { this.onKeyRelease(tthis.keys[i].getKeyEvent()); } } } }; this.toggleShift = function() { tthis.shift = !tthis.shift; for (var i = 0; i < tthis.keys.length; i++) { tthis.keys[i].updateState(); if (tthis.keys[i].event == 'shift') { if (tthis.shift) { tthis.keys[i].press(); continue; } tthis.keys[i].release(); } } }; this.getFocussedKey = function() { if (tthis.focussed_key == -1) { return null; } return tthis.keys[tthis.focussed_key]; }; this.remove = function() { Overlays.deleteOverlay(this.background); for (var i = 0; i < this.keys.length; i++) { this.keys[i].remove(); } }; this.onKeyPress = null; this.onKeyRelease = null; this.onSubmit = null; this.onFullyLoaded = null; this.keys = []; // // keyProperties contains the key data // // coords [[x,y,w,h],[x,y,w,h]] // states array of 1 or 2 objects [lowercase, uppercase] each object contains a charCode and a char var keyProperties = [ {bounds: [[12, 12, 65, 52]], states: [{charCode: 192, char: '~'}]}, {bounds: [[84, 12, 65, 52]], states: [{charCode: 192, char: '!'}]}, {bounds: [[156, 12, 65, 52]], states: [{charCode: 192, char: '@'}]}, {bounds: [[228, 12, 65, 52]], states: [{charCode: 192, char: '#'}]}, {bounds: [[300, 12, 65, 52]], states: [{charCode: 192, char: '$'}]}, {bounds: [[372, 12, 65, 52]], states: [{charCode: 192, char: '%'}]}, {bounds: [[445, 12, 65, 52]], states: [{charCode: 192, char: '^'}]}, {bounds: [[517, 12, 65, 52]], states: [{charCode: 192, char: '&'}]}, {bounds: [[589, 12, 65, 52]], states: [{charCode: 192, char: '*'}]}, {bounds: [[662, 12, 65, 52]], states: [{charCode: 192, char: '('}]}, {bounds: [[734, 12, 65, 52]], states: [{charCode: 192, char: ')'}]}, {bounds: [[806, 12, 65, 52]], states: [{charCode: 192, char: '_'}]}, {bounds: [[881, 12, 65, 52]], states: [{charCode: 192, char: '{'}]}, {bounds: [[953, 12, 65, 52]], states: [{charCode: 192, char: '}'}]}, {bounds: [[1025, 12, 65, 52]], states: [{charCode: 192, char: '<'}]}, {bounds: [[1097, 12, 65, 52]], states: [{charCode: 192, char: '>'}]}, {bounds: [[12, 71, 65, 63]], states: [{charCode: 192, char: '`'}]}, {bounds: [[84, 71, 65, 63]], states: [{charCode: 192, char: '1'}]}, {bounds: [[156, 71, 65, 63]], states: [{charCode: 192, char: '2'}]}, {bounds: [[228, 71, 65, 63]], states: [{charCode: 192, char: '3'}]}, {bounds: [[300, 71, 65, 63]], states: [{charCode: 192, char: '4'}]}, {bounds: [[372, 71, 65, 63]], states: [{charCode: 192, char: '5'}]}, {bounds: [[445, 71, 65, 63]], states: [{charCode: 192, char: '6'}]}, {bounds: [[517, 71, 65, 63]], states: [{charCode: 192, char: '7'}]}, {bounds: [[589, 71, 65, 63]], states: [{charCode: 192, char: '8'}]}, {bounds: [[661, 71, 65, 63]], states: [{charCode: 192, char: '9'}]}, {bounds: [[733, 71, 65, 63]], states: [{charCode: 192, char: '0'}]}, {bounds: [[806, 71, 65, 63]], states: [{charCode: 192, char: '-'}]}, {bounds: [[880, 71, 65, 63]], states: [{charCode: 192, char: '='}]}, {bounds: [[953, 71, 65, 63]], states: [{charCode: 192, char: '+'}]}, {bounds: [[1024, 71, 139, 63]], event: 'delete'}, // enter key has 2 bounds and one state {bounds: [[11, 143, 98, 71], [11, 213, 121, 62]], event: 'enter'}, {bounds: [[118, 142, 64, 63]], states: [{charCode: 192, char: 'q'}, {charCode: 192, char: 'Q'}]}, {bounds: [[190, 142, 64, 63]], states: [{charCode: 192, char: 'w'}, {charCode: 192, char: 'W'}]}, {bounds: [[262, 142, 64, 63]], states: [{charCode: 192, char: 'e'}, {charCode: 192, char: 'E'}]}, {bounds: [[334, 142, 64, 63]], states: [{charCode: 192, char: 'r'}, {charCode: 192, char: 'R'}]}, {bounds: [[407, 142, 64, 63]], states: [{charCode: 192, char: 't'}, {charCode: 192, char: 'T'}]}, {bounds: [[479, 142, 64, 63]], states: [{charCode: 192, char: 'y'}, {charCode: 192, char: 'Y'}]}, {bounds: [[551, 142, 65, 63]], states: [{charCode: 192, char: 'u'}, {charCode: 192, char: 'U'}]}, {bounds: [[623, 142, 65, 63]], states: [{charCode: 192, char: 'i'}, {charCode: 192, char: 'I'}]}, {bounds: [[695, 142, 65, 63]], states: [{charCode: 192, char: 'o'}, {charCode: 192, char: 'O'}]}, {bounds: [[768, 142, 64, 63]], states: [{charCode: 192, char: 'p'}, {charCode: 192, char: 'P'}]}, {bounds: [[840, 142, 64, 63]], states: [{charCode: 192, char: '['}]}, {bounds: [[912, 142, 65, 63]], states: [{charCode: 192, char: ']'}]}, {bounds: [[984, 142, 65, 63]], states: [{charCode: 192, char: '\\'}]}, {bounds: [[1055, 142, 65, 63]], states: [{charCode: 192, char: '|'}]}, {bounds: [[1126, 143, 35, 72], [1008, 214, 153, 62]], event: 'enter'}, {bounds: [[140, 213, 65, 63]], states: [{charCode: 192, char: 'a'}, {charCode: 192, char: 'A'}]}, {bounds: [[211, 213, 64, 63]], states: [{charCode: 192, char: 's'}, {charCode: 192, char: 'S'}]}, {bounds: [[283, 213, 65, 63]], states: [{charCode: 192, char: 'd'}, {charCode: 192, char: 'D'}]}, {bounds: [[355, 213, 65, 63]], states: [{charCode: 192, char: 'f'}, {charCode: 192, char: 'F'}]}, {bounds: [[428, 213, 64, 63]], states: [{charCode: 192, char: 'g'}, {charCode: 192, char: 'G'}]}, {bounds: [[500, 213, 64, 63]], states: [{charCode: 192, char: 'h'}, {charCode: 192, char: 'H'}]}, {bounds: [[572, 213, 65, 63]], states: [{charCode: 192, char: 'j'}, {charCode: 192, char: 'J'}]}, {bounds: [[644, 213, 65, 63]], states: [{charCode: 192, char: 'k'}, {charCode: 192, char: 'K'}]}, {bounds: [[716, 213, 65, 63]], states: [{charCode: 192, char: 'l'}, {charCode: 192, char: 'L'}]}, {bounds: [[789, 213, 64, 63]], states: [{charCode: 192, char: ';'}]}, {bounds: [[861, 213, 64, 63]], states: [{charCode: 192, char: '\''}]}, {bounds: [[934, 213, 65, 63]], states: [{charCode: 192, char: ':'}]}, {bounds: [[12, 283, 157, 63]], event: 'shift'}, {bounds: [[176, 283, 65, 63]], states: [{charCode: 192, char: 'z'}, {charCode: 192, char: 'Z'}]}, {bounds: [[249, 283, 64, 63]], states: [{charCode: 192, char: 'x'}, {charCode: 192, char: 'X'}]}, {bounds: [[321, 283, 64, 63]], states: [{charCode: 192, char: 'c'}, {charCode: 192, char: 'C'}]}, {bounds: [[393, 283, 64, 63]], states: [{charCode: 192, char: 'v'}, {charCode: 192, char: 'V'}]}, {bounds: [[465, 283, 65, 63]], states: [{charCode: 192, char: 'b'}, {charCode: 192, char: 'B'}]}, {bounds: [[537, 283, 65, 63]], states: [{charCode: 192, char: 'n'}, {charCode: 192, char: 'N'}]}, {bounds: [[610, 283, 64, 63]], states: [{charCode: 192, char: 'm'}, {charCode: 192, char: 'M'}]}, {bounds: [[682, 283, 64, 63]], states: [{charCode: 192, char: ','}]}, {bounds: [[754, 283, 65, 63]], states: [{charCode: 192, char: '.'}]}, {bounds: [[826, 283, 65, 63]], states: [{charCode: 192, char: '/'}]}, {bounds: [[899, 283, 64, 63]], states: [{charCode: 192, char: '?'}]}, {bounds: [[972, 283, 190, 63]], event: 'shift'}, {bounds: [[249, 355, 573, 67]], states: [{charCode: 32, char: ' '}]}, {bounds: [[899, 355, 263, 67]], event: 'submit'} ]; this.keyboardtextureloaded = function() { if (Overlays.isLoaded(tthis.background)) { Script.clearInterval(tthis.keyboardtextureloaded_timer); for (var i = 0; i < keyProperties.length; i++) { tthis.keys.push(new KeyboardKey(tthis, keyProperties[i])); } if (keyboard.onFullyLoaded != null) { tthis.onFullyLoaded(); } } }; this.keyboardtextureloaded_timer = Script.setInterval(this.keyboardtextureloaded, 250); } function Cursor() { var tthis = this; this.x = windowDimensions.x / 2; this.y = windowDimensions.y / 2; this.overlay = Overlays.addOverlay("image", { x: this.x, y: this.y, width: CURSOR_WIDTH, height: CURSOR_HEIGHT, imageURL: CURSOR_URL, alpha: 1 }); this.remove = function() { Overlays.deleteOverlay(this.overlay); }; this.getPosition = function() { return {x: tthis.getX(), y: tthis.getY()}; }; this.getX = function() { return tthis.x; }; this.getY = function() { return tthis.y; }; this.onUpdate = null; this.update = function() { var newWindowDimensions = Controller.getViewportDimensions(); if (newWindowDimensions.x != windowDimensions.x || newWindowDimensions.y != windowDimensions.y) { windowDimensions = newWindowDimensions; keyboard.rescale(); Overlays.editOverlay(text, { y: windowDimensions.y - keyboard.height() - 60, width: windowDimensions.x }); } var editobject = {}; if (MyAvatar.getHeadFinalYaw() <= VIEW_ANGLE_BY_TWO && MyAvatar.getHeadFinalYaw() >= -1 * VIEW_ANGLE_BY_TWO) { angle = ((-1 * MyAvatar.getHeadFinalYaw()) + VIEW_ANGLE_BY_TWO) / VIEW_ANGLE; tthis.x = angle * windowDimensions.x; editobject.x = tthis.x - (CURSOR_WIDTH / 2); } if (MyAvatar.getHeadFinalPitch() <= VIEW_ANGLE_BY_TWO && MyAvatar.getHeadFinalPitch() >= -1 * VIEW_ANGLE_BY_TWO) { angle = ((-1 * MyAvatar.getHeadFinalPitch()) + VIEW_ANGLE_BY_TWO) / VIEW_ANGLE; tthis.y = angle * windowDimensions.y; editobject.y = tthis.y - (CURSOR_HEIGHT / 2); } if (Object.keys(editobject).length > 0) { Overlays.editOverlay(tthis.overlay, editobject); if (tthis.onUpdate != null) { tthis.onUpdate(tthis.getPosition()); } } }; Script.update.connect(this.update); } function keyPressEvent(key) { if (key.text === "SPACE") { print("pressed space"); keyboard.pressFocussedKey(); } } function keyReleaseEvent(key) { if (key.text === "SPACE") { print("released space"); keyboard.releaseKeys(); } } function scriptEnding() { keyboard.remove(); cursor.remove(); Overlays.deleteOverlay(text); Controller.releaseKeyEvents({key: 32}); } Controller.captureKeyEvents({key: 32}); Controller.keyPressEvent.connect(keyPressEvent); Controller.keyReleaseEvent.connect(keyReleaseEvent); Script.scriptEnding.connect(scriptEnding);