diff --git a/BUILD.md b/BUILD.md index f647cff476..c3bebb749b 100644 --- a/BUILD.md +++ b/BUILD.md @@ -42,15 +42,17 @@ Vircadia uses CMake to generate build files and project files for your platform. #### Qt -CMake will download Qt 5.12.3 using vcpkg. +CMake will download Qt 5.12.3 using vcpkg. -To override this (i.e. use an installed Qt configuration - you will need to set a QT_CMAKE_PREFIX_PATH environment variable pointing to your Qt **lib/cmake** folder. +To override this (i.e. use an installed Qt configuration - you will need to set a QT_CMAKE_PREFIX_PATH environment variable pointing to your Qt **lib/cmake** folder. This can either be entered directly into your shell session before you build or in your shell profile (e.g.: ~/.bash_profile, ~/.bashrc, ~/.zshrc - this depends on your shell and environment). The path it needs to be set to will depend on where and how Qt5 was installed. e.g. - export QT_CMAKE_PREFIX_PATH=/usr/local/Qt5.12.3/gcc_64/lib/cmake - export QT_CMAKE_PREFIX_PATH=/usr/local/qt/5.12.3/clang_64/lib/cmake/ - export QT_CMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.12.3/lib/cmake - export QT_CMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake +```bash +export QT_CMAKE_PREFIX_PATH=/usr/local/Qt5.12.3/gcc_64/lib/cmake +export QT_CMAKE_PREFIX_PATH=/usr/local/qt/5.12.3/clang_64/lib/cmake/ +export QT_CMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.12.3/lib/cmake +export QT_CMAKE_PREFIX_PATH=/usr/local/opt/qt5/lib/cmake +``` #### VCPKG @@ -60,7 +62,9 @@ You do not need to install vcpkg. Building the dependencies can be lengthy and the resulting files will be stored in your OS temp directory. However, those files can potentially get cleaned up by the OS, so in order to avoid this and having to redo the lengthy build step, you can set the following environment variable: - export HIFI_VCPKG_BASE=/path/to/directory +```bash +export HIFI_VCPKG_BASE=/path/to/directory +``` Where `/path/to/directory` is the path to a directory where you wish the build files to get stored. @@ -68,48 +72,52 @@ Where `/path/to/directory` is the path to a directory where you wish the build f ##### Possible Environment Variables - // The URL to post the dump to. - CMAKE_BACKTRACE_URL - // The identifying tag of the release. - CMAKE_BACKTRACE_TOKEN - - // The release version, e.g., 2021.3.2. - RELEASE_NUMBER - // The release name, e.g., Eos. - RELEASE_NAME - // The build commit, e.g., use a Git hash for the most recent commit in the branch - fd6973b. - - BUILD_NUMBER - - // The type of release. - RELEASE_TYPE=PRODUCTION|PR|DEV - - // The Interface will have a custom default home and startup location. - PRELOADED_STARTUP_LOCATION=Location/IP/URL - // The Interface will have a custom default script whitelist, comma separated, no spaces. - // This will also activate the whitelist on Interface's first run. - PRELOADED_SCRIPT_WHITELIST=ListOfEntries - - // Code-signing environment variables must be set during runtime of CMake AND globally when the signing takes place. - HF_PFX_FILE=Path to certificate - HF_PFX_PASSPHRASE=Passphrase for certificate - - // Determine the build type - PRODUCTION_BUILD=0|1 - PR_BUILD=0|1 - STABLE_BUILD=0|1 - - // Determine if to utilize testing or stable Metaverse URLs - USE_STABLE_GLOBAL_SERVICES=1 - BUILD_GLOBAL_SERVICES=STABLE - +```text +// The URL to post the dump to. +CMAKE_BACKTRACE_URL +// The identifying tag of the release. +CMAKE_BACKTRACE_TOKEN + +// The release version, e.g., 2021.3.2. +RELEASE_NUMBER +// The release name, e.g., Eos. +RELEASE_NAME +// The build commit, e.g., use a Git hash for the most recent commit in the branch - fd6973b. + +BUILD_NUMBER + +// The type of release. +RELEASE_TYPE=PRODUCTION|PR|DEV + +// The Interface will have a custom default home and startup location. +PRELOADED_STARTUP_LOCATION=Location/IP/URL +// The Interface will have a custom default script whitelist, comma separated, no spaces. +// This will also activate the whitelist on Interface's first run. +PRELOADED_SCRIPT_WHITELIST=ListOfEntries + +// Code-signing environment variables must be set during runtime of CMake AND globally when the signing takes place. +HF_PFX_FILE=Path to certificate +HF_PFX_PASSPHRASE=Passphrase for certificate + +// Determine the build type +PRODUCTION_BUILD=0|1 +PR_BUILD=0|1 +STABLE_BUILD=0|1 + +// Determine if to utilize testing or stable Metaverse URLs +USE_STABLE_GLOBAL_SERVICES=1 +BUILD_GLOBAL_SERVICES=STABLE +``` + ##### Generate Files Create a build directory in the root of your checkout and then run the CMake build from there. This will keep the rest of the directory clean. - mkdir build - cd build - cmake .. +```bash +mkdir build +cd build +cmake .. +``` If CMake gives you the same error message repeatedly after the build fails, try removing `CMakeCache.txt`. @@ -131,7 +139,9 @@ Any variables that need to be set for CMake to find dependencies can be set as E For example, to pass the QT_CMAKE_PREFIX_PATH variable (if not using the vcpkg'ed version) during build file generation: - cmake .. -DQT_CMAKE_PREFIX_PATH=/usr/local/qt/5.12.3/lib/cmake +```bash +cmake .. -DQT_CMAKE_PREFIX_PATH=/usr/local/qt/5.12.3/lib/cmake +``` #### Finding Dependencies diff --git a/BUILD_ANDROID.md b/BUILD_ANDROID.md index c52f6a1d8f..0556e175d6 100644 --- a/BUILD_ANDROID.md +++ b/BUILD_ANDROID.md @@ -42,11 +42,13 @@ Follow the directions [here](https://developer.android.com/studio/publish/app-si Create a `gradle.properties` file in the `.gradle` folder (`$HOME/.gradle` on Unix, `Users//.gradle` on Windows). Edit the file to contain the following - HIFI_ANDROID_PRECOMPILED=/Android/hifi_externals - HIFI_ANDROID_KEYSTORE=/.jks - HIFI_ANDROID_KEYSTORE_PASSWORD= - HIFI_ANDROID_KEY_ALIAS= - HIFI_ANDROID_KEY_PASSWORD= +```properties +HIFI_ANDROID_PRECOMPILED=/Android/hifi_externals +HIFI_ANDROID_KEYSTORE=/.jks +HIFI_ANDROID_KEYSTORE_PASSWORD= +HIFI_ANDROID_KEY_ALIAS= +HIFI_ANDROID_KEY_PASSWORD= +``` Note, do not use $HOME for the path. It must be a fully qualified path name. Also, be sure to use forward slashes in your path. @@ -54,21 +56,26 @@ Note, do not use $HOME for the path. It must be a fully qualified path name. Als Add these lines to `gradle.properties` - SUPPRESS_QUEST_INTERFACE - SUPPRESS_QUEST_FRAME_PLAYER +```properties +SUPPRESS_QUEST_INTERFACE +SUPPRESS_QUEST_FRAME_PLAYER +``` #### If you are building for an Oculus Quest Add these lines to `gradle.properties` - SUPPRESS_INTERFACE - SUPPRESS_FRAME_PLAYER - +```properties +SUPPRESS_INTERFACE +SUPPRESS_FRAME_PLAYER +``` #### The Frame Player for both Android Phone and Oculus Quest is optional, so if you encounter problems with these during your build, you can skip them by adding these lines to `gradle.properties` - SUPPRESS_FRAME_PLAYER - SUPPRESS_QUEST_FRAME_PLAYER +```properties +SUPPRESS_FRAME_PLAYER +SUPPRESS_QUEST_FRAME_PLAYER +``` ### Clone the repository diff --git a/BUILD_LINUX.md b/BUILD_LINUX.md index 90782e90b4..e9c5047e38 100644 --- a/BUILD_LINUX.md +++ b/BUILD_LINUX.md @@ -168,39 +168,3 @@ If your goal is to set up a development environment, it is desirable to set the directory that vcpkg builds into with the `HIFI_VCPKG_BASE` environment variable. For example, you might set `HIFI_VCPKG_BASE` to `/home/$USER/vcpkg`. By default, vcpkg will build in the system `/tmp` directory. - -##### Ubuntu 18.04 only - -In Ubuntu 18.04 there is a problem related with NVidia driver library version. - -It can be worked around following these steps: - -1. Uninstall incompatible nvtt libraries: -`sudo apt-get remove libnvtt2 libnvtt-dev` - -1. Install libssl1.0-dev: -`sudo apt-get -y install libssl1.0-dev` - -1. Clone castano nvidia-texture-tools: -`git clone https://github.com/castano/nvidia-texture-tools` -`cd nvidia-texture-tools/` - -1. Make these changes in repo: -* In file **VERSION** set `2.2.1` -* In file **configure**: - * set `build="release"` - * set `-DNVTT_SHARED=1` - -1. Configure, build and install: -`./configure` -`make` -`sudo make install` - -1. Link compiled files: -`sudo ln -s /usr/local/lib/libnvcore.so /usr/lib/libnvcore.so` -`sudo ln -s /usr/local/lib/libnvimage.so /usr/lib/libnvimage.so` -`sudo ln -s /usr/local/lib/libnvmath.so /usr/lib/libnvmath.so` -`sudo ln -s /usr/local/lib/libnvtt.so /usr/lib/libnvtt.so` - -1. After running these steps you can run interface: -`interface/interface` diff --git a/BUILD_OSX.md b/BUILD_OSX.md index 525a7a5965..9bf1985409 100644 --- a/BUILD_OSX.md +++ b/BUILD_OSX.md @@ -8,22 +8,26 @@ Please read the [general build guide](BUILD.md) for information on dependencies [Homebrew](https://brew.sh/) is an excellent package manager for macOS. It makes install of some Vircadia dependencies very simple. - brew install cmake openssl npm +```bash +brew install cmake openssl npm +``` ### Python 3 -Download an install Python 3.6.6 or higher from [here](https://www.python.org/downloads/). +Download an install Python 3.6.6 or higher from [here](https://www.python.org/downloads/). Execute the `Update Shell Profile.command` script that is provided with the installer. ### OSX SDK You will need version `10.12` of the OSX SDK for building, otherwise you may have crashing or other unintended issues due to the deprecation of OpenGL on OSX. You can get that SDK from [here](https://github.com/phracker/MacOSX-SDKs). You must copy it in to your Xcode SDK directory, e.g. - cp -rp ~/Downloads/MacOSX10.12.sdk /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ +```bash +cp -rp ~/Downloads/MacOSX10.12.sdk /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ +``` ### OpenSSL -Assuming you've installed OpenSSL using the homebrew instructions above, you'll need to set OPENSSL_ROOT_DIR so CMake can find your installations. +Assuming you've installed OpenSSL using the homebrew instructions above, you'll need to set OPENSSL_ROOT_DIR so CMake can find your installations. For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR via `export OPENSSL_ROOT_DIR=/usr/local/opt/openssl` or by appending `-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl` to `cmake` @@ -31,12 +35,14 @@ For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR via ### Xcode You can ask CMake to generate Xcode project files instead of Unix Makefiles using the `-G Xcode` parameter after CMake. You will need to select the Xcode installation in the terminal first if you have not done so already. - - sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer - - cmake ../ -DCMAKE_OSX_SYSROOT="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.12.sdk" -DCMAKE_OSX_DEPLOYMENT_TARGET=10.12 -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DOSX_SDK=10.12 .. -If `cmake` complains about Python 3 being missing, you may need to update your CMake binary with command `brew upgrade cmake`, or by downloading and running the latest CMake installer, depending on how you originally instaled CMake +```bash +sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer + +cmake ../ -DCMAKE_OSX_SYSROOT="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.12.sdk" -DCMAKE_OSX_DEPLOYMENT_TARGET=10.12 -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DOSX_SDK=10.12 .. +``` + +If `cmake` complains about Python 3 being missing, you may need to update your CMake binary with command `brew upgrade cmake`, or by downloading and running the latest CMake installer, depending on how you originally installed CMake. After running CMake, you will have the make files or Xcode project file necessary to build all of the components. Open the hifi.xcodeproj file, choose ALL_BUILD from the Product > Scheme menu (or target drop down), and click Run. diff --git a/INSTALLER.md b/INSTALLER.md index 4f6ebc174d..4132ef7298 100644 --- a/INSTALLER.md +++ b/INSTALLER.md @@ -105,70 +105,70 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Ubuntu 18.04 | .deb 1. Ensure you are using an Ubuntu 18.04 system. There is no required minimum to the amount of CPU cores needed, however it's recommended that you use as many as you have available in order to have an efficient experience. - ``` + ```text Recommended CPU Cores: 16 Minimum Disk Space: 40GB ``` 3. Get and bootstrap Vircadia Builder. - ``` + ```bash git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder ``` 3. Run Vircadia Builder. - ``` + ```bash ./vircadia-builder --build server ``` 4. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. Otherwise, skip to the next step. - ``` + ```bash ./vircadia-builder --build server ``` 5. Vircadia Builder will ask you to configure it to build the server. The values will be prefilled with defaults, the following steps will explain what they are and what you might want to put. *Advanced users: See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings.* 6. This value is the Git repository of Vircadia. You can set this URL to your fork of the Vircadia repository if you need to. - ``` + ```text Git repository: https://github.com/vircadia/vircadia/ # OR, for example Git repository: https://github.com/digisomni/vircadia/ ``` 7. This value is the tag on the repository. If you would like to use a specific version of Vircadia, typically tags will be named like this: "v2021.1.0-rc" - ``` + ```text Git tag: master # OR, for example Git tag: v2021.1.0-rc ``` 8. This value is the release type. For example, the options are `production`, `pr`, or `dev`. If you are making a build for yourself and others to use then use `production`. - ``` + ```text Release type: DEV # OR, for example we recommend you use Release type: PRODUCTION ``` 9. This value is the release version. Release numbers should be in a format of `YEAR-MAJORVERSION-MINORVERSION` which might look like this: `2021.1.0`. - ``` + ```text Release number: 2021.1.0 ``` 10. This value is the build number. We typically use the hash of the most recent commit on that Git tag which might look like this: `fd6973b`. - ``` + ```text Build number: fd6973b ``` 11. This value is the directory that Vircadia will get installed to. You should leave this as the default value unless you are an advanced user. - ``` + ```text Installation dir: /home/ubuntu/Vircadia ``` 12. This value is the number of CPU cores that the Vircadia Builder will use to compile the Vircadia server. By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. - ``` + ```text CPU cores to use for Vircadia: 16 ``` 13. This value is the number of CPU cores that the Vircadia Builder will use to compile Qt5 (a required component for Vircadia). By default it will use all cores available on your build server. You should leave this as the default value it gives you for your build server. - ``` + ```text CPU cores to use for Qt5: 16 ``` 14. It will ask you if you would like to proceed with the specified values. If you're happy with the configuration, type `yes`, otherwise enter `no` and press enter to start over. You can press `Ctrl` + `C` simultaneously on your keyboard to exit. 15. Vircadia Builder will now run, it may take a while. See this [table](https://github.com/vircadia/vircadia-builder#how-long-does-it-take) for estimated times. 16. Navigate to the `pkg-scripts` directory. - ``` + ```bash cd ../Vircadia/source/pkg-scripts/ ``` 17. Generate the .rpm package. Set `RPMVERSION` to the same version you entered for the `Release number` on Vircadia Builder. *Advanced users: the version cannot begin with a letter and cannot include underscores or dashes in it.* - ``` + ```bash DEBVERSION="2021.1.0" DEBEMAIL="your-email@somewhere.com" DEBFULLNAME="Your Full Name" ./make-deb-server ``` 18. If successful, the generated .deb package will be in the `pkg-scripts` folder. @@ -176,78 +176,78 @@ For code signing to work, you will need to set the `HF_PFX_FILE` and `HF_PFX_PAS ##### Amazon Linux 2 | .rpm 1. Ensure you are using an Amazon Linux 2 system. You will need many CPU cores to complete this process within a reasonable time. As an alternative to AWS EC2, you may use a [virtual machine](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/amazon-linux-2-virtual-machine.html). Here are the recommended specs: - ``` + ```text AWS EC2 Instance Type: C5a.4xlarge Recommended CPU Cores: 16 Minimum Disk Space: 40GB ``` 2. Update the system and install dependencies. - ``` + ```bash sudo yum update -y sudo yum install git -y sudo yum install rpm-build ``` 3. Get and bootstrap Vircadia Builder. - ``` + ```bash git clone https://github.com/vircadia/vircadia-builder.git cd vircadia-builder sudo ./install_amazon_linux_deps.sh ``` 4. Run Vircadia Builder. - ``` + ```bash ./vircadia-builder --build server ``` 5. If Vircadia Builder needed to install dependencies and asks you to run it again then do so. Otherwise, skip to the next step. - ``` + ```bash ./vircadia-builder --build server ``` 6. Vircadia Builder will ask you to configure it to build the server. The values will be prefilled with defaults, the following steps will explain what they are and what you might want to put. *Advanced users: See [here](BUILD.md#possible-environment-variables) for possible environment variables and settings.* 7. This value is the Git repository of Vircadia. You can set this URL to your fork of the Vircadia repository if you need to. - ``` + ```text Git repository: https://github.com/vircadia/vircadia/ # OR, for example Git repository: https://github.com/digisomni/vircadia/ ``` 8. This value is the tag on the repository. If you would like to use a specific version of Vircadia, typically tags will be named like this: "v2021.1.0-rc". - ``` + ```text Git tag: master # OR, for example Git tag: v2021.1.0-rc ``` 9. This value is the release type. For example, the options are `production`, `pr`, or `dev`. If you are making a build for yourself and others to use then use `production`. - ``` + ```text Release type: DEV # OR, for example we recommend you use Release type: PRODUCTION ``` 10. This value is the release version. Release numbers typically should be in a format of `YEAR-MAJORVERSION-MINORVERSION` which might look like this: `2021.1.0`. - ``` + ```text Release number: 2021.1.0 ``` 11. This value is the build number. We typically use the hash of the most recent commit on that Git tag which might look like this: `fd6973b`. - ``` + ```text Build number: fd6973b ``` 12. This value is the directory that Vircadia will get installed to. You should leave this as the default value unless you are an advanced user. - ``` + ```text Installation dir: /root/Vircadia ``` 13. This value is the number of CPU cores that the Vircadia Builder will use to compile the Vircadia server. By default it will use all cores available on your build server given you have enough memory. You should leave this as the default value it gives you for your build server. - ``` + ```text CPU cores to use for Vircadia: 16 ``` 14. This value is the number of CPU cores that the Vircadia Builder will use to compile Qt5 (a required component for Vircadia). By default it will use all cores available on your build server given you have enough memory. You should leave this as the default value it gives you for your build server. - ``` + ```text CPU cores to use for Qt5: 16 ``` 15. It will ask you if you would like to proceed with the specified values. If you're happy with the configuration, type `yes`, otherwise enter `no` and press enter to start over. You can press `Ctrl` + `C` simultaneously on your keyboard to exit. 16. Vircadia Builder will now run, it may take a while. See this [table](https://github.com/vircadia/vircadia-builder#how-long-does-it-take) for estimated times. 17. Navigate to the `pkg-scripts` directory. - ``` + ```bash cd ../Vircadia/source/pkg-scripts/ ``` 18. Generate the .rpm package. Set `RPMVERSION` to the same version you entered for the `Release number` on Vircadia Builder. *Advanced users: the version cannot begin with a letter and cannot include underscores or dashes in it.* - ``` + ```bash RPMVERSION="2021.1.0" ./make-rpm-server ``` 19. If successful, the generated .rpm package will be in the `pkg-scripts` folder of the Vircadia source files. diff --git a/libraries/controllers/src/controllers/InputDevice.h b/libraries/controllers/src/controllers/InputDevice.h index 95d0524a4a..dc8e811f0c 100644 --- a/libraries/controllers/src/controllers/InputDevice.h +++ b/libraries/controllers/src/controllers/InputDevice.h @@ -118,7 +118,7 @@ public: const QString& getName() const { return _name; } // By default, Input Devices do not support haptics - virtual bool triggerHapticPulse(float strength, float duration, controller::Hand hand) { return false; } + virtual bool triggerHapticPulse(float strength, float duration, uint16_t index) { return false; } // Update call MUST be called once per simulation loop // It takes care of updating the action states and deltas diff --git a/libraries/controllers/src/controllers/ScriptingInterface.cpp b/libraries/controllers/src/controllers/ScriptingInterface.cpp index fd32b2eb43..e9a831859d 100644 --- a/libraries/controllers/src/controllers/ScriptingInterface.cpp +++ b/libraries/controllers/src/controllers/ScriptingInterface.cpp @@ -134,13 +134,13 @@ namespace controller { return DependencyManager::get()->getActionNames(); } - bool ScriptingInterface::triggerHapticPulse(float strength, float duration, controller::Hand hand) const { - return DependencyManager::get()->triggerHapticPulse(strength, duration, hand); + bool ScriptingInterface::triggerHapticPulse(float strength, float duration, uint16_t index) const { + return DependencyManager::get()->triggerHapticPulse(strength, duration, index); } - bool ScriptingInterface::triggerShortHapticPulse(float strength, controller::Hand hand) const { + bool ScriptingInterface::triggerShortHapticPulse(float strength, uint16_t index) const { const float SHORT_HAPTIC_DURATION_MS = 250.0f; - return DependencyManager::get()->triggerHapticPulse(strength, SHORT_HAPTIC_DURATION_MS, hand); + return DependencyManager::get()->triggerHapticPulse(strength, SHORT_HAPTIC_DURATION_MS, index); } void ScriptingInterface::startInputRecording() { @@ -189,13 +189,13 @@ namespace controller { emit inputDeviceRunningChanged(deviceName, isRunning); } - bool ScriptingInterface::triggerHapticPulseOnDevice(unsigned int device, float strength, float duration, controller::Hand hand) const { - return DependencyManager::get()->triggerHapticPulseOnDevice(device, strength, duration, hand); + bool ScriptingInterface::triggerHapticPulseOnDevice(unsigned int device, float strength, float duration, uint16_t index) const { + return DependencyManager::get()->triggerHapticPulseOnDevice(device, strength, duration, index); } - bool ScriptingInterface::triggerShortHapticPulseOnDevice(unsigned int device, float strength, controller::Hand hand) const { + bool ScriptingInterface::triggerShortHapticPulseOnDevice(unsigned int device, float strength, uint16_t index) const { const float SHORT_HAPTIC_DURATION_MS = 250.0f; - return DependencyManager::get()->triggerHapticPulseOnDevice(device, strength, SHORT_HAPTIC_DURATION_MS, hand); + return DependencyManager::get()->triggerHapticPulseOnDevice(device, strength, SHORT_HAPTIC_DURATION_MS, index); } void ScriptingInterface::updateMaps() { diff --git a/libraries/controllers/src/controllers/ScriptingInterface.h b/libraries/controllers/src/controllers/ScriptingInterface.h index a1875c7fe8..076146a79d 100644 --- a/libraries/controllers/src/controllers/ScriptingInterface.h +++ b/libraries/controllers/src/controllers/ScriptingInterface.h @@ -212,22 +212,28 @@ namespace controller { * @function Controller.triggerHapticPulse * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. * @param {number} duration - The duration of the haptic pulse, in milliseconds. - * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. + * @param {number} [index=2] - The index on devices on which to trigger the haptic pulse. The meaning of each index + * will vary by device. For example, for hand controllers, index = 0 is the left hand, + * index = 1 is the right hand, and index = 2 is both hands. For other devices, + * such as haptic vests, index will have a different meaning, defined by the input device. * @example Trigger a haptic pulse on the right hand. * var HAPTIC_STRENGTH = 0.5; * var HAPTIC_DURATION = 10; * var RIGHT_HAND = 1; * Controller.triggerHapticPulse(HAPTIC_STRENGTH, HAPTIC_DURATION, RIGHT_HAND); */ - Q_INVOKABLE bool triggerHapticPulse(float strength, float duration, controller::Hand hand = BOTH) const; + Q_INVOKABLE bool triggerHapticPulse(float strength, float duration, uint16_t index = 2) const; /**jsdoc * Triggers a 250ms haptic pulse on connected and enabled devices that have the capability. * @function Controller.triggerShortHapticPulse * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. - * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. + * @param {number} [index=2] - The index on devices on which to trigger the haptic pulse. The meaning of each index + * will vary by device. For example, for hand controllers, index = 0 is the left hand, + * index = 1 is the right hand, and index = 2 is both hands. For other devices, + * such as haptic vests, index will have a different meaning, defined by the input device. */ - Q_INVOKABLE bool triggerShortHapticPulse(float strength, controller::Hand hand = BOTH) const; + Q_INVOKABLE bool triggerShortHapticPulse(float strength, uint16_t index = 2) const; /**jsdoc * Triggers a haptic pulse on a particular device if connected and enabled and it has the capability. @@ -235,7 +241,10 @@ namespace controller { * @param {number} deviceID - The ID of the device to trigger the haptic pulse on. * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. * @param {number} duration - The duration of the haptic pulse, in milliseconds. - * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. + * @param {number} [index=2] - The index on this device on which to trigger the haptic pulse. The meaning of each index + * will vary by device. For example, for hand controllers, index = 0 is the left hand, + * index = 1 is the right hand, and index = 2 is both hands. For other devices, + * such as haptic vests, index will have a different meaning, defined by the input device. * @example Trigger a haptic pulse on an Oculus Touch controller. * var HAPTIC_STRENGTH = 0.5; * var deviceID = Controller.findDevice("OculusTouch"); @@ -243,19 +252,20 @@ namespace controller { * var RIGHT_HAND = 1; * Controller.triggerHapticPulseOnDevice(deviceID, HAPTIC_STRENGTH, HAPTIC_DURATION, RIGHT_HAND); */ - Q_INVOKABLE bool triggerHapticPulseOnDevice(unsigned int device, float strength, float duration, - controller::Hand hand = BOTH) const; + Q_INVOKABLE bool triggerHapticPulseOnDevice(unsigned int device, float strength, float duration, + uint16_t index = 2) const; /**jsdoc * Triggers a 250ms haptic pulse on a particular device if connected and enabled and it has the capability. * @function Controller.triggerShortHapticPulseOnDevice * @param {number} deviceID - The ID of the device to trigger the haptic pulse on. * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. - * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. + * @param {number} [index=2] - The index on this device on which to trigger the haptic pulse. The meaning of each index + * will vary by device. For example, for hand controllers, index = 0 is the left hand, + * index = 1 is the right hand, and index = 2 is both hands. For other devices, + * such as haptic vests, index will have a different meaning, defined by the input device. */ - Q_INVOKABLE bool triggerShortHapticPulseOnDevice(unsigned int device, float strength, controller::Hand hand = BOTH) - const; - + Q_INVOKABLE bool triggerShortHapticPulseOnDevice(unsigned int device, float strength, uint16_t index = 2) const; /**jsdoc * Creates a new controller mapping. Routes can then be added to the mapping using {@link MappingObject} methods and diff --git a/libraries/controllers/src/controllers/UserInputMapper.cpp b/libraries/controllers/src/controllers/UserInputMapper.cpp index 604a4f9c73..6333792b3f 100755 --- a/libraries/controllers/src/controllers/UserInputMapper.cpp +++ b/libraries/controllers/src/controllers/UserInputMapper.cpp @@ -365,19 +365,19 @@ Pose UserInputMapper::getPoseState(Action action) const { } -bool UserInputMapper::triggerHapticPulse(float strength, float duration, controller::Hand hand) { +bool UserInputMapper::triggerHapticPulse(float strength, float duration, uint16_t index) { Locker locker(_lock); bool toReturn = false; for (const auto& device : _registeredDevices) { - toReturn = device.second->triggerHapticPulse(strength, duration, hand) || toReturn; + toReturn = device.second->triggerHapticPulse(strength, duration, index) || toReturn; } return toReturn; } -bool UserInputMapper::triggerHapticPulseOnDevice(uint16 deviceID, float strength, float duration, controller::Hand hand) { +bool UserInputMapper::triggerHapticPulseOnDevice(uint16 deviceID, float strength, float duration, uint16_t index) { Locker locker(_lock); if (_registeredDevices.find(deviceID) != _registeredDevices.end()) { - return _registeredDevices[deviceID]->triggerHapticPulse(strength, duration, hand); + return _registeredDevices[deviceID]->triggerHapticPulse(strength, duration, index); } return false; } diff --git a/libraries/controllers/src/controllers/UserInputMapper.h b/libraries/controllers/src/controllers/UserInputMapper.h index 79fcf6e64c..ee8b34193f 100644 --- a/libraries/controllers/src/controllers/UserInputMapper.h +++ b/libraries/controllers/src/controllers/UserInputMapper.h @@ -91,8 +91,8 @@ namespace controller { void setActionState(Action action, float value, bool valid = true); void deltaActionState(Action action, float delta, bool valid = true); void setActionState(Action action, const Pose& value) { _poseStates[toInt(action)] = value; } - bool triggerHapticPulse(float strength, float duration, controller::Hand hand); - bool triggerHapticPulseOnDevice(uint16 deviceID, float strength, float duration, controller::Hand hand); + bool triggerHapticPulse(float strength, float duration, uint16_t index); + bool triggerHapticPulseOnDevice(uint16 deviceID, float strength, float duration, uint16_t index); static Input makeStandardInput(controller::StandardButtonChannel button); static Input makeStandardInput(controller::StandardAxisChannel axis); diff --git a/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.cpp b/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.cpp index 6bb743bad0..6ba2d0eeea 100644 --- a/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.cpp +++ b/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.cpp @@ -199,7 +199,7 @@ void TouchscreenVirtualPadDevice::InputDevice::update(float deltaTime, const con _axisStateMap.clear(); } -bool TouchscreenVirtualPadDevice::InputDevice::triggerHapticPulse(float strength, float duration, controller::Hand hand) { +bool TouchscreenVirtualPadDevice::InputDevice::triggerHapticPulse(float strength, float duration, uint16_t index) { auto& virtualPadManager = VirtualPad::Manager::instance(); virtualPadManager.requestHapticFeedback((int) duration); return true; diff --git a/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.h b/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.h index 8c276fb66b..1fa46f8a24 100644 --- a/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.h +++ b/libraries/input-plugins/src/input-plugins/TouchscreenVirtualPadDevice.h @@ -71,7 +71,7 @@ protected: virtual controller::Input::NamedVector getAvailableInputs() const override; virtual QString getDefaultMappingConfig() const override; - virtual bool triggerHapticPulse(float strength, float duration, controller::Hand hand) override; + virtual bool triggerHapticPulse(float strength, float duration, uint16_t index) override; virtual void update(float deltaTime, const controller::InputCalibrationData& inputCalibrationData) override; virtual void focusOutEvent() override; diff --git a/libraries/oculusMobilePlugin/src/OculusMobileControllerManager.cpp b/libraries/oculusMobilePlugin/src/OculusMobileControllerManager.cpp index 54a796954e..ec744ce039 100644 --- a/libraries/oculusMobilePlugin/src/OculusMobileControllerManager.cpp +++ b/libraries/oculusMobilePlugin/src/OculusMobileControllerManager.cpp @@ -161,7 +161,7 @@ public: QString getDefaultMappingConfig() const override; void update(float deltaTime, const controller::InputCalibrationData& inputCalibrationData) override; void focusOutEvent() override; - bool triggerHapticPulse(float strength, float duration, controller::Hand hand) override; + bool triggerHapticPulse(float strength, float duration, uint16_t index) override; private: void handlePose(float deltaTime, const controller::InputCalibrationData& inputCalibrationData, @@ -516,12 +516,16 @@ void OculusMobileInputDevice::handleRotationForUntrackedHand(const controller::I pose = pose.transform(controllerToAvatar); } -bool OculusMobileInputDevice::triggerHapticPulse(float strength, float duration, controller::Hand hand) { +bool OculusMobileInputDevice::triggerHapticPulse(float strength, float duration, uint16_t index) { + if (index > 2) { + return false; + } + + controller::Hand hand = (controller::Hand)index; + Locker locker(_lock); bool success = true; - qDebug()<<"AAAA: Haptic duration %f " << duration; - if (hand == controller::BOTH || hand == controller::LEFT) { success &= _hands[0].setHapticFeedback(strength, duration); } diff --git a/plugins/hifiSdl2/src/Joystick.cpp b/plugins/hifiSdl2/src/Joystick.cpp index ad0b459544..55a07e0ab9 100644 --- a/plugins/hifiSdl2/src/Joystick.cpp +++ b/plugins/hifiSdl2/src/Joystick.cpp @@ -72,7 +72,7 @@ void Joystick::handleButtonEvent(const SDL_ControllerButtonEvent& event) { } } -bool Joystick::triggerHapticPulse(float strength, float duration, controller::Hand hand) { +bool Joystick::triggerHapticPulse(float strength, float duration, uint16_t index) { if (SDL_HapticRumblePlay(_sdlHaptic, strength, duration) != 0) { return false; } diff --git a/plugins/hifiSdl2/src/Joystick.h b/plugins/hifiSdl2/src/Joystick.h index ae90470974..a839676468 100644 --- a/plugins/hifiSdl2/src/Joystick.h +++ b/plugins/hifiSdl2/src/Joystick.h @@ -39,7 +39,7 @@ public: virtual void update(float deltaTime, const controller::InputCalibrationData& inputCalibrationData) override; virtual void focusOutEvent() override; - bool triggerHapticPulse(float strength, float duration, controller::Hand hand) override; + bool triggerHapticPulse(float strength, float duration, uint16_t index) override; Joystick() : InputDevice("GamePad") {} ~Joystick(); diff --git a/plugins/oculus/src/OculusControllerManager.cpp b/plugins/oculus/src/OculusControllerManager.cpp index c1431fa4b2..4e22b7a236 100644 --- a/plugins/oculus/src/OculusControllerManager.cpp +++ b/plugins/oculus/src/OculusControllerManager.cpp @@ -369,7 +369,13 @@ void OculusControllerManager::TouchDevice::handleRotationForUntrackedHand(const pose = pose.transform(controllerToAvatar); } -bool OculusControllerManager::TouchDevice::triggerHapticPulse(float strength, float duration, controller::Hand hand) { +bool OculusControllerManager::TouchDevice::triggerHapticPulse(float strength, float duration, uint16_t index) { + if (index > 2) { + return false; + } + + controller::Hand hand = (controller::Hand)index; + Locker locker(_lock); bool toReturn = true; ovr::withSession([&](ovrSession session) { diff --git a/plugins/oculus/src/OculusControllerManager.h b/plugins/oculus/src/OculusControllerManager.h index 7d1d176a56..6a3a10f18a 100644 --- a/plugins/oculus/src/OculusControllerManager.h +++ b/plugins/oculus/src/OculusControllerManager.h @@ -76,7 +76,7 @@ private: void update(float deltaTime, const controller::InputCalibrationData& inputCalibrationData) override; void focusOutEvent() override; - bool triggerHapticPulse(float strength, float duration, controller::Hand hand) override; + bool triggerHapticPulse(float strength, float duration, uint16_t index) override; private: void stopHapticPulse(bool leftHand); diff --git a/plugins/openvr/src/ViveControllerManager.cpp b/plugins/openvr/src/ViveControllerManager.cpp index ac41502a38..8a8f18e85f 100644 --- a/plugins/openvr/src/ViveControllerManager.cpp +++ b/plugins/openvr/src/ViveControllerManager.cpp @@ -1561,7 +1561,13 @@ void ViveControllerManager::InputDevice::handlePoseEvent(float deltaTime, const _poseStateMap[isLeftHand ? controller::LEFT_HAND : controller::RIGHT_HAND] = pose.transform(controllerToAvatar); } -bool ViveControllerManager::InputDevice::triggerHapticPulse(float strength, float duration, controller::Hand hand) { +bool ViveControllerManager::InputDevice::triggerHapticPulse(float strength, float duration, uint16_t index) { + if (index > 2) { + return false; + } + + controller::Hand hand = (controller::Hand)index; + Locker locker(_lock); if (hand == controller::BOTH || hand == controller::LEFT) { if (strength == 0.0f) { diff --git a/plugins/openvr/src/ViveControllerManager.h b/plugins/openvr/src/ViveControllerManager.h index 956b2b5eaf..1b8c2a2ec5 100644 --- a/plugins/openvr/src/ViveControllerManager.h +++ b/plugins/openvr/src/ViveControllerManager.h @@ -112,7 +112,7 @@ private: QString getDefaultMappingConfig() const override; void update(float deltaTime, const controller::InputCalibrationData& inputCalibrationData) override; void focusOutEvent() override; - bool triggerHapticPulse(float strength, float duration, controller::Hand hand) override; + bool triggerHapticPulse(float strength, float duration, uint16_t index) override; void hapticsHelper(float deltaTime, bool leftHand); void calibrateOrUncalibrate(const controller::InputCalibrationData& inputCalibration); void calibrate(const controller::InputCalibrationData& inputCalibration);