//// Keyboard.cpp// interface/src/scripting//// Created by Dante Ruiz on 2018-08-27.// Copyright 2018 High Fidelity, Inc.//// Distributed under the Apache License, Version 2.0.// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html// #include "Keyboard.h" #include <utility> #include <glm/gtc/quaternion.hpp>#include <glm/gtx/quaternion.hpp>#include <QtGui/qevent.h>#include <QFile>#include <QTextStream>#include <QJsonArray>#include <QJsonDocument>#include <QJsonParseError> #include <PointerEvent.h>#include <PointerManager.h>#include <Pick.h>#include <controllers/UserInputMapper.h>#include <PathUtils.h>#include <ResourceManager.h>#include <SoundCache.h>#include <AudioInjectorManager.h>#include <RegisteredMetaTypes.h>#include <ui/TabletScriptingInterface.h> #include "avatar/AvatarManager.h"#include "avatar/MyAvatar.h"#include "avatar/AvatarManager.h"#include "raypick/PickScriptingInterface.h"#include "scripting/HMDScriptingInterface.h"#include "scripting/WindowScriptingInterface.h"#include "scripting/SelectionScriptingInterface.h"#include "scripting/HMDScriptingInterface.h"#include "DependencyManager.h" #include "raypick/StylusPointer.h"#include "GLMHelpers.h"#include "Application.h"#include "KeyEvent.h" static const int LEFT_HAND_CONTROLLER_INDEX = 0;static const int RIGHT_HAND_CONTROLLER_INDEX = 1; static const float MALLET_LENGTH = 0.18f;static const float MALLET_TOUCH_Y_OFFSET = 0.050f;static const float MALLET_Y_OFFSET = 0.160f; static const glm::quat MALLET_ROTATION_OFFSET{0.70710678f, 0.0f, -0.70710678f, 0.0f};static const glm::vec3 MALLET_MODEL_DIMENSIONS{0.01f, MALLET_LENGTH, 0.01f};static const glm::vec3 MALLET_POSITION_OFFSET{0.0f, -MALLET_Y_OFFSET / 2.0f, 0.0f};static const glm::vec3 MALLET_TIP_OFFSET{0.0f, MALLET_LENGTH - MALLET_TOUCH_Y_OFFSET, 0.0f}; static const glm::vec3 Z_AXIS {0.0f, 0.0f, 1.0f};static const glm::vec3 KEYBOARD_TABLET_OFFSET{0.30f, -0.38f, -0.04f};static const glm::vec3 KEYBOARD_TABLET_DEGREES_OFFSET{-45.0f, 0.0f, 0.0f};static const glm::vec3 KEYBOARD_TABLET_LANDSCAPE_OFFSET{-0.2f, -0.27f, -0.05f};static const glm::vec3 KEYBOARD_TABLET_LANDSCAPE_DEGREES_OFFSET{-45.0f, 0.0f, -90.0f};static const glm::vec3 KEYBOARD_AVATAR_OFFSET{-0.3f, 0.0f, -0.7f};static const glm::vec3 KEYBOARD_AVATAR_DEGREES_OFFSET{0.0f, 180.0f, 0.0f}; static const QString SOUND_FILE = PathUtils::resourcesUrl() + "sounds/keyboardPress.mp3";static const QString MALLET_MODEL_URL = PathUtils::resourcesUrl() + "meshes/drumstick.fbx"; static const float PULSE_STRENGTH = 0.6f;static const float PULSE_DURATION = 3.0f; static const int KEY_PRESS_TIMEOUT_MS = 100;static const int LAYER_SWITCH_TIMEOUT_MS = 200; static const QString CHARACTER_STRING = "character";static const QString CAPS_STRING = "caps";static const QString CLOSE_STRING = "close";static const QString LAYER_STRING = "layer";static const QString BACKSPACE_STRING = "backspace";static const QString SPACE_STRING = "space";static const QString ENTER_STRING = "enter";static const QString SELECT_ALL_STRING = "select_all";static const QString COPY_STRING = "copy";static const QString CUT_STRING = "cut";static const QString PASTE_STRING = "paste";static const QString CURSOR_UP_STRING = "cursor_up";static const QString CURSOR_RIGHT_STRING = "cursor_right";static const QString CURSOR_DOWN_STRING = "cursor_down";static const QString CURSOR_LEFT_STRING = "cursor_left"; static const QString KEY_HOVER_HIGHLIGHT = "keyHoverHiglight";static const QString KEY_PRESSED_HIGHLIGHT = "keyPressesHighlight";static const QVariantMap KEY_HOVERING_STYLE { { "isOutlineSmooth", true }, { "outlineWidth", 3 }, { "outlineUnoccludedColor", QVariantMap {{"red", 13}, {"green", 152}, {"blue", 186}}}, { "outlineUnoccludedAlpha", 1.0 }, { "outlineOccludedAlpha", 0.0 }, { "fillUnoccludedAlpha", 0.0 }, { "fillOccludedAlpha", 0.0 }}; static const QVariantMap KEY_PRESSING_STYLE { { "isOutlineSmooth", true }, { "outlineWidth", 3 }, { "fillUnoccludedColor", QVariantMap {{"red", 50}, {"green", 50}, {"blue", 50}}}, { "outlineUnoccludedAlpha", 0.0 }, { "outlineOccludedAlpha", 0.0 }, { "fillUnoccludedAlpha", 0.6 }, { "fillOccludedAlpha", 0.0 }}; std::pair<glm::vec3, glm::quat> calculateKeyboardPositionAndOrientation() { auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); auto hmd = DependencyManager::get<HMDScriptingInterface>(); std::pair<glm::vec3, glm::quat> keyboardLocation = std::make_pair(glm::vec3(), glm::quat()); float sensorToWorldScale = myAvatar->getSensorToWorldScale(); QUuid tabletID = hmd->getCurrentTabletFrameID(); if (!tabletID.isNull() && hmd->getShouldShowTablet()) { EntityPropertyFlags desiredProperties; desiredProperties += PROP_POSITION; desiredProperties += PROP_ROTATION; auto properties = DependencyManager::get<EntityScriptingInterface>()->getEntityPropertiesInternal(tabletID, desiredProperties, false); auto tablet = DependencyManager::get<TabletScriptingInterface>()->getTablet("com.highfidelity.interface.tablet.system"); bool landscapeMode = tablet->getLandscape(); glm::vec3 keyboardOffset = landscapeMode ? KEYBOARD_TABLET_LANDSCAPE_OFFSET : KEYBOARD_TABLET_OFFSET; glm::vec3 keyboardDegreesOffset = landscapeMode ? KEYBOARD_TABLET_LANDSCAPE_DEGREES_OFFSET : KEYBOARD_TABLET_DEGREES_OFFSET; glm::vec3 tabletWorldPosition = properties.getPosition(); glm::quat tabletWorldOrientation = properties.getRotation(); glm::vec3 scaledKeyboardTabletOffset = keyboardOffset * sensorToWorldScale; keyboardLocation.first = tabletWorldPosition + (tabletWorldOrientation * scaledKeyboardTabletOffset); keyboardLocation.second = tabletWorldOrientation * glm::quat(glm::radians(keyboardDegreesOffset)); } else { glm::vec3 avatarWorldPosition = myAvatar->getWorldPosition(); glm::quat avatarWorldOrientation = myAvatar->getWorldOrientation(); glm::vec3 scaledKeyboardAvatarOffset = KEYBOARD_AVATAR_OFFSET * sensorToWorldScale; keyboardLocation.first = avatarWorldPosition + (avatarWorldOrientation * scaledKeyboardAvatarOffset); keyboardLocation.second = avatarWorldOrientation * glm::quat(glm::radians(KEYBOARD_AVATAR_DEGREES_OFFSET)); } return keyboardLocation;} void Key::saveDimensionsAndLocalPosition() { EntityPropertyFlags desiredProperties; desiredProperties += PROP_LOCAL_POSITION; desiredProperties += PROP_DIMENSIONS; auto properties = DependencyManager::get<EntityScriptingInterface>()->getEntityPropertiesInternal(_keyID, desiredProperties, false); _originalLocalPosition = properties.getLocalPosition(); _originalDimensions = properties.getDimensions(); _currentLocalPosition = _originalLocalPosition; _originalDimensionsAndLocalPositionSaved = true;} void Key::scaleKey(float sensorToWorldScale) { if (_originalDimensionsAndLocalPositionSaved) { glm::vec3 scaledLocalPosition = _originalLocalPosition; glm::vec3 scaledDimensions = _originalDimensions * sensorToWorldScale; _currentLocalPosition = scaledLocalPosition; EntityItemProperties properties; properties.setDimensions(scaledDimensions); properties.setLocalPosition(scaledLocalPosition); DependencyManager::get<EntityScriptingInterface>()->editEntity(_keyID, properties); }} void Key::startTimer(int time) { if (_timer) { _timer->start(time); _timer->setSingleShot(true); }} bool Key::timerFinished() { if (_timer) { return (_timer->remainingTime() <= 0); } return false;} QString Key::getKeyString(bool toUpper) const { return toUpper ? _keyString.toUpper() : _keyString;} int Key::getScanCode(bool toUpper) const { QString character = toUpper ? _keyString.toUpper() : _keyString; auto utf8Key = character.toUtf8(); return (int)utf8Key[0];} Key::Type Key::getKeyTypeFromString(const QString& keyTypeString) { if (keyTypeString == SPACE_STRING) { return Type::SPACE; } else if (keyTypeString == BACKSPACE_STRING) { return Type::BACKSPACE; } else if (keyTypeString == LAYER_STRING) { return Type::LAYER; } else if (keyTypeString == CAPS_STRING) { return Type::CAPS; } else if (keyTypeString == CLOSE_STRING) { return Type::CLOSE; } else if (keyTypeString == ENTER_STRING) { return Type::ENTER; } else if (keyTypeString == SELECT_ALL_STRING) { return Type::SELECT_ALL; } else if (keyTypeString == COPY_STRING) { return Type::COPY; } else if (keyTypeString == CUT_STRING) { return Type::CUT; } else if (keyTypeString == PASTE_STRING) { return Type::PASTE; } else if (keyTypeString == CURSOR_UP_STRING) { return Type::CURSOR_UP; } else if (keyTypeString == CURSOR_RIGHT_STRING) { return Type::CURSOR_RIGHT; } else if (keyTypeString == CURSOR_DOWN_STRING) { return Type::CURSOR_DOWN; } else if (keyTypeString == CURSOR_LEFT_STRING) { return Type::CURSOR_LEFT; } return Type::CHARACTER;} Keyboard::Keyboard() { auto pointerManager = DependencyManager::get<PointerManager>(); auto windowScriptingInterface = DependencyManager::get<WindowScriptingInterface>(); auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); auto hmdScriptingInterface = DependencyManager::get<HMDScriptingInterface>(); connect(pointerManager.data(), &PointerManager::triggerBeginOverlay, this, &Keyboard::handleTriggerBegin, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::triggerContinueOverlay, this, &Keyboard::handleTriggerContinue, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::triggerEndOverlay, this, &Keyboard::handleTriggerEnd, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::hoverBeginOverlay, this, &Keyboard::handleHoverBegin, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::hoverEndOverlay, this, &Keyboard::handleHoverEnd, Qt::QueuedConnection); connect(myAvatar.get(), &MyAvatar::sensorToWorldScaleChanged, this, &Keyboard::scaleKeyboard, Qt::QueuedConnection); connect(windowScriptingInterface.data(), &WindowScriptingInterface::domainChanged, [&]() { setRaised(false); }); connect(hmdScriptingInterface.data(), &HMDScriptingInterface::displayModeChanged, [&]() { setRaised(false); });} void Keyboard::registerKeyboardHighlighting() { auto selection = DependencyManager::get<SelectionScriptingInterface>(); selection->enableListHighlight(KEY_HOVER_HIGHLIGHT, KEY_HOVERING_STYLE); selection->enableListToScene(KEY_HOVER_HIGHLIGHT); selection->enableListHighlight(KEY_PRESSED_HIGHLIGHT, KEY_PRESSING_STYLE); selection->enableListToScene(KEY_PRESSED_HIGHLIGHT);} void Keyboard::disableSelectionLists() { auto selection = DependencyManager::get<SelectionScriptingInterface>(); selection->disableListHighlight(KEY_HOVER_HIGHLIGHT); selection->disableListHighlight(KEY_PRESSED_HIGHLIGHT);} void Keyboard::enableSelectionLists() { auto selection = DependencyManager::get<SelectionScriptingInterface>(); selection->enableListHighlight(KEY_HOVER_HIGHLIGHT, KEY_HOVERING_STYLE); selection->enableListHighlight(KEY_PRESSED_HIGHLIGHT, KEY_PRESSING_STYLE);} bool Keyboard::getUse3DKeyboard() const { return _use3DKeyboardLock.resultWithReadLock<bool>([&] { return _use3DKeyboard.get(); });} void Keyboard::setUse3DKeyboard(bool use) { _use3DKeyboardLock.withWriteLock([&] { _use3DKeyboard.set(use); });} void Keyboard::createKeyboard() { auto pointerManager = DependencyManager::get<PointerManager>(); if (_created) { pointerManager->removePointer(_leftHandStylus); pointerManager->removePointer(_rightHandStylus); clearKeyboardKeys(); } QVariantMap modelProperties { { "url", MALLET_MODEL_URL } }; QVariantMap leftStylusProperties { { "hand", LEFT_HAND_CONTROLLER_INDEX }, { "filter", PickScriptingInterface::getPickLocalEntities() }, { "model", modelProperties }, { "tipOffset", vec3toVariant(MALLET_TIP_OFFSET) } }; QVariantMap rightStylusProperties { { "hand", RIGHT_HAND_CONTROLLER_INDEX }, { "filter", PickScriptingInterface::getPickLocalEntities() }, { "model", modelProperties }, { "tipOffset", vec3toVariant(MALLET_TIP_OFFSET) } }; _leftHandStylus = pointerManager->addPointer(std::make_shared<StylusPointer>(leftStylusProperties, StylusPointer::buildStylus(leftStylusProperties), true, true, MALLET_POSITION_OFFSET, MALLET_ROTATION_OFFSET, MALLET_MODEL_DIMENSIONS)); _rightHandStylus = pointerManager->addPointer(std::make_shared<StylusPointer>(rightStylusProperties, StylusPointer::buildStylus(rightStylusProperties), true, true, MALLET_POSITION_OFFSET, MALLET_ROTATION_OFFSET, MALLET_MODEL_DIMENSIONS)); pointerManager->disablePointer(_rightHandStylus); pointerManager->disablePointer(_leftHandStylus); QString keyboardSvg = PathUtils::resourcesUrl() + "config/keyboard.json"; loadKeyboardFile(keyboardSvg); _keySound = DependencyManager::get<SoundCache>()->getSound(SOUND_FILE); _created = true;} bool Keyboard::isRaised() const { return resultWithReadLock<bool>([&] { return _raised; });} void Keyboard::setRaised(bool raised, bool inputToHudUI) { bool isRaised; withReadLock([&] { isRaised = _raised; }); _inputToHudUI = inputToHudUI; if (isRaised != raised) { raiseKeyboardAnchor(raised); raiseKeyboard(raised); raised ? enableStylus() : disableStylus(); raised ? enableSelectionLists() : disableSelectionLists(); withWriteLock([&] { _raised = raised; _layerIndex = 0; _capsEnabled = false; _typedCharacters.clear(); addIncludeItemsToMallets(); }); updateTextDisplay(); }} void Keyboard::addIncludeItemsToMallets() { if (_layerIndex >= 0 && _layerIndex < (int)_keyboardLayers.size()) { QVector<QUuid> includeItems = _keyboardLayers[_layerIndex].keys().toVector(); auto pointerManager = DependencyManager::get<PointerManager>(); pointerManager->setIncludeItems(_leftHandStylus, includeItems); pointerManager->setIncludeItems(_rightHandStylus, includeItems); }} void Keyboard::updateTextDisplay() { auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); float sensorToWorldScale = myAvatar->getSensorToWorldScale(); EntityItemProperties properties; properties.setDimensions(_textDisplay.dimensions); properties.setText(_typedCharacters); properties.setLineHeight(_textDisplay.lineHeight * sensorToWorldScale); // FIXME: Text doesn't render properly when scaled, so beat // the text into shape with manually calculated margins properties.setRightMargin(_textDisplay.dimensions.x * -(sensorToWorldScale - 1.0f)); properties.setBottomMargin(_textDisplay.dimensions.y * -(sensorToWorldScale - 1.0f)); entityScriptingInterface->editEntity(_textDisplay.entityID, properties);} void Keyboard::raiseKeyboardAnchor(bool raise) const { auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); EntityItemProperties properties; properties.setVisible(raise); entityScriptingInterface->editEntity(_textDisplay.entityID, properties); properties.setIgnorePickIntersection(!raise); entityScriptingInterface->editEntity(_backPlate.entityID, properties); properties.setParentID(raise ? myAvatar->getSelfID() : QUuid()); properties.setParentJointIndex(raise ? SENSOR_TO_WORLD_MATRIX_INDEX : 0); if (_resetKeyboardPositionOnRaise) { std::pair<glm::vec3, glm::quat> keyboardLocation = calculateKeyboardPositionAndOrientation(); properties.setPosition(keyboardLocation.first); properties.setRotation(keyboardLocation.second); } entityScriptingInterface->editEntity(_anchor.entityID, properties);} void Keyboard::scaleKeyboard(float sensorToWorldScale) { auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); { EntityItemProperties properties; properties.setDimensions(_anchor.originalDimensions * sensorToWorldScale); entityScriptingInterface->editEntity(_anchor.entityID, properties); } { EntityItemProperties properties; properties.setLocalPosition(_backPlate.localPosition); properties.setDimensions(_backPlate.dimensions * sensorToWorldScale); entityScriptingInterface->editEntity(_backPlate.entityID, properties); } for (auto& keyboardLayer : _keyboardLayers) { for (auto iter = keyboardLayer.begin(); iter != keyboardLayer.end(); iter++) { iter.value().scaleKey(sensorToWorldScale); } } updateTextDisplay();} void Keyboard::startLayerSwitchTimer() { if (_layerSwitchTimer) { _layerSwitchTimer->start(LAYER_SWITCH_TIMEOUT_MS); _layerSwitchTimer->setSingleShot(true); }} bool Keyboard::isLayerSwitchTimerFinished() const { if (_layerSwitchTimer) { return (_layerSwitchTimer->remainingTime() <= 0); } return false;} void Keyboard::raiseKeyboard(bool raise) const { if (_keyboardLayers.empty()) { return; } const auto& keyboardLayer = _keyboardLayers[_layerIndex]; EntityItemProperties properties; properties.setVisible(raise); for (auto iter = keyboardLayer.begin(); iter != keyboardLayer.end(); iter++) { DependencyManager::get<EntityScriptingInterface>()->editEntity(iter.key(), properties); }} bool Keyboard::isPassword() const { return resultWithReadLock<bool>([&] { return _password; });} void Keyboard::setPassword(bool password) { if (_password != password) { withWriteLock([&] { _password = password; _typedCharacters.clear(); }); } updateTextDisplay();} void Keyboard::setResetKeyboardPositionOnRaise(bool reset) { if (_resetKeyboardPositionOnRaise != reset) { withWriteLock([&] { _resetKeyboardPositionOnRaise = reset; }); }} void Keyboard::setPreferMalletsOverLasers(bool preferMalletsOverLasers) { _preferMalletsOverLasersSettingLock.withWriteLock([&] { _preferMalletsOverLasers.set(preferMalletsOverLasers); });} bool Keyboard::getPreferMalletsOverLasers() const { return _preferMalletsOverLasersSettingLock.resultWithReadLock<bool>([&] { return _preferMalletsOverLasers.get(); });} void Keyboard::switchToLayer(int layerIndex) { auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); if (layerIndex >= 0 && layerIndex < (int)_keyboardLayers.size()) { EntityPropertyFlags desiredProperties; desiredProperties += PROP_POSITION; desiredProperties += PROP_ROTATION; auto oldProperties = entityScriptingInterface->getEntityPropertiesInternal(_anchor.entityID, desiredProperties, false); glm::vec3 currentPosition = oldProperties.getPosition(); glm::quat currentOrientation = oldProperties.getRotation(); Lines 1–500 of 1138. Load more
// // Keyboard.cpp // interface/src/scripting // // Created by Dante Ruiz on 2018-08-27. // Copyright 2018 High Fidelity, Inc. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html // #include "Keyboard.h" #include <utility> #include <glm/gtc/quaternion.hpp> #include <glm/gtx/quaternion.hpp> #include <QtGui/qevent.h> #include <QFile> #include <QTextStream> #include <QJsonArray> #include <QJsonDocument> #include <QJsonParseError> #include <PointerEvent.h> #include <PointerManager.h> #include <Pick.h> #include <controllers/UserInputMapper.h> #include <PathUtils.h> #include <ResourceManager.h> #include <SoundCache.h> #include <AudioInjectorManager.h> #include <RegisteredMetaTypes.h> #include <ui/TabletScriptingInterface.h> #include "avatar/AvatarManager.h" #include "avatar/MyAvatar.h" #include "avatar/AvatarManager.h" #include "raypick/PickScriptingInterface.h" #include "scripting/HMDScriptingInterface.h" #include "scripting/WindowScriptingInterface.h" #include "scripting/SelectionScriptingInterface.h" #include "scripting/HMDScriptingInterface.h" #include "DependencyManager.h" #include "raypick/StylusPointer.h" #include "GLMHelpers.h" #include "Application.h" #include "KeyEvent.h" static const int LEFT_HAND_CONTROLLER_INDEX = 0; static const int RIGHT_HAND_CONTROLLER_INDEX = 1; static const float MALLET_LENGTH = 0.18f; static const float MALLET_TOUCH_Y_OFFSET = 0.050f; static const float MALLET_Y_OFFSET = 0.160f; static const glm::quat MALLET_ROTATION_OFFSET{0.70710678f, 0.0f, -0.70710678f, 0.0f}; static const glm::vec3 MALLET_MODEL_DIMENSIONS{0.01f, MALLET_LENGTH, 0.01f}; static const glm::vec3 MALLET_POSITION_OFFSET{0.0f, -MALLET_Y_OFFSET / 2.0f, 0.0f}; static const glm::vec3 MALLET_TIP_OFFSET{0.0f, MALLET_LENGTH - MALLET_TOUCH_Y_OFFSET, 0.0f}; static const glm::vec3 Z_AXIS {0.0f, 0.0f, 1.0f}; static const glm::vec3 KEYBOARD_TABLET_OFFSET{0.30f, -0.38f, -0.04f}; static const glm::vec3 KEYBOARD_TABLET_DEGREES_OFFSET{-45.0f, 0.0f, 0.0f}; static const glm::vec3 KEYBOARD_TABLET_LANDSCAPE_OFFSET{-0.2f, -0.27f, -0.05f}; static const glm::vec3 KEYBOARD_TABLET_LANDSCAPE_DEGREES_OFFSET{-45.0f, 0.0f, -90.0f}; static const glm::vec3 KEYBOARD_AVATAR_OFFSET{-0.3f, 0.0f, -0.7f}; static const glm::vec3 KEYBOARD_AVATAR_DEGREES_OFFSET{0.0f, 180.0f, 0.0f}; static const QString SOUND_FILE = PathUtils::resourcesUrl() + "sounds/keyboardPress.mp3"; static const QString MALLET_MODEL_URL = PathUtils::resourcesUrl() + "meshes/drumstick.fbx"; static const float PULSE_STRENGTH = 0.6f; static const float PULSE_DURATION = 3.0f; static const int KEY_PRESS_TIMEOUT_MS = 100; static const int LAYER_SWITCH_TIMEOUT_MS = 200; static const QString CHARACTER_STRING = "character"; static const QString CAPS_STRING = "caps"; static const QString CLOSE_STRING = "close"; static const QString LAYER_STRING = "layer"; static const QString BACKSPACE_STRING = "backspace"; static const QString SPACE_STRING = "space"; static const QString ENTER_STRING = "enter"; static const QString SELECT_ALL_STRING = "select_all"; static const QString COPY_STRING = "copy"; static const QString CUT_STRING = "cut"; static const QString PASTE_STRING = "paste"; static const QString CURSOR_UP_STRING = "cursor_up"; static const QString CURSOR_RIGHT_STRING = "cursor_right"; static const QString CURSOR_DOWN_STRING = "cursor_down"; static const QString CURSOR_LEFT_STRING = "cursor_left"; static const QString KEY_HOVER_HIGHLIGHT = "keyHoverHiglight"; static const QString KEY_PRESSED_HIGHLIGHT = "keyPressesHighlight"; static const QVariantMap KEY_HOVERING_STYLE { { "isOutlineSmooth", true }, { "outlineWidth", 3 }, { "outlineUnoccludedColor", QVariantMap {{"red", 13}, {"green", 152}, {"blue", 186}}}, { "outlineUnoccludedAlpha", 1.0 }, { "outlineOccludedAlpha", 0.0 }, { "fillUnoccludedAlpha", 0.0 }, { "fillOccludedAlpha", 0.0 } }; static const QVariantMap KEY_PRESSING_STYLE { { "isOutlineSmooth", true }, { "outlineWidth", 3 }, { "fillUnoccludedColor", QVariantMap {{"red", 50}, {"green", 50}, {"blue", 50}}}, { "outlineUnoccludedAlpha", 0.0 }, { "outlineOccludedAlpha", 0.0 }, { "fillUnoccludedAlpha", 0.6 }, { "fillOccludedAlpha", 0.0 } }; std::pair<glm::vec3, glm::quat> calculateKeyboardPositionAndOrientation() { auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); auto hmd = DependencyManager::get<HMDScriptingInterface>(); std::pair<glm::vec3, glm::quat> keyboardLocation = std::make_pair(glm::vec3(), glm::quat()); float sensorToWorldScale = myAvatar->getSensorToWorldScale(); QUuid tabletID = hmd->getCurrentTabletFrameID(); if (!tabletID.isNull() && hmd->getShouldShowTablet()) { EntityPropertyFlags desiredProperties; desiredProperties += PROP_POSITION; desiredProperties += PROP_ROTATION; auto properties = DependencyManager::get<EntityScriptingInterface>()->getEntityPropertiesInternal(tabletID, desiredProperties, false); auto tablet = DependencyManager::get<TabletScriptingInterface>()->getTablet("com.highfidelity.interface.tablet.system"); bool landscapeMode = tablet->getLandscape(); glm::vec3 keyboardOffset = landscapeMode ? KEYBOARD_TABLET_LANDSCAPE_OFFSET : KEYBOARD_TABLET_OFFSET; glm::vec3 keyboardDegreesOffset = landscapeMode ? KEYBOARD_TABLET_LANDSCAPE_DEGREES_OFFSET : KEYBOARD_TABLET_DEGREES_OFFSET; glm::vec3 tabletWorldPosition = properties.getPosition(); glm::quat tabletWorldOrientation = properties.getRotation(); glm::vec3 scaledKeyboardTabletOffset = keyboardOffset * sensorToWorldScale; keyboardLocation.first = tabletWorldPosition + (tabletWorldOrientation * scaledKeyboardTabletOffset); keyboardLocation.second = tabletWorldOrientation * glm::quat(glm::radians(keyboardDegreesOffset)); } else { glm::vec3 avatarWorldPosition = myAvatar->getWorldPosition(); glm::quat avatarWorldOrientation = myAvatar->getWorldOrientation(); glm::vec3 scaledKeyboardAvatarOffset = KEYBOARD_AVATAR_OFFSET * sensorToWorldScale; keyboardLocation.first = avatarWorldPosition + (avatarWorldOrientation * scaledKeyboardAvatarOffset); keyboardLocation.second = avatarWorldOrientation * glm::quat(glm::radians(KEYBOARD_AVATAR_DEGREES_OFFSET)); } return keyboardLocation; } void Key::saveDimensionsAndLocalPosition() { EntityPropertyFlags desiredProperties; desiredProperties += PROP_LOCAL_POSITION; desiredProperties += PROP_DIMENSIONS; auto properties = DependencyManager::get<EntityScriptingInterface>()->getEntityPropertiesInternal(_keyID, desiredProperties, false); _originalLocalPosition = properties.getLocalPosition(); _originalDimensions = properties.getDimensions(); _currentLocalPosition = _originalLocalPosition; _originalDimensionsAndLocalPositionSaved = true; } void Key::scaleKey(float sensorToWorldScale) { if (_originalDimensionsAndLocalPositionSaved) { glm::vec3 scaledLocalPosition = _originalLocalPosition; glm::vec3 scaledDimensions = _originalDimensions * sensorToWorldScale; _currentLocalPosition = scaledLocalPosition; EntityItemProperties properties; properties.setDimensions(scaledDimensions); properties.setLocalPosition(scaledLocalPosition); DependencyManager::get<EntityScriptingInterface>()->editEntity(_keyID, properties); } } void Key::startTimer(int time) { if (_timer) { _timer->start(time); _timer->setSingleShot(true); } } bool Key::timerFinished() { if (_timer) { return (_timer->remainingTime() <= 0); } return false; } QString Key::getKeyString(bool toUpper) const { return toUpper ? _keyString.toUpper() : _keyString; } int Key::getScanCode(bool toUpper) const { QString character = toUpper ? _keyString.toUpper() : _keyString; auto utf8Key = character.toUtf8(); return (int)utf8Key[0]; } Key::Type Key::getKeyTypeFromString(const QString& keyTypeString) { if (keyTypeString == SPACE_STRING) { return Type::SPACE; } else if (keyTypeString == BACKSPACE_STRING) { return Type::BACKSPACE; } else if (keyTypeString == LAYER_STRING) { return Type::LAYER; } else if (keyTypeString == CAPS_STRING) { return Type::CAPS; } else if (keyTypeString == CLOSE_STRING) { return Type::CLOSE; } else if (keyTypeString == ENTER_STRING) { return Type::ENTER; } else if (keyTypeString == SELECT_ALL_STRING) { return Type::SELECT_ALL; } else if (keyTypeString == COPY_STRING) { return Type::COPY; } else if (keyTypeString == CUT_STRING) { return Type::CUT; } else if (keyTypeString == PASTE_STRING) { return Type::PASTE; } else if (keyTypeString == CURSOR_UP_STRING) { return Type::CURSOR_UP; } else if (keyTypeString == CURSOR_RIGHT_STRING) { return Type::CURSOR_RIGHT; } else if (keyTypeString == CURSOR_DOWN_STRING) { return Type::CURSOR_DOWN; } else if (keyTypeString == CURSOR_LEFT_STRING) { return Type::CURSOR_LEFT; } return Type::CHARACTER; } Keyboard::Keyboard() { auto pointerManager = DependencyManager::get<PointerManager>(); auto windowScriptingInterface = DependencyManager::get<WindowScriptingInterface>(); auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); auto hmdScriptingInterface = DependencyManager::get<HMDScriptingInterface>(); connect(pointerManager.data(), &PointerManager::triggerBeginOverlay, this, &Keyboard::handleTriggerBegin, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::triggerContinueOverlay, this, &Keyboard::handleTriggerContinue, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::triggerEndOverlay, this, &Keyboard::handleTriggerEnd, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::hoverBeginOverlay, this, &Keyboard::handleHoverBegin, Qt::QueuedConnection); connect(pointerManager.data(), &PointerManager::hoverEndOverlay, this, &Keyboard::handleHoverEnd, Qt::QueuedConnection); connect(myAvatar.get(), &MyAvatar::sensorToWorldScaleChanged, this, &Keyboard::scaleKeyboard, Qt::QueuedConnection); connect(windowScriptingInterface.data(), &WindowScriptingInterface::domainChanged, [&]() { setRaised(false); }); connect(hmdScriptingInterface.data(), &HMDScriptingInterface::displayModeChanged, [&]() { setRaised(false); }); } void Keyboard::registerKeyboardHighlighting() { auto selection = DependencyManager::get<SelectionScriptingInterface>(); selection->enableListHighlight(KEY_HOVER_HIGHLIGHT, KEY_HOVERING_STYLE); selection->enableListToScene(KEY_HOVER_HIGHLIGHT); selection->enableListHighlight(KEY_PRESSED_HIGHLIGHT, KEY_PRESSING_STYLE); selection->enableListToScene(KEY_PRESSED_HIGHLIGHT); } void Keyboard::disableSelectionLists() { auto selection = DependencyManager::get<SelectionScriptingInterface>(); selection->disableListHighlight(KEY_HOVER_HIGHLIGHT); selection->disableListHighlight(KEY_PRESSED_HIGHLIGHT); } void Keyboard::enableSelectionLists() { auto selection = DependencyManager::get<SelectionScriptingInterface>(); selection->enableListHighlight(KEY_HOVER_HIGHLIGHT, KEY_HOVERING_STYLE); selection->enableListHighlight(KEY_PRESSED_HIGHLIGHT, KEY_PRESSING_STYLE); } bool Keyboard::getUse3DKeyboard() const { return _use3DKeyboardLock.resultWithReadLock<bool>([&] { return _use3DKeyboard.get(); }); } void Keyboard::setUse3DKeyboard(bool use) { _use3DKeyboardLock.withWriteLock([&] { _use3DKeyboard.set(use); }); } void Keyboard::createKeyboard() { auto pointerManager = DependencyManager::get<PointerManager>(); if (_created) { pointerManager->removePointer(_leftHandStylus); pointerManager->removePointer(_rightHandStylus); clearKeyboardKeys(); } QVariantMap modelProperties { { "url", MALLET_MODEL_URL } }; QVariantMap leftStylusProperties { { "hand", LEFT_HAND_CONTROLLER_INDEX }, { "filter", PickScriptingInterface::getPickLocalEntities() }, { "model", modelProperties }, { "tipOffset", vec3toVariant(MALLET_TIP_OFFSET) } }; QVariantMap rightStylusProperties { { "hand", RIGHT_HAND_CONTROLLER_INDEX }, { "filter", PickScriptingInterface::getPickLocalEntities() }, { "model", modelProperties }, { "tipOffset", vec3toVariant(MALLET_TIP_OFFSET) } }; _leftHandStylus = pointerManager->addPointer(std::make_shared<StylusPointer>(leftStylusProperties, StylusPointer::buildStylus(leftStylusProperties), true, true, MALLET_POSITION_OFFSET, MALLET_ROTATION_OFFSET, MALLET_MODEL_DIMENSIONS)); _rightHandStylus = pointerManager->addPointer(std::make_shared<StylusPointer>(rightStylusProperties, StylusPointer::buildStylus(rightStylusProperties), true, true, MALLET_POSITION_OFFSET, MALLET_ROTATION_OFFSET, MALLET_MODEL_DIMENSIONS)); pointerManager->disablePointer(_rightHandStylus); pointerManager->disablePointer(_leftHandStylus); QString keyboardSvg = PathUtils::resourcesUrl() + "config/keyboard.json"; loadKeyboardFile(keyboardSvg); _keySound = DependencyManager::get<SoundCache>()->getSound(SOUND_FILE); _created = true; } bool Keyboard::isRaised() const { return resultWithReadLock<bool>([&] { return _raised; }); } void Keyboard::setRaised(bool raised, bool inputToHudUI) { bool isRaised; withReadLock([&] { isRaised = _raised; }); _inputToHudUI = inputToHudUI; if (isRaised != raised) { raiseKeyboardAnchor(raised); raiseKeyboard(raised); raised ? enableStylus() : disableStylus(); raised ? enableSelectionLists() : disableSelectionLists(); withWriteLock([&] { _raised = raised; _layerIndex = 0; _capsEnabled = false; _typedCharacters.clear(); addIncludeItemsToMallets(); }); updateTextDisplay(); } } void Keyboard::addIncludeItemsToMallets() { if (_layerIndex >= 0 && _layerIndex < (int)_keyboardLayers.size()) { QVector<QUuid> includeItems = _keyboardLayers[_layerIndex].keys().toVector(); auto pointerManager = DependencyManager::get<PointerManager>(); pointerManager->setIncludeItems(_leftHandStylus, includeItems); pointerManager->setIncludeItems(_rightHandStylus, includeItems); } } void Keyboard::updateTextDisplay() { auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); float sensorToWorldScale = myAvatar->getSensorToWorldScale(); EntityItemProperties properties; properties.setDimensions(_textDisplay.dimensions); properties.setText(_typedCharacters); properties.setLineHeight(_textDisplay.lineHeight * sensorToWorldScale); // FIXME: Text doesn't render properly when scaled, so beat // the text into shape with manually calculated margins properties.setRightMargin(_textDisplay.dimensions.x * -(sensorToWorldScale - 1.0f)); properties.setBottomMargin(_textDisplay.dimensions.y * -(sensorToWorldScale - 1.0f)); entityScriptingInterface->editEntity(_textDisplay.entityID, properties); } void Keyboard::raiseKeyboardAnchor(bool raise) const { auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); auto myAvatar = DependencyManager::get<AvatarManager>()->getMyAvatar(); EntityItemProperties properties; properties.setVisible(raise); entityScriptingInterface->editEntity(_textDisplay.entityID, properties); properties.setIgnorePickIntersection(!raise); entityScriptingInterface->editEntity(_backPlate.entityID, properties); properties.setParentID(raise ? myAvatar->getSelfID() : QUuid()); properties.setParentJointIndex(raise ? SENSOR_TO_WORLD_MATRIX_INDEX : 0); if (_resetKeyboardPositionOnRaise) { std::pair<glm::vec3, glm::quat> keyboardLocation = calculateKeyboardPositionAndOrientation(); properties.setPosition(keyboardLocation.first); properties.setRotation(keyboardLocation.second); } entityScriptingInterface->editEntity(_anchor.entityID, properties); } void Keyboard::scaleKeyboard(float sensorToWorldScale) { auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); { EntityItemProperties properties; properties.setDimensions(_anchor.originalDimensions * sensorToWorldScale); entityScriptingInterface->editEntity(_anchor.entityID, properties); } { EntityItemProperties properties; properties.setLocalPosition(_backPlate.localPosition); properties.setDimensions(_backPlate.dimensions * sensorToWorldScale); entityScriptingInterface->editEntity(_backPlate.entityID, properties); } for (auto& keyboardLayer : _keyboardLayers) { for (auto iter = keyboardLayer.begin(); iter != keyboardLayer.end(); iter++) { iter.value().scaleKey(sensorToWorldScale); } } updateTextDisplay(); } void Keyboard::startLayerSwitchTimer() { if (_layerSwitchTimer) { _layerSwitchTimer->start(LAYER_SWITCH_TIMEOUT_MS); _layerSwitchTimer->setSingleShot(true); } } bool Keyboard::isLayerSwitchTimerFinished() const { if (_layerSwitchTimer) { return (_layerSwitchTimer->remainingTime() <= 0); } return false; } void Keyboard::raiseKeyboard(bool raise) const { if (_keyboardLayers.empty()) { return; } const auto& keyboardLayer = _keyboardLayers[_layerIndex]; EntityItemProperties properties; properties.setVisible(raise); for (auto iter = keyboardLayer.begin(); iter != keyboardLayer.end(); iter++) { DependencyManager::get<EntityScriptingInterface>()->editEntity(iter.key(), properties); } } bool Keyboard::isPassword() const { return resultWithReadLock<bool>([&] { return _password; }); } void Keyboard::setPassword(bool password) { if (_password != password) { withWriteLock([&] { _password = password; _typedCharacters.clear(); }); } updateTextDisplay(); } void Keyboard::setResetKeyboardPositionOnRaise(bool reset) { if (_resetKeyboardPositionOnRaise != reset) { withWriteLock([&] { _resetKeyboardPositionOnRaise = reset; }); } } void Keyboard::setPreferMalletsOverLasers(bool preferMalletsOverLasers) { _preferMalletsOverLasersSettingLock.withWriteLock([&] { _preferMalletsOverLasers.set(preferMalletsOverLasers); }); } bool Keyboard::getPreferMalletsOverLasers() const { return _preferMalletsOverLasersSettingLock.resultWithReadLock<bool>([&] { return _preferMalletsOverLasers.get(); }); } void Keyboard::switchToLayer(int layerIndex) { auto entityScriptingInterface = DependencyManager::get<EntityScriptingInterface>(); if (layerIndex >= 0 && layerIndex < (int)_keyboardLayers.size()) { EntityPropertyFlags desiredProperties; desiredProperties += PROP_POSITION; desiredProperties += PROP_ROTATION; auto oldProperties = entityScriptingInterface->getEntityPropertiesInternal(_anchor.entityID, desiredProperties, false); glm::vec3 currentPosition = oldProperties.getPosition(); glm::quat currentOrientation = oldProperties.getRotation();