From ee7193d532aa2eb7c6910a44894fc57bd411a288 Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Wed, 13 Nov 2024 17:02:01 +0100 Subject: [PATCH] bump the SenseGlove Unreal Engine Plugin to a 5.5+ compatible variant of v2.3.0 --- Plugins/SenseGlove/Handbook/GNUmakefile | 2 +- Plugins/SenseGlove/Handbook/README.md | 2 +- Plugins/SenseGlove/Handbook/src/README.md | 2 +- Plugins/SenseGlove/Handbook/src/SUMMARY.md | 7 +- .../src/advanced-topics/openxr/README.md | 30 +- ...llerdata-animated-debug-virtual-hands.gif} | 0 .../consuming-fxrhandtrackingstate/README.md | 216 +++++++++++ .../blueprint.md | 65 ++++ ...state-blueprint-add-draw-hand-function.png | 3 + ...print-add-get-hand-tracking-state-node.png | 3 + ...blueprint-break-xr-hand-tracking-state.png | 3 + ...eprint-debug-virtual-hand-draw-options.png | 3 + ...e-blueprint-draw-debug-gizmo-per-joint.png | 3 + ...rint-draw-hand-function-implementation.png | 3 + ...-blueprint-get-joint-location-rotation.png | 3 + ...trackingstate-blueprint-representation.png | 3 + ...handtrackingstate-blueprint-validation.png | 3 + ...-vrpawn-draw-virtual-hands-every-frame.png | 3 + ...rackingstate-cpp-add-class-choose-name.png | 3 + ...ckingstate-cpp-add-class-choose-parent.png | 3 + ...ing-fxrhandtrackingstate-cpp-new-class.png | 3 + ...dtrackingstate-cpp-reparent-debug-pawn.png | 3 + ...ming-fxrhandtrackingstate-cpp-reparent.png | 3 + ...dtrackingstate-cpp-verify-parent-class.png | 3 + .../consuming-fxrhandtrackingstate/cpp.md | 259 +++++++++++++ ...bling-senseglove-unrealp-engine-plugin.png | 3 + .../README.md | 14 + .../blueprint.md | 16 +- .../consuming-fxrmotioncontrollerdata/cpp.md | 16 +- .../safe-reliable-glove-access-blueprint.png | 0 .../Handbook/src/appendix/changelog.md | 71 ++++ .../src/appendix/directory-structure.md | 2 +- .../planned-features-completion-status.md | 16 +- .../src/appendix/platform-support-matrix.md | 29 +- ...-quest-link-developer-runtime-features.png | 0 .../vive-business-streaming-hand-tracking.png | 0 .../getting-started/installation/README.md | 8 +- .../installation/epic-games-launcher-001.png | 3 - .../installation/epic-games-launcher-002.png | 3 - .../installation/epic-games-launcher-003.png | 3 - .../installation/epic-games-launcher-004.png | 3 - .../installation/epic-games-launcher-005.png | 3 - .../installation/epic-games-launcher-006.png | 3 - .../installation/epic-games-launcher-007.png | 3 - .../installation/epic-games-launcher-008.png | 3 - .../installation/epic-games-launcher-009.png | 3 - .../installation/epic-games-launcher-010.png | 3 - ...epic-games-launcher-fab-eula-agreement.png | 3 + .../epic-games-launcher-fab-install-path.png | 3 + ...epic-games-launcher-fab-install-plugin.png | 3 + ...pic-games-launcher-fab-library-refresh.png | 3 + ...launcher-fab-library-search-senseglove.png | 3 + ...epic-games-launcher-fab-search-results.png | 3 + ...c-games-launcher-fab-search-senseglove.png | 3 + ...love-download-install-progress-details.png | 3 + ...b-senseglove-download-install-progress.png | 3 + ...games-launcher-fab-senseglove-download.png | 3 + ...ames-launcher-fab-senseglove-home-page.png | 3 + .../epic-games-launcher-fab-tab.png | 3 + ...epic-games-launcher-fab-verify-install.png | 3 + ...epic-games-launcher-unreal-engine-home.png | 3 + .../installation/epic-games-launcher.md | 64 +++- ...-repositories-building-missing-modules.png | 0 ...e-visual-studio-project-files-progress.png | 0 ...s-generate-visual-studio-project-files.png | 0 ...re-devops-repositories-missing-modules.png | 0 .../microsoft-azure-devops-repositories.md | 32 +- .../enable-plugin-001.png | 0 .../enable-plugin-002.png | 0 .../verify-version-001.png | 0 .../verify-version-002.png | 0 .../gnu-linux/blueman-confirm-pairing.png | 0 .../sensecom/gnu-linux/blueman-paired.png | 0 .../gnu-linux/blueman-search-button.png | 0 .../sensecom/gnu-linux/blueman-searching.png | 0 ...man-verify-bluetooth-controller-status.png | 0 .../sensecom/gnu-linux/blueman-version.png | 0 ...ccessful-senscom-nova-glove-connection.png | 0 ...t-windows-add-bluetooth-device-connect.png | 0 ...-windows-add-bluetooth-device-discover.png | 0 ...ft-windows-add-bluetooth-device-paired.png | 0 ...microsoft-windows-add-bluetooth-device.png | 0 ...bluetooth-settings-paired-devices-list.png | 0 .../microsoft-windows-bluetooth-settings.png | 0 .../microsoft-windows-run-sensecom.png | 0 ...ccessful-senscom-nova-glove-connection.png | 0 .../sensecom/sensecom-github-download.png | 0 .../adding-sggrabcomponent.png | 0 .../collision-generate-hit-overlap-events.png | 0 .../collision-presets-block-all.png | 0 .../release-max-velocity-samples.png | 0 .../sggrabcomponent-settings.png | 0 .../add-blueprint-class.png | 0 .../pick-parent-class-sggameinstance.png | 0 .../pick-parent-class-sggamemodebase.png | 0 .../pick-parent-class-sggameusersettings.png | 0 .../pick-parent-class-sgpawn.png | 0 .../pick-parent-class-sgplayercontroller.png | 0 .../pick-parent-class.png | 0 .../rename-new-blueprint.png | 0 .../renamed-new-blueprint-sggameinstance.png | 0 .../renamed-new-blueprint-sggamemodebase.png | 0 ...named-new-blueprint-sggameusersettings.png | 0 .../renamed-new-blueprint-sgpawn.png | 0 ...named-new-blueprint-sgplayercontroller.png | 0 .../set-default-class-bpsggameinstance.png | 0 .../set-default-class-bpsggamemode.png | 0 ...set-default-class-bpsggameusersettings.png | 0 .../set-default-class-bpsgpawn.png | 0 ...set-default-class-bpsgplayercontroller.png | 0 .../set-default-class-sggameinstance.png | 0 .../set-default-class-sggamemodebase.png | 0 .../set-default-class-sggameusersettings.png | 0 .../set-default-class-sgpawn.png | 0 .../set-default-class-sgplayercontroller.png | 0 .../sgpawn-components.png | 0 .../sgpawn-filtered-details-panel.png | 0 .../adding-sgtouchcomponent.png | 0 .../collision-generate-hit-overlap-events.png | 0 .../collision-presets-block-all.png | 0 .../sgtouchcomponent-settings.png | 0 ...export-virtual-hand-meshes-bulk-export.png | 0 ...l-hand-meshes-content-browser-location.png | 0 .../export-virtual-hand-meshes-exported.png | 0 ...virtual-hand-meshes-fbx-export-options.png | 0 ...ual-hand-meshes-new-vrtemplate-project.png | 0 ...port-virtual-hand-meshes-select-folder.png | 0 ...ing-senseglove-material-left-hand-mesh.png | 0 ...ng-senseglove-material-right-hand-mesh.png | 0 ...irtual-hand-meshes-create-empty-folder.png | 0 ...meshes-delete-default-material-confirm.png | 0 ...al-hand-meshes-delete-default-material.png | 0 ...rt-virtual-hand-meshes-fbx-import-logs.png | 0 ...virtual-hand-meshes-fbx-import-options.png | 0 ...rtual-hand-meshes-fbx-save-all-confirm.png | 0 ...mport-virtual-hand-meshes-fbx-save-all.png | 0 .../import-virtual-hand-meshes-imported.png | 0 ...t-virtual-hand-meshes-select-fbx-files.png | 0 ...rigid-body-setup-adjusted-physics-body.png | 0 ...igid-body-setup-adjusting-physics-body.png | 0 ...d-body-setup-generate-box-physics-body.png | 0 .../rigid-body-setup-phat-editor.png | 0 ...ockets-editor-add-sockets-confirmation.png | 0 ...e-sockets-editor-add-sockets-failure-1.png | 0 ...e-sockets-editor-add-sockets-failure-2.png | 0 ...ove-sockets-editor-add-sockets-success.png | 0 ...enseglove-sockets-editor-added-sockets.png | 0 ...kets-editor-clear-sockets-confirmation.png | 0 ...e-sockets-editor-clear-sockets-success.png | 0 ...love-sockets-editor-failure-output-log.png | 0 ...lure-output-logs-socket-already-exists.png | 0 ...itor-from-content-browser-bulk-actions.png | 0 ...ve-sockets-editor-from-content-browser.png | 0 ...eleton-skeletal-mesh-editor-asset-menu.png | 0 ...-skeleton-skeletal-mesh-editor-toolbar.png | 0 ...seglove-sockets-editor-sockets-cleared.png | 0 ...eprint-function-get-game-user-settings.png | 0 ...raphics-preferences-refresh-rate-120hz.png | 0 ...nced-graphics-preferences-refresh-rate.png | 0 ...k-device-advanced-graphics-preferences.png | 0 .../meta-quest-link-device-selected.png | 0 .../meta-quest-link-devices.png | 0 .../project-rendering-settings-culling.png | 0 ...ct-rendering-settings-default-settings.png | 0 ...ct-rendering-settings-forward-renderer.png | 0 .../project-rendering-settings-framerate.png | 0 .../project-rendering-settings-mobile.png | 0 ...project-rendering-settings-reflections.png | 0 .../project-rendering-settings-textures.png | 0 ...ct-rendering-settings-virtual-textures.png | 0 .../project-rendering-settings-vr.png | 0 ...engine-scalability-settings-umg-widget.png | 0 ...awn-bind-engine-scalability-settings-1.png | 0 ...awn-bind-engine-scalability-settings-2.png | 0 ...eal-editor-engine-scalability-settings.png | 0 .../Handbook/src/overview/README.md | 7 +- ...t-tracking-settings-supported-hardware.png | 0 Plugins/SenseGlove/Packager/sgum-packager | 0 Plugins/SenseGlove/Packager/sgum-packager.exe | 0 Plugins/SenseGlove/Packager/sgum-packager.yml | 3 + Plugins/SenseGlove/README.md | 2 +- Plugins/SenseGlove/SenseGlove.uplugin | 6 +- .../SGVirtualHandAnimInstanceProxy.cpp | 36 +- .../Components/SGVirtualHandComponent.cpp | 82 +++- .../Components/SGWristTrackerComponent.cpp | 43 +++ .../SenseGlove/Private/SenseGloveModule.h | 2 - .../SGVirtualHandAnimInstanceProxy.h | 13 + .../Components/SGVirtualHandComponent.h | 16 + .../Components/SGWristTrackerComponent.h | 11 + .../SGAndroid/SGAndroidPermissions.cpp | 190 ++++++++++ .../Private/SenseGloveAndroidModule.cpp | 37 +- .../Private/SenseGloveAndroidModule.h | 7 + .../Public/SGAndroid/SGAndroidPermissions.h | 82 ++++ .../SenseGloveAndroid.Build.cs | 1 + .../SenseGloveAndroid_UPL.xml | 4 +- .../Public/SGBackend/SGBackend.h | 4 +- .../Private/SGDebug/SGDebugVirtualHand.cpp | 34 +- .../Public/SGDebug/SGDebugVirtualHand.h | 9 + .../SGDebugVirtualHandKismetLibrary.cpp | 17 +- .../SGDebugVirtualHandKismetLibrary.h | 15 +- .../SGVirtualHandComponentKismetLibrary.cpp | 16 + .../SGWristTrackerComponentKismetLibrary.cpp | 19 + .../SGVirtualHandComponentKismetLibrary.h | 10 + .../SGWristTrackerComponentKismetLibrary.h | 10 + .../SGSettings/SGGloveTrackingSettings.h | 2 +- .../Private/SGTracking/SGGloveTracker.cpp | 13 +- .../Private/SGTracking/SGXRHandState.cpp | 5 +- .../Private/SGTracking/SGXRTracker.cpp | 358 ++++++++++++++++-- .../Public/SGTracking/SGXRHandState.h | 8 +- .../Public/SGTracking/SGXRTracker.h | 26 +- .../SGXRTrackerKismetLibrary.cpp | 19 + .../SGXRTrackerKismetLibrary.h | 22 +- .../Private/SGUtils/SGEngineUtils.cpp | 1 + .../interprocess/smart_ptr/intrusive_ptr.hpp | 0 214 files changed, 1933 insertions(+), 171 deletions(-) rename Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/{consuming-fxrmotioncontrollerdata/consuming-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif => consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif} (100%) create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/README.md create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/blueprint.md create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-draw-hand-function.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-get-hand-tracking-state-node.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-break-xr-hand-tracking-state.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-debug-virtual-hand-draw-options.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-debug-gizmo-per-joint.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-hand-function-implementation.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-get-joint-location-rotation.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-representation.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-validation.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-vrpawn-draw-virtual-hands-every-frame.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-name.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-parent.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-new-class.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent-debug-pawn.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-verify-parent-class.png create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/cpp.md create mode 100644 Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/enabling-senseglove-unrealp-engine-plugin.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/advanced-topics/safe-glove-access-blueprint/safe-reliable-glove-access-blueprint.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-quest-link-developer-runtime-features.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/vive-business-streaming-hand-tracking.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-001.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-002.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-003.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-004.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-005.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-006.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-007.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-008.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-009.png delete mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-010.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-eula-agreement.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-path.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-plugin.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-refresh.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-search-senseglove.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-results.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-senseglove.png create mode 100755 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress-details.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-home-page.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-tab.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-verify-install.png create mode 100644 Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-unreal-engine-home.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-building-missing-modules.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-generate-visual-studio-project-files-progress.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-generate-visual-studio-project-files.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-missing-modules.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/enable-plugin-001.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/enable-plugin-002.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/verify-version-001.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/verify-version-002.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-confirm-pairing.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-paired.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-search-button.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-searching.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-verify-bluetooth-controller-status.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-version.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/successful-senscom-nova-glove-connection.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-connect.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-discover.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-paired.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-bluetooth-settings-paired-devices-list.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-bluetooth-settings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-run-sensecom.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-successful-senscom-nova-glove-connection.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/sensecom/sensecom-github-download.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/adding-sggrabcomponent.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/collision-generate-hit-overlap-events.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/collision-presets-block-all.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/release-max-velocity-samples.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/sggrabcomponent-settings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/add-blueprint-class.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggameinstance.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggamemodebase.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggameusersettings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sgpawn.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sgplayercontroller.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/rename-new-blueprint.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggameinstance.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggamemodebase.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggameusersettings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sgpawn.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sgplayercontroller.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggameinstance.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggamemode.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggameusersettings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsgpawn.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsgplayercontroller.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggameinstance.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggamemodebase.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggameusersettings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sgpawn.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sgplayercontroller.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/sgpawn-components.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/sgpawn-filtered-details-panel.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/adding-sgtouchcomponent.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/collision-generate-hit-overlap-events.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/collision-presets-block-all.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/sgtouchcomponent-settings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-bulk-export.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-content-browser-location.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-exported.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-fbx-export-options.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-new-vrtemplate-project.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-select-folder.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-assing-senseglove-material-left-hand-mesh.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-assing-senseglove-material-right-hand-mesh.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-create-empty-folder.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-delete-default-material-confirm.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-delete-default-material.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-import-logs.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-import-options.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-save-all-confirm.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-save-all.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-imported.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-select-fbx-files.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-adjusted-physics-body.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-adjusting-physics-body.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-generate-box-physics-body.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-phat-editor.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-confirmation.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-failure-1.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-failure-2.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-success.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-added-sockets.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-clear-sockets-confirmation.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-clear-sockets-success.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-failure-output-log.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-failure-output-logs-socket-already-exists.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-content-browser-bulk-actions.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-content-browser.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-skeleton-skeletal-mesh-editor-asset-menu.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-skeleton-skeletal-mesh-editor-toolbar.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-sockets-cleared.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/blueprint-function-get-game-user-settings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences-refresh-rate-120hz.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences-refresh-rate.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-selected.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-devices.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-culling.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-default-settings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-forward-renderer.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-framerate.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-mobile.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-reflections.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-textures.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-virtual-textures.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-vr.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgbasicdemo-openxr-fps-engine-scalability-settings-umg-widget.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgpawn-bind-engine-scalability-settings-1.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgpawn-bind-engine-scalability-settings-2.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/unreal-editor-engine-scalability-settings.png mode change 100644 => 100755 Plugins/SenseGlove/Handbook/src/plugin-configuration/plugin-settings/tracking/wrist-tracking/wrist-tracking-settings-supported-hardware.png mode change 100644 => 100755 Plugins/SenseGlove/Packager/sgum-packager mode change 100644 => 100755 Plugins/SenseGlove/Packager/sgum-packager.exe create mode 100644 Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SGAndroid/SGAndroidPermissions.cpp create mode 100644 Plugins/SenseGlove/Source/SenseGloveAndroid/Public/SGAndroid/SGAndroidPermissions.h mode change 100644 => 100755 Plugins/SenseGlove/Source/ThirdParty/include/boost/interprocess/smart_ptr/intrusive_ptr.hpp diff --git a/Plugins/SenseGlove/Handbook/GNUmakefile b/Plugins/SenseGlove/Handbook/GNUmakefile index e4bcbee..c8426b6 100644 --- a/Plugins/SenseGlove/Handbook/GNUmakefile +++ b/Plugins/SenseGlove/Handbook/GNUmakefile @@ -63,7 +63,7 @@ SG_HANDBOOK_PACKED_HTML_DIR := $(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAP SG_HANDBOOK_PACKED_HTML_FILE := $(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAPED_NAME).zip SG_HANDBOOK_PACKED_PDF_FILE := $(SG_DOCUMENTATION_PACK_DIR)/$(SG_HANDBOOK_ESCAPED_NAME).pdf -SG_BROWSER_BINARY_PATH_LINUX := $(shell which brave-bin 2>/dev/null) +SG_BROWSER_BINARY_PATH_LINUX := /opt/brave.com/brave/brave SG_BROWSER_BINARY_PATH_WINDOWS := C:\Program Files\BraveSoftware\Brave-Browser\Application\brave.exe SG_RSYNC_BIN_PATH_WINDOWS := C:\Program Files\cwrsync\bin diff --git a/Plugins/SenseGlove/Handbook/README.md b/Plugins/SenseGlove/Handbook/README.md index ac2eb38..83c79cf 100644 --- a/Plugins/SenseGlove/Handbook/README.md +++ b/Plugins/SenseGlove/Handbook/README.md @@ -88,4 +88,4 @@ SG_RSYNC_SSH_BINARY_PATH_WINDOWS := $(SG_RSYNC_BIN_PATH_WINDOWS)\ssh.exe ### make pack -This target is meant to be used by the `sgum-packager` utility located in the [Packager](../Packager) folder in order to deploy the documentation in various formats along with the plugin to the Unreal Engine Marketplace. \ No newline at end of file +This target is meant to be used by the `sgum-packager` utility located in the [Packager](../Packager) folder in order to deploy the documentation in various formats along with the plugin to [Fab](https://www.fab.com/). diff --git a/Plugins/SenseGlove/Handbook/src/README.md b/Plugins/SenseGlove/Handbook/src/README.md index 3fc4dda..dcb69dc 100644 --- a/Plugins/SenseGlove/Handbook/src/README.md +++ b/Plugins/SenseGlove/Handbook/src/README.md @@ -7,4 +7,4 @@ This handbook is an ongoing effort and a work in progress to document the SenseG Due to superior formatting and frequent updates, we recommend [the online version of the handbook]({{ #sg-handbook-revision-url }}); nonetheless, it's available in [PDF format]({{ #sg-handbook-pdf-url }}) as well. > [!TIP] -> Feel free to check out [the SenseGlove Unreal Engine Plugin landing page on the UE Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin) as well. +> Feel free to check out [the SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099) as well. diff --git a/Plugins/SenseGlove/Handbook/src/SUMMARY.md b/Plugins/SenseGlove/Handbook/src/SUMMARY.md index ad6442a..55801c6 100644 --- a/Plugins/SenseGlove/Handbook/src/SUMMARY.md +++ b/Plugins/SenseGlove/Handbook/src/SUMMARY.md @@ -11,8 +11,8 @@ Welcom to the SenseGlove Unreal Engine Handbook! # 🚀 Getting Started - [Installation](getting-started/installation/README.md) - - [Through the Epic Games Launcher](getting-started/installation/epic-games-launcher.md) - - [Through Microsoft Azure DevOps Repositories](getting-started/installation/microsoft-azure-devops-repositories.md) + - [Via the Epic Games Launcher](getting-started/installation/epic-games-launcher.md) + - [Via Microsoft Azure DevOps Repositories](getting-started/installation/microsoft-azure-devops-repositories.md) - [Enabling and Verifying the Plugin Version](getting-started/plugin-verify-version-enable/README.md) - [SenseCom](getting-started/sensecom/README.md) - [SenseCom on GNU/Linux](getting-started/sensecom/gnu-linux/README.md) @@ -63,6 +63,9 @@ Welcom to the SenseGlove Unreal Engine Handbook! - [Safe Glove Access in Blueprint](advanced-topics/safe-glove-access-blueprint/README.md) - [OpenXR](advanced-topics/openxr/README.md) + - [Consuming FXRHandTrackingState](advanced-topics/openxr/consuming-fxrhandtrackingstate/README.md) + - [Blueprint](advanced-topics/openxr/consuming-fxrhandtrackingstate/blueprint.md) + - [C++](advanced-topics/openxr/consuming-fxrhandtrackingstate/cpp.md) - [Consuming FXRMotionControllerData](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md) - [Blueprint](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md) - [C++](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md) diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/README.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/README.md index c8b2252..101a7c9 100644 --- a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/README.md +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/README.md @@ -4,6 +4,32 @@ The SenseGlove Unreal Engine Plugin has provided OpenXR-compatible hand tracking Typically a user does not need to know anything about OpenXR to use the plugin, so this section of the handbook is for advanced users who are looking for a way to directly consume the OpenXR data coming directly from either a SenseGlove device or if enabled in the plugin settings from hand-tracking. -Since the SenseGlove Unreal Engine Plugin registers itself as an `OpenXRHandTracking` motion controller device it becomes a hand-tracking provider for Unreal Engine, thus the OpenXR data from SenseGlove could always be retrieved from the Unreal Engine's `IXTrackingSystem` with one caveat. The caveat is if another OpenXR-compatible hand-tracking plugin, e.g. Epic's own OpenXRHandTracking, is enabled simultaneously it's not guaranteed that the `FXRMotionControllerData` retrieved from the `IXTrackingSystem::GetMotionControllerData()` method is coming from SenseGlove, as this method returns the first hand-tracking plugin it could find. Thus, SenseGlove provides its own implementation of `GetMotionControllerData()` which guarantees the retrieved `FXRMotionControllerData` is coming from the SenseGlove Unreal Engine Plugin; and this is the preferred way to that. +Since the SenseGlove Unreal Engine Plugin registers itself as an `OpenXRHandTracking` motion controller device it becomes a hand-tracking provider for Unreal Engine, thus the OpenXR data from SenseGlove could always be retrieved from the Unreal Engine's `IXTrackingSystem` with one caveat. The caveat is if another OpenXR-compatible hand-tracking plugin, e.g. Epic's own OpenXRHandTracking, is enabled simultaneously it's not guaranteed that the `FXRMotionControllerData` and `FXRHandTrackingState` structs retrieved from the `IXTrackingSystem::GetMotionControllerData()` and `IXTrackingSystem::GetHandTrackingState()` methods are coming from SenseGlove, as these methods return the first hand-tracking plugin they could find. Thus, SenseGlove provides its own implementation of `GetMotionControllerData()` and `GetHandTrackingState()` which guarantee the retrieved `FXRMotionControllerData` or `FXRHandTrackingState` are coming from the SenseGlove Unreal Engine Plugin; and this is the preferred way to that. -In the next sections we'll see [how we can directly consume the `FXRMotionControllerData`](consuming-fxrmotioncontrollerdata/) to draw and animate debug virtual hands in both [Blueprint](consuming-fxrmotioncontrollerdata/blueprint.md) and [C++](consuming-fxrmotioncontrollerdata/cpp.md). +> [!NOTE] +> In order to retrieve the latest `FXRMotionControllerState` available, The +> SenseGlove Unreal Engine Plugin provides an alternative implementation for +> `IXTrackingSystem::GetMotionControllerState()` as well . However, since this +> method does not rely on the `OpenXRHandTracking` provider, it may become +> redundant. As a result, we might consider removing this functionality in +> future updates in favor of the one that Unreal Engine provides. + +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + +In the next sections we'll see: + +- [How we can directly consume the `FXRMotionControllerData`](consuming-fxrmotioncontrollerdata/) on UE `5.2`, `5.3`, `5.4`, and `5.5` to draw and animate debug virtual hands in both [Blueprint](consuming-fxrmotioncontrollerdata/blueprint.md) and [C++](consuming-fxrmotioncontrollerdata/cpp.md). + +- [How we can directly consume the `FXRHandTrackingState`](consuming-fxrhandtrackingstate/) on UE `5.5` to draw and animate debug virtual hands in both [Blueprint](consuming-fxrhandtrackingstate/blueprint.md) and [C++](consuming-fxrhandtrackingstate/cpp.md). diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/consuming-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif similarity index 100% rename from Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/consuming-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif rename to Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/README.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/README.md new file mode 100644 index 0000000..273e3c7 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/README.md @@ -0,0 +1,216 @@ +# Consuming FXRHandTrackingState + +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand-tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + +Taking a closer look at the `FXRHandTrackingState` declaration inside the Unreal Engine's `HeadMountedDisplay` module at `[Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayTypes.h](https://github.com/EpicGames/UnrealEngine/blob/release/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayTypes.h)`, figuring out the data structure might not seem very straightforward: + +```cpp +USTRUCT(BlueprintType) +struct FXRHandTrackingState +{ + GENERATED_USTRUCT_BODY(); + + // The state is valid if poses have ever been provided. + UPROPERTY(BlueprintReadOnly, Category = "XR") + bool bValid = false; + UPROPERTY(BlueprintReadOnly, Category = "XR") + FName DeviceName; + UPROPERTY(BlueprintReadOnly, Category = "XR") + FGuid ApplicationInstanceID; + + UPROPERTY(BlueprintReadOnly, Category = "XR") + EXRSpaceType XRSpaceType = EXRSpaceType::UnrealWorldSpace; + + UPROPERTY(BlueprintReadOnly, Category = "XR") + EControllerHand Hand = EControllerHand::Left; + + UPROPERTY(BlueprintReadOnly, Category = "XR") + ETrackingStatus TrackingStatus = ETrackingStatus::NotTracked; + + // The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc). + UPROPERTY(BlueprintReadOnly, Category = "XR") + TArray HandKeyLocations; + + // The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc). + UPROPERTY(BlueprintReadOnly, Category = "XR") + TArray HandKeyRotations; + + // The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc). + UPROPERTY(BlueprintReadOnly, Category = "XR") + TArray HandKeyRadii; +}; +``` + +Which on the Blueprint side it looks like this: + +![FXRHandTrackingState Blueprint representation](consuming-fxrhandtrackingstate-blueprint-representation.png "FXRHandTrackingState Blueprint representation") + +But, fear not, we've got you covered! + +## FXRHandTrackingState in Unreal Engine + +`FXRHandTrackingState` is a structure in Unreal Engine designed to hold detailed information about the state of a hand-tracking device at a given moment. This structure is essential for handling hand-tracking inputs in virtual reality (VR) applications, providing the necessary data to accurately track and represent the user's hand movements and actions within the virtual environment. + +### Structure Members of FXRHandTrackingState + +- **bValid** + - **Description**: A boolean flag indicating whether the data is valid or not. + - **Usage**: This is used to check if the motion controller data is correctly initialized and can be used for further processing. + +- **DeviceName** + - **Type**: `FName` + - **Description**: The name of the device. + - **Usage**: Identifies which device the data is coming from, useful when multiple devices are in use. + +- **ApplicationInstanceID** + - **Type**: `FString` + - **Description**: A unique identifier for the application instance. + - **Usage**: Helps in differentiating data from different instances of an application, ensuring the correct instance processes the data. + +- **XRSpaceType** + - **Type**: `EXRSpaceType` + - **Description**: Enum specifying the type of XR space being used (e.g., unreal world or tracking space). + - **Usage**: Specifies the coordinate system the XR Device is tracking itself in. + +- **Hand** + - **Type**: `EControllerHand` + - **Description**: Enum indicating which hand is being tracked (left or right). + - **Usage**: Helps identify whether the hand-tracking data pertains to the left or right hand, essential for hand-specific actions or interactions. + +- **TrackingStatus** + - **Type**: `EXRTrackingStatus` + - **Description**: Enum indicating the tracking status of the hand-tracking device. + - **Usage**: Shows whether the hand-tracking device is being tracked accurately, with possible statuses like `Tracked`, `NotTracked`, etc. + +- **HandKeyLocations** + - **Type**: `TArray` + - **Description**: An array of vectors representing key locations of the hand. + - **Usage**: Provides detailed locations of key points on the hand, useful for precise hand-tracking and interaction. + +- **HandKeyRotations** + - **Type**: `TArray` + - **Description**: An array of quaternions representing key rotations of the hand. + - **Usage**: Complements the hand key locations with rotational data, ensuring accurate representation of hand movements. + +- **HandKeyRadii** + - **Type**: `TArray` + - **Description**: An array of floats representing the radii of key points of the hand. + - **Usage**: Gives the size of the hand key points, aiding in collision detection and interaction fidelity. + +### Organization of FXRHandTrackingState + +The structure is organized to encapsulate all relevant data needed for hand-tracking in a coherent and accessible manner. Boolean flag `bValid` provides quick checks on the state of the controller data. Identifiers `DeviceName` and `ApplicationInstanceID` ensure the correct association of data. Arrays `HandKeyLocations`, `HandKeyRotations`, and `HandKeyRadii` allow detailed hand-tracking, which is critical for immersive VR experiences. Lastly, the tracking status `TrackingStatus` informs the system of the reliability of the data being processed and whether the hands are actively being tracked or they are inactive at the moment. + +### Processing the Data for Drawing and Animating a Virtual Hand + +In order to draw and animate a virtual hand in real-time whether the data is coming from hand-tracking or a SenseGlove device, we could consume the data from the `HandKeyLocations` and `HandKeyRotations` fields of the `FXRHandTrackingState` struct. + +Both `HandKeyLocations` and `HandKeyRotations` contain 26 elements as defined by OpenXR's [`XR_HAND_JOINT_COUNT_EXT`](https://registry.khronos.org/OpenXR/specs/1.1/man/html/XR_HAND_JOINT_COUNT_EXT.html) and [`XrHandJointLocationsEXT`](https://registry.khronos.org/OpenXR/specs/1.0/man/html/XrHandJointLocationsEXT.html), etc. + +Unreal Engine also provides an enum called `EHandKeypoint` naming the 26 joints, and the equivalent of `XR_HAND_JOINT_COUNT_EXT` as `EHandKeypointCount` inside `[Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayTypes.h](https://github.com/EpicGames/UnrealEngine/blob/release/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayTypes.h)` as follows: + +```cpp +/** + * Transforms that are tracked on the hand. + * Matches the enums from WMR to make it a direct mapping + */ +UENUM(BlueprintType) +enum class EHandKeypoint : uint8 +{ + Palm, + Wrist, + ThumbMetacarpal, + ThumbProximal, + ThumbDistal, + ThumbTip, + IndexMetacarpal, + IndexProximal, + IndexIntermediate, + IndexDistal, + IndexTip, + MiddleMetacarpal, + MiddleProximal, + MiddleIntermediate, + MiddleDistal, + MiddleTip, + RingMetacarpal, + RingProximal, + RingIntermediate, + RingDistal, + RingTip, + LittleMetacarpal, + LittleProximal, + LittleIntermediate, + LittleDistal, + LittleTip +}; + +const int32 EHandKeypointCount = static_cast(EHandKeypoint::LittleTip) + 1; + +``` + +So, getting the any joint's location or rotation is as easy as casting the enum value and passing it as the array index. + +```cpp + FXRHandTrackingState HandTrackingState; + const bool bGotHandTrackingState = FSGXRTracker::GetHandTrackingState( + GetWorld(), EXRSpaceType::UnrealWorldSpace, EControllerHand::Left, HandTrackingState); + + // Return if the struct data is invalid! + if (!bGotHandTrackingState || !HandTrackingState.bValid) + { + return; + } + + // Return if the device is not being tracked! + if (HandTrackingState.TrackingStatus == ETrackingStatus::NotTracked) + { + return; + } + + // Ensure that HandTrackingState.HandKeyLocations has the location data + // for 26 joints! + if (!ensureAlwaysMsgf(HandTrackingState.HandKeyLocations.Num() + == EHandKeypointCount, + TEXT("Invalid HandKeyLocations count!"))) + { + return; + } + + // Ensure that HandTrackingState.HandKeyRotations has the rotation data + // for 26 joints! + if (!ensureAlwaysMsgf(HandTrackingState.HandKeyRotations.Num() + == EHandKeypointCount, + TEXT("Invalid HandKeyRotations count!"))) + { + return; + } + + static constexpr int32 PalmIndex = static_cast(EHandKeypoint::Palm); + + const FVector& PalmLocation{ + HandTrackingState.HandKeyLocations[PalmIndex] + }; + const FRotator& PalmRotation{ + HandTrackingState.HandKeyRotations[PalmIndex].Rotator() + }; + +``` + +The equivalent Blueprint code for the above looks something like this: + +![Get a joint location and rotation from FXRHandTrackingState in Blueprint](consuming-fxrhandtrackingstate-blueprint-get-joint-location-rotation.png "Get a joint location and rotation from FXRHandTrackingState in Blueprint") + +OK, now that we've got a glimpse of how the virtual hand's joint data could be processed we are going to draw and animate a virtual hand in both [Blueprint](blueprint.md) and [C++](cpp.md) in the upcoming sections. diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/blueprint.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/blueprint.md new file mode 100644 index 0000000..6bde930 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/blueprint.md @@ -0,0 +1,65 @@ +# Consuming FXRHandTrackingState in Blueprint + +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + +Before continuing this section, please ensure you've studied the [Consuming FXRHandTrackingState](./) section, first. + +## Drawing and Animating Virtual Hands + +1. Create a new Virtual Reality project based [the Unreal VR Template](https://dev.epicgames.com/documentation/en-us/unreal-engine/vr-template-in-unreal-engine). + +2. Make sure the [SenseGlove UnrealEngine plugin is installed and enabled](/getting-started/installation.md) inside your new project. + +![Enabling the SenseGlove Unreal Engine Plugin](enabling-senseglove-unrealp-engine-plugin.png "Enabling the SenseGlove Unreal Engine Plugin") + +3. You could use either hand-tracking or a SenseGlove device as the input data, or both of the inside the same project. Whether you would like to use hand-tracking or a SenseGlove device, please make sure the required steps are taken for each of those first. + +4. You could add the required Blueprint code for drawing virtual hands to either your Level Buleprint or the VRPawn Blueprint Class located at `/Content/VRTemplate/Blueprints/VRPawn`. In this guide we are going to add the code to our VRPawn. + +5. Add a new function named `Draw Hand` with an input parameter of type `EController Hand` named `Hand`. + +![Adding the Blueprint Draw Hand function](consuming-fxrhandtrackingstate-blueprint-add-draw-hand-function.png "Adding the Blueprint Draw Hand function") + +6. Inside this function's event graph add a `Get Hand Tracking State` node from `SenseGlove > Tracking > XR Tracker > Get Hand Tracking State`. + +![Adding the Get Hand Tracking State node](consuming-fxrhandtrackingstate-blueprint-add-get-hand-tracking-state-node.png "Adding the Get Hand Tracking State node") + +7. Then connect the functions `Hand` input parameter to the `Get Hand Tracking State`'s `Hand` input and right-click on the `OutHandTrackingState` parameter and use the `Break XRHandTrackingState` node to break the struct to it's fields. + +![Breaking the XR Hand Tracking State Data node](consuming-fxrhandtrackingstate-blueprint-break-xr-hand-tracking-state.png "Breaking the XR Hand Tracking State node") + +8. After this, we need to perform data validation by checking the return status of the `Get Hand Tracking State` function and `FXRHandTrackingState`'s `Valid` field. Then, we check if the hand-tracking device is being tracked and indeed coming from a hand-tracking source. And, finally, we check whether we have the positions and rotations for exactly `26` joints or not. + +![FXRHandTrackingState validation](consuming-fxrhandtrackingstate-blueprint-validation.png "FXRHandTrackingState validation") + +9. OK, now it's time to draw the joints! If we check out the SenseGlove Debug module's draw option, we notice there are various ways to draw the debug virtual hand. Drawing a cube or a gizmo per joint, or draw the whole hand all at once by passing the retrieved `FXRHandTrackingState` to the `DebugVirtualHand::Draw` function! But, since the point of this tutorial is to learn how to consume the `FXRHandTrackingState` we ignore the last option. Between the debug cubes or gizmos, we are going to choose the gizmos since they better represent the rotations than the cubes. + +![Some options for drawing a debug virtual hand](consuming-fxrhandtrackingstate-blueprint-debug-virtual-hand-draw-options.png "Some options for drawing a debug virtual hand") + +10. In the last step inside the `Draw Hand` function, in order to draw a virtual hand with `26` joints, we have to first iterate through either of the `Hand Key Positions` or `Hand Key Rotations` arrays from the `FXRHandTrackingState` struct. Since we made sure both arrays have `26` elements before we reached this step, it's safe to just iterate over one and use the `Array Index` inside a `For Each Loop` or a `For Loop` to access the position and rotation of every joint. Then we use each array `Get (a ref)` method to access the position and rotation data inside the loop and call the `Draw` function from `SenseGlove > Debug > Gizmo` per every joint. Please note that there are two `Draw` functions and the only difference between the two is that one accepts an `FQuat` and the other a `FRotator` for its `Rotation` input parameter. In this case, we use the `FQuat` variant to avoid an extra conversion to `FRotator`. Also, please adjust the `Thickness` option for the `Settings` parameter from `1.0` to `0.2`, as the default value might be too thick for drawing a joint gizmo. + +![Drawing a debug gizmo per each hand's joint](consuming-fxrhandtrackingstate-blueprint-draw-debug-gizmo-per-joint.png "Drawing a debug gizmo per each hand's joint") + +11. Well, now the full implementation for the `Draw Hand` function insde the `VRPawn` should look something like this: + +![VRPawn Draw Hand function final implementation](consuming-fxrhandtrackingstate-blueprint-draw-hand-function-implementation.png "VRPawn Draw Hand function final implementation") + +12. Finally, go back to `VRPawn`'s event graph and the following code to the `Tick` event. Basically what we do here is call our newly implemented `Draw Hand` twice, once for each hand. + +![Attempt to draw the left and right virtual hands every frame from the VR Pawn Tick event](consuming-fxrhandtrackingstate-blueprint-vrpawn-draw-virtual-hands-every-frame.png "Attempt to draw the left and right virtual hands every frame from the VR Pawn Tick event") + +13. Now, go back to the `VRTemplateMap` and use the VR Preview button to run the game. If everything's done correctly, you should be able to see the virtual hands inside your VR simulation. + +![FXRHandTrackingState animated debug virtual hands](../consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif "FXRHandTrackingState animated debug virtual hands") diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-draw-hand-function.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-draw-hand-function.png new file mode 100644 index 0000000..3c886ae --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-draw-hand-function.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3d8703b8bc80da4320bece6800694e3e23184415b205590ae598eec2af65d22 +size 331543 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-get-hand-tracking-state-node.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-get-hand-tracking-state-node.png new file mode 100644 index 0000000..a713b0b --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-add-get-hand-tracking-state-node.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7dea108a40080de71ca1af0d3cbf25c892f744ec94a4167b9d7436c684ce1fe +size 87394 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-break-xr-hand-tracking-state.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-break-xr-hand-tracking-state.png new file mode 100644 index 0000000..b6b1d19 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-break-xr-hand-tracking-state.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:597dcdf9c8baa5b331e7378847aa4d625f140b1ebcdf9fe860068c050f6dc2ea +size 198486 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-debug-virtual-hand-draw-options.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-debug-virtual-hand-draw-options.png new file mode 100644 index 0000000..db0bacf --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-debug-virtual-hand-draw-options.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7484ed8060e91a3df04091399b1e44f51bd0b8a931c842c35c56c43be0743872 +size 57419 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-debug-gizmo-per-joint.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-debug-gizmo-per-joint.png new file mode 100644 index 0000000..cd3a2be --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-debug-gizmo-per-joint.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f713fc3bd5eeadef302809383e4c5abe2d312c4b101cd69c1e8e5be7d792b7e +size 414843 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-hand-function-implementation.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-hand-function-implementation.png new file mode 100644 index 0000000..6ea08a0 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-draw-hand-function-implementation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9fa5274021ca44b9be43647b13a05960d08a8e5bb5bac7823f9be3cc4a3e9349 +size 486100 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-get-joint-location-rotation.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-get-joint-location-rotation.png new file mode 100644 index 0000000..b3578ff --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-get-joint-location-rotation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da16ef65e33735973e1bd739726b278dd13adb38010155d92aaa8c0419a98029 +size 467890 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-representation.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-representation.png new file mode 100644 index 0000000..6efc930 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-representation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a3864356d94c35539638dc5c76620526fb8154af1d598a49491771488aa12f4 +size 47932 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-validation.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-validation.png new file mode 100644 index 0000000..cebe39a --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-validation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a7348e16e157b6819487eb669efadf44e8b531849d5cc1db6024a1b366fb250f +size 354115 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-vrpawn-draw-virtual-hands-every-frame.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-vrpawn-draw-virtual-hands-every-frame.png new file mode 100644 index 0000000..856f121 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-blueprint-vrpawn-draw-virtual-hands-every-frame.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5abcc48443d71288701c6a3137881e969f269e35e54f9ca3b2e9bcded090afbe +size 259642 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-name.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-name.png new file mode 100644 index 0000000..15cab89 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-name.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2cde517c4eb6ba807f24b7f3b861c62b69501ac4ea94b9e6d1d112af860619ab +size 35036 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-parent.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-parent.png new file mode 100644 index 0000000..eb02fdd --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-add-class-choose-parent.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48f0228ee4da1dee629e65f71fefcbe00ab5a52afa8685a3549fc9a4b0143534 +size 38449 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-new-class.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-new-class.png new file mode 100644 index 0000000..8c2e223 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-new-class.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f5c77bab4ac3926bc4292203a1c5684928eb7915e9278739e0f532b9e3b04a1 +size 145613 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent-debug-pawn.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent-debug-pawn.png new file mode 100644 index 0000000..d04f9b4 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent-debug-pawn.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72e5a568596914ccda9e964387c4bda765707c1bace599f0f89b5aed9cf75df6 +size 8368 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent.png new file mode 100644 index 0000000..a394160 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-reparent.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3bd9b7c5dafd7ff61cb091851f007ae35745201146fe356b3451b704243a92f3 +size 46779 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-verify-parent-class.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-verify-parent-class.png new file mode 100644 index 0000000..d06d9fe --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/consuming-fxrhandtrackingstate-cpp-verify-parent-class.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16686ddeefb5375f4e3ed668ebdb61263bf3b98e8bec428b8edf915f75e467df +size 24869 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/cpp.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/cpp.md new file mode 100644 index 0000000..7a315d0 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/cpp.md @@ -0,0 +1,259 @@ +# Consuming FXRHandTrackingState in C++ + +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + +Before continuing this section, please ensure you've first studied the [Consuming FXRHandTrackingState](./) section. + +## Drawing and Animating Virtual Hands + +1. Create a new Virtual Reality project based [the Unreal VR Template](https://dev.epicgames.com/documentation/en-us/unreal-engine/vr-template-in-unreal-engine). + +2. Make sure the [SenseGlove UnrealEngine plugin is installed and enabled](/getting-started/installation.md) inside your new project. + +![Enabling the SenseGlove Unreal Engine Plugin](enabling-senseglove-unrealp-engine-plugin.png "Enabling the SenseGlove Unreal Engine Plugin") + +3. You could use either hand-tracking or a SenseGlove device as the input data, or both of the inside the same project. Whether you would like to use hand-tracking or a SenseGlove device, please make sure the required steps are taken for each of those first. + +4. From the `Tools` menu choose `New C++ class...`. + +![Creating a new C++ class](consuming-fxrhandtrackingstate-cpp-new-class.png "Creating a new C++ class") + +5. Choose the Unreal Engine's `APawn` class as the parent class for the new C++ pawn class. + +![Choosing APawn as the parent class](consuming-fxrhandtrackingstate-cpp-add-class-choose-name.png "Choosing APawn as the parent class") + +6. Name the new pawn class `DebugPawn`. + +![Naming the new C++ class DebugPawn](consuming-fxrhandtrackingstate-cpp-add-class-choose-parent.png "Naming the new C++ class DebugPawn") + +7. Since we have created a new C++ class, this converts the current Blueprint VRTemplateMap project to a C++ one. That's why the Unreal Editor will give us a few prompts regarding opening the project in the default IDE and rebuilding the code. It might be simpler to just close the editor, then rebuild the source code inside your favorite IDE, and then start the editor with the converted project again. + +8. Find and open the VRPawn Blueprint Class located at `/Content/VRTemplate/Blueprints/VRPawn` inside the Blueprint Editor and from the `File` menu choose the `Reparent Blueprint` class. + +![Reparenting the VRPawn Blueprint class](consuming-fxrhandtrackingstate-cpp-reparent.png "Reparenting the VRPawn Blueprint class") + +9. In the new `Reparent blueprint` window choose `DebugPawn` as the new parent. + +![Reparenting the VRPawn Blueprint class to ADebugPawn](consuming-fxrhandtrackingstate-cpp-reparent-debug-pawn.png "Reparenting the VRPawn Blueprint class to ADebugPawn") + +10. By looking at the `Parent Class` label located under the Blueprint Editor window control buttons verify that the `ADebugPawn` class has been set as the new parent. + +![Veifying whether the VRPawn Blueprint class set to ADebugPawn or not](consuming-fxrhandtrackingstate-cpp-verify-parent-class.png "Veifying whether the VRPawn Blueprint class set to ADebugPawn or not") + +11. Locate the project's main Build file, in our case `VirtualHandCpp/Source/VirtualHandCpp/VirtualHandCpp.Build.cs` and add the `InputDevice`, `OpenXRHMD`, `SenseGloveBuildHacks`, `SenseGloveDebug`, `SenseGloveSettings`, and `SenseGloveTracking` modules as either a private or public dependency. + +```csharp +// Fill out your copyright notice in the Description page of Project Settings. + +using UnrealBuildTool; + +public class VirtualHandCpp : ModuleRules +{ + public VirtualHandCpp(ReadOnlyTargetRules Target) : base(Target) + { + PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs; + + PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore" }); + + PrivateDependencyModuleNames.AddRange(new string[] + { + "InputDevice", + "OpenXRHMD", + "SenseGloveBuildHacks", + "SenseGloveDebug", + "SenseGloveSettings", + "SenseGloveTracking" + }); + + // Uncomment if you are using Slate UI + // PrivateDependencyModuleNames.AddRange(new string[] { "Slate", "SlateCore" }); + + // Uncomment if you are using online features + // PrivateDependencyModuleNames.Add("OnlineSubsystem"); + + // To include OnlineSubsystemSteam, add it to the plugins section in your uproject file with the Enabled attribute set to true + } +} +``` + +12. Locate the C++ header and source file for the `ADebugPawn` inside the project in your C++ IDE. In our case they are located at `VirtualHandCpp/Source/VirtualHandCpp/DebugPawn.h` and `VirtualHandCpp/Source/VirtualHandCpp/DebugPawn.cpp`. + +13. Modify the `DebugPawn.h` header file to look like this: + +```cpp +// Fill out your copyright notice in the Description page of Project Settings. + +#pragma once + +#include "CoreMinimal.h" +#include "GameFramework/Pawn.h" + +#include "SGSettings/SGDebugGizmoSettings.h" + +#include "DebugPawn.generated.h" + +UCLASS() +class VIRTUALHANDCPP_API ADebugPawn : public APawn +{ + GENERATED_BODY() + +private: + // The virtual hand drawing settings. + UPROPERTY(EditDefaultsOnly, Category="DebugPawn", + meta=(AllowPrivateAccess="false")) + FSGDebugGizmoSettings HandDrawingSettings; + +public: + // Sets default values for this pawn's properties + ADebugPawn(); + +protected: + // Called when the game starts or when spawned + virtual void BeginPlay() override; + +public: + // Called every frame + virtual void Tick(float DeltaTime) override; + + // Called to bind functionality to input + virtual void SetupPlayerInputComponent(class UInputComponent* PlayerInputComponent) override; + +private: + // The method responsible for drawing a virtual hand. + void DrawHand(EControllerHand Hand) const; +}; +``` + +14. Modify the `DebugPawn.cpp` implementation file to look like this: + + +```cpp +// Fill out your copyright notice in the Description page of Project Settings. + + +#include "DebugPawn.h" + +#include "SGDebug/SGDebugGizmo.h" +#include "SGTracking/SGXRTracker.h" + +// Sets default values +ADebugPawn::ADebugPawn() +{ + // Set this pawn to call Tick() every frame. You can turn this off to improve performance if you don't need it. + PrimaryActorTick.bCanEverTick = true; + + // Set the default virtual hand drawing settings. + HandDrawingSettings = FSGDebugGizmoSettings{ + 1.0f, + FColor{255, 0, 0, 255}, + FColor{0, 255, 0, 255}, + FColor{0, 0, 255, 255}, + false, + 1.1f, + 0, + 0.2f, + }; +} + +// Called when the game starts or when spawned +void ADebugPawn::BeginPlay() +{ + Super::BeginPlay(); +} + +// Called every frame +void ADebugPawn::Tick(float DeltaTime) +{ + Super::Tick(DeltaTime); + + // Attempt at drawing the left/right virtual hands every frame. + DrawHand(EControllerHand::Left); + DrawHand(EControllerHand::Right); +} + +// Called to bind functionality to input +void ADebugPawn::SetupPlayerInputComponent(UInputComponent* PlayerInputComponent) +{ + Super::SetupPlayerInputComponent(PlayerInputComponent); +} + +void ADebugPawn::DrawHand(const EControllerHand Hand) const +{ + // Get the world and cache it, if it's null we return early. + UWorld* World{GetWorld()}; + if (!IsValid(World)) + { + return; + } + + FXRHandTrackingState HandTrackingState; + const bool bGotHandTrackingState = FSGXRTracker::GetHandTrackingState( + World, EXRSpaceType::UnrealWorldSpace, Hand, HandTrackingState); + + // Return if the struct data is invalid! + if (!bGotHandTrackingState || !HandTrackingState.bValid) + { + return; + } + + // Return if the device is not being tracked! + if (HandTrackingState.TrackingStatus == ETrackingStatus::NotTracked) + { + return; + } + + // Ensure that HandTrackingState.HandKeyLocations has the location data + // for 26 joints! + if (!ensureAlwaysMsgf(HandTrackingState.HandKeyLocations.Num() + == EHandKeypointCount, + TEXT("Invalid HandKeyLocations count!"))) + { + return; + } + + // Ensure that HandTrackingState.HandKeyRotations has the rotation data + // for 26 joints! + if (!ensureAlwaysMsgf(HandTrackingState.HandKeyRotations.Num() + == EHandKeypointCount, + TEXT("Invalid HandKeyRotations count!"))) + { + return; + } + + // Iterate over the hand joint locations and rotations! + for (int32 JointIndex = 0; JointIndex < EHandKeypointCount; ++JointIndex) + { + const FVector& JointLocation{ + HandTrackingState.HandKeyLocations[JointIndex] + }; + const FQuat& JointRotation{ + HandTrackingState.HandKeyRotations[JointIndex] + }; + + // Draw a single joint's gizmo! + // Please note that we could alternatively: + // Use FSGDebugCube::Draw() to draw a cube. + // Or use the FSGDebugVirtualHand::Draw() method and pass the + // HandTrackingState directly to draw the virtual hand + // all at once without iterating the joints. But, that's not + // goal of this tutorial. + FSGDebugGizmo::Draw(World, JointLocation, JointRotation, HandDrawingSettings); + } +} +``` + +15. Now, rebuild the source code and go back to the `VRTemplateMap`, then use the VR Preview button to run the game. If everything's done correctly, you should be able to see the virtual hands inside your VR simulation. + +![FXRHandTrackingState animated debug virtual hands](../consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif "FXRHandTrackingState animated debug virtual hands") diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/enabling-senseglove-unrealp-engine-plugin.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/enabling-senseglove-unrealp-engine-plugin.png new file mode 100644 index 0000000..8bc7134 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrhandtrackingstate/enabling-senseglove-unrealp-engine-plugin.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4bc8ff35df13ef30212e5cd69c23556f429041bb141bce64cbce9366c27f8071 +size 48777 diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md index 1cba97f..05f738a 100644 --- a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md @@ -1,5 +1,19 @@ # Consuming FXRMotionControllerData +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + Taking a closer look at the `FXRMotionControllerData` declaration inside the Unreal Engine's `HeadMountedDisplay` module at `[Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayTypes.h](https://github.com/EpicGames/UnrealEngine/blob/release/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayTypes.h)`, figuring out the data structure might not seem very straightforward: ```cpp diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md index 4f9bfc9..e677d6c 100644 --- a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md @@ -1,5 +1,19 @@ # Consuming FXRMotionControllerData in Blueprint +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + Before continuing this section, please ensure you've studied the [Consuming FXRMotionControllerData](./) section, first. ## Drawing and Animating Virtual Hands @@ -48,4 +62,4 @@ Before continuing this section, please ensure you've studied the [Consuming FXRM 13. Now, go back to the `VRTemplateMap` and use the VR Preview button to run the game. If everything's done correctly, you should be able to see the virtual hands inside your VR simulation. -![FXRMotionControllerData animated debug virtual hands](consuming-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif "FXRMotionControllerData animated debug virtual hands") +![FXRMotionControllerData animated debug virtual hands](../consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif "FXRMotionControllerData animated debug virtual hands") diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md index b1d05a0..140105b 100644 --- a/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md +++ b/Plugins/SenseGlove/Handbook/src/advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md @@ -1,5 +1,19 @@ # Consuming FXRMotionControllerData in C++ +> [!IMPORTANT] +> Unreal Engine versions `5.2`, `5.3`, and `5.4` are limited to +> `FXRMotionControllerData` since at the time of their release no +> `FXRHandTrackingState` was available. +> Also please keep in mind that, while `FXRMotionControllerData` is pretty much +> usable and functional in Unreal Engine `5.5`, it is recommended to utilize +> `FXRHandTrackingState` instead. This is because this version of UE has +> deprecated `FXRMotionControllerData` in favor of the +> `FXRMotionControllerState` and `FXRHandTrackingState` structs. Prior to +> version `5.5`, `FXRMotionControllerData` handled both motion controller and +> hand tracking data. From `5.5` onward, these responsibilities have been +> separated into the two distinct structs, providing clearer and more +> specialized handling of each. + Before continuing this section, please ensure you've first studied the [Consuming FXRMotionControllerData](./) section. ## Drawing and Animating Virtual Hands @@ -249,4 +263,4 @@ void ADebugPawn::DrawHand(const EControllerHand Hand) const 15. Now, rebuild the source code and go back to the `VRTemplateMap`, then use the VR Preview button to run the game. If everything's done correctly, you should be able to see the virtual hands inside your VR simulation. -![FXRMotionControllerData animated debug virtual hands](consuming-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif "FXRMotionControllerData animated debug virtual hands") +![FXRMotionControllerData animated debug virtual hands](../consuming-fxrhandtrackingstate-fxrmotioncontrollerdata-animated-debug-virtual-hands.gif "FXRMotionControllerData animated debug virtual hands") diff --git a/Plugins/SenseGlove/Handbook/src/advanced-topics/safe-glove-access-blueprint/safe-reliable-glove-access-blueprint.png b/Plugins/SenseGlove/Handbook/src/advanced-topics/safe-glove-access-blueprint/safe-reliable-glove-access-blueprint.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/appendix/changelog.md b/Plugins/SenseGlove/Handbook/src/appendix/changelog.md index 35ed4de..c9a5d51 100644 --- a/Plugins/SenseGlove/Handbook/src/appendix/changelog.md +++ b/Plugins/SenseGlove/Handbook/src/appendix/changelog.md @@ -5,6 +5,77 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [2.3.0] - 2024-11-13 + +This minor release includes some improvements and adds official Unreal Engine `5.5` Fab support. + +### Added + +- Added `USGAndroidPermissions` to the `SenseGloveAndroid` module, enhancing the plugin's permission request process on Android. Now, a pop-up prompts the user to grant permissions, preventing silent crashes when permissions haven't been granted beforehand. +- Added Unreal Engine `5.5` Fab support. + +### Fixed + +- Fix UE `5.5` deprecation warnings inside `USGVirtualHandComponent`. +- Additional minor fixes and improvements that may not be listed here. + +## [2.2.2] - 2024-11-08 + +This patch release addresses a few issues with both glove and hand-tracking. + +### Fixed + +- Fixed a chain of critical bugs that gets triggered due to `GloveConnectivityCheckInterval` getting passed as seconds to the engine rather than milliseconds. Thus, the default or any large value for `GloveConnectivityCheckInterval` causes noticeable long delays between glove-connectivity-check intervals and consequently renders the hand-tracking state invalid in certain situations when the `bFallbackToHandTrackingIfNoGloveDetected` option is false. + +## [2.2.1] - 2024-10-23 + +This patch release focuses exclusively on updates to the documentation. + +### Documentation + +- Updated all URLs, screenshots, and tutorials to reflect the transition from the Unreal Engine Marketplace to Fab, Epic’s new unified content marketplace. +- Revised documentation now points to the new home of the SenseGlove Unreal Engine Plugin on Fab, ensuring users have access to the latest resources and information. + +## [2.2.0] - 2024-10-22 + +This is a minor release with some breaking API and ABI changes, focusing mainly on migrating away from the deprecated `FXRMotionControllerData` in favor of `FXRMotionControllerState` and `FXRHandTrackingState` on Unreal Engine `5.5+`. + +### Added + +- Completed support for the upcoming Unreal Engine `5.5` release. +- Added `USGVirtualHandComponent::GetMotionControllerState()` and the equivalent Blueprint function`UVirtualHandComponentKismetLibrary::GetMotionControllerState` on UE `5.5+`. +- Added `USGVirtualHandComponent::GetHandTrackingState()` and the equivalent Blueprint function `UVirtualHandComponentKismetLibrary::GetHandTrackingState` on UE `5.5+`. +- Added `USGWristTrackerComponent::GetMotionControllerState()` and the equivalent Blueprint function `UWristTrackerComponentKismetLibrary::GetMotionControllerState` on UE `5.5+`. +- Added `USGWristTrackerComponent::GetHandTrackingState()` and the equivalent Blueprint function `UWristTrackerComponentKismetLibrary::GetHandTrackingState` on UE `5.5+`. +- Added a variant of `FSGDebugVirtualHand::Draw()` and the equivalent Blueprint function `USGDebugVirtualHandKismetLibrary::Draw_FXRHandTrackingState()` which accept `FXRHandTrackingState` on UE `5.5+`. +- Added the new member `bTracked` to the `FSGXRHandState` struct. +- Added `FSGXRTracker::GetMotionControllerState()` and the equivalent Blueprint function `USGXRTrackerKismetLibrary::GetMotionControllerState()`. +- Added `FSGXRTracker::GetHandTrackingState()` and the equivalent Blueprint function `USGXRTrackerKismetLibrary::GetHandTrackingState()`. + +### Fixed + +- Additional minor fixes and improvements that may not be listed here. + +### Changed + +- Replaced all internal usages of the `FXRMotionControllerData` struct with either `FXRMotionControllerState` or `FXRHandTrackingState` on UE `5.5+`. +- Deprecated `USGVirtualHandComponent::GetMotionControllerData()` on UE `5.5+`. +- Deprecated `USGWristTrackerComponent::GetMotionControllerData()` on UE `5.5+`. +- Deprecated the variant of `FSGDebugVirtualHand::Draw()` which accepts `FXRMotionControllerData` as a parameter on UE `5.5+`. +- Renamed `USGDebugVirtualHandKismetLibrary::Draw` to `USGDebugVirtualHandKismetLibrary::Draw_FXRMotionControllerData` for more clarification. +- Renamed an `FSGXRHandState` member from `bReceivedJointPoses` to `bHasReceivedJointPoses`. +- Changed the `FSGXRTracker::GetAllKeypointStates()` signature on UE `5.5+` to match the `IHandTracker` interface API changes. +- The animation system on UE `5.5+` has been revamped to utilize `FXRHandTrackingState` instead of `FXRMotionControllerData`. +- The wrist tracking system on UE `5.5+` has been revamped to utilize `FXRHandTrackingState` instead of `FXRMotionControllerData`. +- The hand interaction manipulation on UE `5.5+` has been revamped to utilize `FXRHandTrackingState`. +- The virtual hand debugging system on UE `5.5+` has been revamped to utilize `FXRHandTrackingState`. + +### Documentation + +- Added the documentation on consuming the `FXRHandTrackingState` struct in both Blueprint and C++. +- Updated the documentation on consuming the `FXRMotionControllerData` struct. +- Additional minor documentation fixes and improvements that may not be listed here. + ## [2.1.4] - 2024-10-22 This is a bugfix release that delivers some documentation fixes. diff --git a/Plugins/SenseGlove/Handbook/src/appendix/directory-structure.md b/Plugins/SenseGlove/Handbook/src/appendix/directory-structure.md index 6b2844f..9b88d48 100644 --- a/Plugins/SenseGlove/Handbook/src/appendix/directory-structure.md +++ b/Plugins/SenseGlove/Handbook/src/appendix/directory-structure.md @@ -7,7 +7,7 @@ │ ├── Documentation (this will be generated by running the make command inside the Handbook directory) │ - ├── Handbook (this is the mdBook source code, used to generate the Documentation folder and not distributed to the Unreal Engine Marketplace) + ├── Handbook (this is the mdBook source code, used to generate the Documentation folder and not distributed to [Fab](https://www.fab.com/)) │ ├── Resources │ diff --git a/Plugins/SenseGlove/Handbook/src/appendix/planned-features-completion-status.md b/Plugins/SenseGlove/Handbook/src/appendix/planned-features-completion-status.md index 6b68dea..308ef96 100644 --- a/Plugins/SenseGlove/Handbook/src/appendix/planned-features-completion-status.md +++ b/Plugins/SenseGlove/Handbook/src/appendix/planned-features-completion-status.md @@ -1,6 +1,6 @@ ## Planned Features Completion Status -### Implemented as of v2.1.x +### Implemented as of v2.3.x - [X] Full SenseGlove low-level core API access through Unreal C++. - [X] Full SenseGlove low-level core API access through Blueprint. @@ -28,17 +28,19 @@ - [X] C++/Blueprint interaction events such as OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch. - [X] A fall back to HMD and wrist tracker hardware auto-detection mechanism when automatic detection of the wrist tracker hardware is desired. - [X] OpenXR-compatible hand tracking (XR_EXT_hand_tracking) support. -- [X] FXRMotionControllerData compatible hand animation system. -- [X] FXRMotionControllerData compatible wrist tracking system. -- [X] FXRMotionControllerData compatible hand interaction manipulation system. +- [X] `FXRMotionControllerData` compatible hand animation system on UE versions `5.2`, `5.3`, and `5.4`. +- [X] `FXRHandTrackingState` compatible hand animation system on UE versions `5.5+`. +- [X] `FXRMotionControllerData` compatible wrist tracking system on UE versions `5.2`, `5.3`, and `5.4`. +- [X] `FXRHandTrackingState` compatible wrist tracking system on UE versions `5.5+`. +- [X] `FXRMotionControllerData` compatible hand interaction manipulation system on UE versions `5.2`, `5.3`, and `5.4`. +- [X] `FXRHandTrackingState` compatible hand interaction manipulation system on UE versions `5.5+`. - [X] Ability to fallback to hand tracking when a glove is not present and use the bare hands for interactions, or a combination of glove and hand tracking if no motion controller input is detected. - [X] The SenseGlove grab/touch sockets one-click-setup ability on any Epic-compliant virtual hand mesh from within the Unreal Editor's Content Browser, Skeleton Editor, or Skeletal Mesh Editor. - [X] A flexible virtual hand animation system that can take the mesh bone's transforms into account for a more reliable hand animation. - [X] Ability to manage the Engine Scalability Settings through the SenseGlove plugin in order to change the graphics settings on the fly. +- [X] Ability to automatically ask for the required permissions on Android when the plugin is enabled in any UE project. -### Upcoming features planned for the v2.2.x release - -- [ ] Migrating away from the deprecated `FXRMotionControllerData` in favor of `FXRMotionControllerState` and `FXRHandTrackingState`. +### Upcoming features planned for the v2.4.x release ### Planned features long-term diff --git a/Plugins/SenseGlove/Handbook/src/appendix/platform-support-matrix.md b/Plugins/SenseGlove/Handbook/src/appendix/platform-support-matrix.md index daedb59..0c6fd93 100644 --- a/Plugins/SenseGlove/Handbook/src/appendix/platform-support-matrix.md +++ b/Plugins/SenseGlove/Handbook/src/appendix/platform-support-matrix.md @@ -1,19 +1,19 @@ ## Platform Support Matrix -| | **Windows (MSVC 2017)** | **Windows (MSVC 2019)** | **Windows (MSVC 2022)** | **Linux x86-64 (Native Toolchain)** | **Linux AArch64 (Native Toolchain)** | **Meta Quest Stand-alone (Android NDK)** | **HTC VIVE Stand-alone (Android NDK)** | **UE Marketplace Version** | **Azure DevOps Version** | -|:--------:|:-----------------------:|:-----------------------:|:-----------------------:|:-----------------------------------:|:------------------------------------:|:----------------------------------------:|:--------------------------------------:|:--------------------------:|:------------------------:| -| **5.5** | ❌ | ❌ | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x (r25b) | ❓ | ❌ | ✅ v2.1.4 | -| **5.4** | ❌ | ❌ | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x (r25b) | ❓ | ✅ v2.1.2 | ✅ v2.1.4 | -| **5.3** | ❌ | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x (r25b) | ❓ | ✅ v2.1.2 | ✅ v2.1.4 | -| **5.2** | ❌ | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x | ✅ v2.1.x (r25b) | ❓ | ✅ v2.1.2 | ✅ v2.1.4 | -| **5.1** | ❌ | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x (r25b) | ❓ | ⚠️ v2.0.1 | ⚠️ v2.0.2 | -| **5.0** | ❌ | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x (r21e) | ❓ | ⚠️ v1.6.1 | ⚠️ v1.6.1 | -| **4.27** | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x (r21e) | ❓ | ⚠️ v1.3.1 | ⚠️ v1.4.3 | -| **4.26** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | -| **4.25** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | -| **4.24** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | -| **4.23** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | -| **4.22** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | +| | **Windows (MSVC 2017)** | **Windows (MSVC 2019)** | **Windows (MSVC 2022)** | **Linux x86-64 (Native Toolchain)** | **Linux AArch64 (Native Toolchain)** | **Meta Quest Stand-alone (Android NDK)** | **HTC VIVE Stand-alone (Android NDK)** | **Fab** | **Azure DevOps Version** | +|:--------:|:-----------------------:|:-----------------------:|:-----------------------:|:-----------------------------------:|:------------------------------------:|:----------------------------------------:|:--------------------------------------:|:--------:|:------------------------:| +| **5.5** | ❌ | ❌ | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x (r25b) | ❓ | ✅ v2.3.0 | ✅ v2.3.0 | +| **5.4** | ❌ | ❌ | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x (r25b) | ❓ | ✅ v2.3.0 | ✅ v2.3.0 | +| **5.3** | ❌ | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x (r25b) | ❓ | ✅ v2.3.0 | ✅ v2.3.0 | +| **5.2** | ❌ | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x | ✅ v2.3.x (r25b) | ❓ | ✅ v2.3.0 | ✅ v2.3.0 | +| **5.1** | ❌ | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x (r25b) | ❓ | ⚠️ v2.0.0 | ⚠️ v2.0.2 | +| **5.0** | ❌ | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x (r21e) | ❓ | ⚠️ v1.6.1 | ⚠️ v1.6.1 | +| **4.27** | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x (r21e) | ❓ | ⚠️ v1.3.1 | ⚠️ v1.4.3 | +| **4.26** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | +| **4.25** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | +| **4.24** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | +| **4.23** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | +| **4.22** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 | * ✅ Supported * ⚠️ Not supported by the latest release and might be lacking features @@ -21,7 +21,6 @@ * ❓ Unknown or untested Remarks: -* With the Fab content marketplace scheduled to launch at an unspecified date in October 2024, and the fact that the Unreal Engine Marketplace no longer accepting any new submissions starting from October 1, any releases made during the transition from the Unreal Engine Marketplace to Fab will only be accessible through the [SenseGlove Microsoft Azure repositories](../getting-started/installation/microsoft-azure-devops-repositories.md). * Per [Epic's Marketplace Guidelines](https://www.unrealengine.com/en-US/marketplace-guidelines) in regards to Code Plugins (sections `2.6.3`.d and `3.1.b`), we are only able to distribute or update the SenseGlove plugin for the last `3` stable versions of Unreal Engine. As a result, we won't be able to publish updates or bug fixes for the older versions of the Engine except on rare occasions and only through our official repository on Microsoft Azure DevOps. * All third-party libraries on Windows built against Windows SDK `10.0`. * Oculus and VIVE support is only provided through the recommended Android NDK versions by Epic Games. diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-quest-link-developer-runtime-features.png b/Plugins/SenseGlove/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/meta-quest-link-developer-runtime-features.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/vive-business-streaming-hand-tracking.png b/Plugins/SenseGlove/Handbook/src/getting-started/enabling-xr-ext-hand-tracking-vr-headsets/vive-business-streaming-hand-tracking.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/README.md b/Plugins/SenseGlove/Handbook/src/getting-started/installation/README.md index 3981fdc..b0d1898 100644 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/README.md +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/README.md @@ -2,13 +2,13 @@ The SenseGlove Unreal Engine Plugin could be installed using various methods: -- Through [the Epic Games Launcher](https://store.epicgames.com/en-US/download) by navigating to [the SenseGlove Unreal Engine Plugin landing page on the Unreal Engine Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin). -- Through [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal). +- Via [the Epic Games Launcher](https://store.epicgames.com/en-US/download) by navigating to [the SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099). +- Via [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal). In the following chapters, we discover each of those methods: -- [Installation through the Epic Games Launcher](epic-games-launcher.md) -- [Installation through Microsoft Azure DevOps Repositories](microsoft-azure-devops-repositories.md) +- [Installation via the Epic Games Launcher](epic-games-launcher.md) +- [Installation via Microsoft Azure DevOps Repositories](microsoft-azure-devops-repositories.md) ## Video Tutorials diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-001.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-001.png deleted file mode 100644 index 72aac7e..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-001.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:0dda98796f2f6bfe8a934110d2ab7f534fc42e263b71c39697fc94a7406be88c -size 782449 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-002.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-002.png deleted file mode 100644 index 4a2f490..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-002.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:eeb410c70a268b729acd53e8897f42ea53d31a0a8f5b258012eea0d86f47dab0 -size 1400479 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-003.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-003.png deleted file mode 100644 index fb4cc2a..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-003.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:17472ebf888d79b0909f83dec5d8379598c28b3514582a2fa3115bae760d9af4 -size 1407599 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-004.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-004.png deleted file mode 100644 index 3e5b430..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-004.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:690cf9af1992acedd0cc39396a3499dfcd7b4b4795eabe634d3a9629b55ca174 -size 499900 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-005.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-005.png deleted file mode 100644 index ced0623..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-005.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:45e3c1af739a3e46ae11ce5f377819bcad0b3f76804cf068da831553acec6676 -size 212462 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-006.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-006.png deleted file mode 100644 index f4f11f5..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-006.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:57deab574ac9bf2a2ec6b9be7793dd5729e071457f263b5753db33a2c18f6126 -size 475915 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-007.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-007.png deleted file mode 100644 index dd37d94..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-007.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:cdcbf36097aa6b64af29fa50469fcecad7484e79ed75c87a2bd436a411346aed -size 238763 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-008.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-008.png deleted file mode 100644 index 07bf89c..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-008.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:ce0742e02678dce3d9baf929d4f332efa8d56e74b855e8daf163173ef35a56c0 -size 196427 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-009.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-009.png deleted file mode 100644 index 20391ea..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-009.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:e101133f3d4c70846dcb8cac36e4451af1d3dca558a04a6fe67a864dcce77993 -size 168715 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-010.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-010.png deleted file mode 100644 index 6c6b7cf..0000000 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-010.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:38df4bc2772c1b460b82690a1e05e25b8b3c75d01a068d5ba70fbe68a705d6b1 -size 92351 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-eula-agreement.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-eula-agreement.png new file mode 100644 index 0000000..789e00f --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-eula-agreement.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2bf2776d14205b4579f3713bb2fb35d1596f9ef16f6de75a82fabc571e926298 +size 675518 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-path.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-path.png new file mode 100644 index 0000000..94599fa --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-path.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:92550cd903faf49a63b00d8323fbe89dc6c8f5dd56b8298e23c2676d624bc341 +size 83987 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-plugin.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-plugin.png new file mode 100644 index 0000000..f619bb7 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-install-plugin.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fdde22271b50b45b79b48b41b542f8ad6a72aa786b78da0c83630495b0214120 +size 179606 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-refresh.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-refresh.png new file mode 100644 index 0000000..e545e75 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-refresh.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e94ffc90bac97cd693680706a8802f2ab57249d856a4788642fe3b9876ed7016 +size 241732 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-search-senseglove.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-search-senseglove.png new file mode 100644 index 0000000..0f2ec80 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-library-search-senseglove.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6fe78d39d4876723c94a76fe5d1796b4aee09f3547d1372116ac1a09e46498de +size 220855 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-results.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-results.png new file mode 100644 index 0000000..13d9b75 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-results.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af3911796a473254c5ed5d5954583a4fd41ba0b1f8272ac0824a6a5b2728a226 +size 178768 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-senseglove.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-senseglove.png new file mode 100644 index 0000000..8934348 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-search-senseglove.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:897f331b52ab098c5611a8d587ce83d3e729d33d2b91ed5905debf6c4ec80f22 +size 1013857 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress-details.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress-details.png new file mode 100755 index 0000000..816251e --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress-details.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23c4dac57a8e81e23431dbd1f3805a3a0d5f064ae32b2b003f955729058108c1 +size 101663 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress.png new file mode 100644 index 0000000..92b094d --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download-install-progress.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce095f53ccc744faf0c443a3069187b10a0aca28f3c1aeee195c54c410fbdc5c +size 222593 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download.png new file mode 100644 index 0000000..04b5306 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-download.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e8454688500ce3a2a851e99e24cca6520deb05a805b68a4a55b2f01b806ada0 +size 538063 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-home-page.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-home-page.png new file mode 100644 index 0000000..5b96d8b --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-senseglove-home-page.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:986cf4cea0bea2660fa1a16a6c6e93218672556615e70db238f19bfbb8125fdf +size 979236 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-tab.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-tab.png new file mode 100644 index 0000000..0271ddc --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-tab.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d700499ced994a1176022ef3a17a256c5b7d81947960152561b3e9030ac84c0a +size 1019925 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-verify-install.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-verify-install.png new file mode 100644 index 0000000..d4426a4 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-fab-verify-install.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fc11e724e20455ec360f18fec29004ae0aa3c961adf30edca94ffab74f43fd5 +size 211365 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-unreal-engine-home.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-unreal-engine-home.png new file mode 100644 index 0000000..19fa552 --- /dev/null +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher-unreal-engine-home.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9cb82f1df76333b4cefdd4e2b1bda3f714993c57c983d829668e9d95a3e4ecae +size 1272169 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher.md b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher.md index 2e8f2d6..f3d6a58 100644 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher.md +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/epic-games-launcher.md @@ -1,46 +1,68 @@ -# Plugin Installation through the Epic Games Launcher +# Plugin Installation via the Epic Games Launcher -Before we start the plugin installation through [the Epic Games Launcher](https://store.epicgames.com/en-US/download) please make sure you have [a signed-in Epic Games account on your installed Epic Games Launcher and a supported Unreal Engine version already installed](https://dev.epicgames.com/documentation/en-us/unreal-engine/installing-unreal-engine). The supported engine versions are listed on [the Platform Support Matrix](../../appendix/platform-support-matrix.md). +Before beginning the plugin installation via [the Epic Games Launcher](https://store.epicgames.com/en-US/download), ensure you have [signed into your Epic Games account on the Epic Games Launcher](https://store.epicgames.com/en-US/download) and that you have a [supported version of Unreal Engine installed](https://dev.epicgames.com/documentation/en-us/unreal-engine/installing-unreal-engine). Supported engine versions can be found in the [Platform Support Matrix](../../appendix/platform-support-matrix.md). 1. Run the Epic Games Launcher. -![Plugin installation through the Epic Games Launcher - step 1](epic-games-launcher-001.png "Plugin installation through the Epic Games Launcher - step 1") +![Plugin installation via the Epic Games Launcher - The Unreal Engine home in the Epic Games Launcher](epic-games-launcher-unreal-engine-home.png "Plugin installation via the Epic Games Launcher - The Unreal Engine home in the Epic Games Launcher") -2. Navigate to the `Marketplace` tab. +2. Navigate to the `Fab` tab and click `Start exploring` button which in turn opens your default web browser pointing to the [Fab home page](https://www.fab.com/). -![Plugin installation through the Epic Games Launcher - step 2](epic-games-launcher-002.png "Plugin installation through the Epic Games Launcher - step 2") +![Plugin installation via the Epic Games Launcher - The Fab tab in the Epic Games Launcher](epic-games-launcher-fab-tab.png "Plugin installation via the Epic Games Launcher - The Fab tab in the Epic Games Launcher") -3. On the `Marketplace` tab, inside the search box, start typing `SenseGlove` which filters the plugin matching that search phrase in real-time. Select `The SenseGlove Unreal Engine Plugin`. +3. On the [Fab home page](https://www.fab.com/), enter the term `SenseGlove` in the search box and press Enter. Alternatively, you can go directly to the [SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099) directly instead of taking the above two steps. -![Plugin installation through the Epic Games Launcher - step 3](epic-games-launcher-003.png "Plugin installation through the Epic Games Launcher - step 3") +![Plugin installation via the Epic Games Launcher - Searching for the term SenseGlove on the Fab home page](epic-games-launcher-fab-search-senseglove.png "Plugin installation via the Epic Games Launcher - Searching for the term SenseGlove on the Fab home page") -4. Once on [the SenseGlove Unreal Engine Plugin marketplace page](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin), click on the `Install to Engine` button. +4. Click on the `SenseGlove Unreal Engine Plugin` in the search results to navigate to its dedicated page. -![Plugin installation through the Epic Games Launcher - step 4](epic-games-launcher-004.png "Plugin installation through the Epic Games Launcher - step 4") +![Plugin installation via the Epic Games Launcher - The Fab search results for the term SenseGlove](epic-games-launcher-fab-search-results.png "Plugin installation via the Epic Games Launcher - The Fab search results for the term SenseGlove") -5. You'll be prompted to choose a compatible engine version. Select your desired engine version and hit this `Install` button. +5. On the [SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099) click the `Download` button. -![Plugin installation through the Epic Games Launcher - step 5](epic-games-launcher-005.png "Plugin installation through the Epic Games Launcher - step 5") +![Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Engine Plugin home page on Fab](epic-games-launcher-fab-senseglove-home-page.png "Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Engine Plugin home page on Fab") -6. The launcher will show the download and installation progress. Please wait for it to finish. +6. If this is your first download from Fab, you will need to agree to the Fab End User License Agreement (EULA) before proceeding. -![Plugin installation through the Epic Games Launcher - step 6](epic-games-launcher-006.png "Plugin installation through the Epic Games Launcher - step 6") +![Plugin installation via the Epic Games Launcher - Fab End User License Agreement (EULA) prompt](epic-games-launcher-fab-eula-agreement.png "Plugin installation via the Epic Games Launcher - Fab End User License Agreement (EULA) prompt") -7. While the download and installation are in progress you can see the progress in more detail by clicking on the `Downloads` section on the sidebar. +7. After clicking `Download`, a pop-up will notify you that the plugin is available in your Vault in the Epic Games Launcher, or the Fab UE5 Plugin. -![Plugin installation through the Epic Games Launcher - step 7](epic-games-launcher-007.png "Plugin installation through the Epic Games Launcher - step 7") +> [!NOTE] +> According to the +> [Fab launch announcement](https://www.unrealengine.com/en-US/blog/fab-epics-new-unified-content-marketplace-launches-today): +> +> The Fab integration in UEFN is undergoing maintenance and will be back online shortly, and the Fab integration in the Unreal Engine 5 Editor is coming soon. -8. Once the download and installation are done, you can head to the `Library` tab to verify the installation. In case you have lots of assets or plugins installed, you could search the term `SenseGlove` inside the search box for the `Vault` section and you should be able to see that the SenseGlove Unreal Engine Plugin has been added to your vault. +![Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Engine Plugin download pop-up on Fab](epic-games-launcher-fab-senseglove-download.png "Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Engine Plugin download pop-up on Fab") -![Plugin installation through the Epic Games Launcher - step 8](epic-games-launcher-008.png "Plugin installation through the Epic Games Launcher - step 8") +8. Go back to the Epic Games Launcher, navigate to the `Library` tab, and in the `Fab Library` section, click the `Refresh Fab items` button. -9. If you click on the `Installed Plugins` link under the engine you've just installed the plugin to, you should be able to see the SenseGlove Unreal Engine Plugin listed as installed. +![Plugin installation via the Epic Games Launcher - Refreshing Fab items in the Epic Games Launcher](epic-games-launcher-fab-library-refresh.png "Plugin installation via the Epic Games Launcher - Refreshing Fab items in the Epic Games Launcher") -![Plugin installation through the Epic Games Launcher - step 9](epic-games-launcher-009.png "Plugin installation through the Epic Games Launcher - step 9") +9. Once the Fab library is refreshed and synchronized, use the Vault search box to find the `SenseGlove Unreal Engine Plugin`. Click the `Install to Engine` button. -10. One last confirmation could be navigating to `YourEngineInstallationPath/Engine/Plugins/Marketplace` directory. The SenseGlove Unreal Engine Plugin source and binaries can be found inside this directory. This is especially useful in case one desires to copy the plugin for example to their own project's source code to run it at the project level instead of running it at the engine level. +![Plugin installation via the Epic Games Launcher - Searching the Vault for the term SenseGlove](epic-games-launcher-fab-library-search-senseglove.png "Plugin installation via the Epic Games Launcher - Searching the Vault for the term SenseGlove") -![Plugin installation through the Epic Games Launcher - step 10](epic-games-launcher-010.png "Plugin installation through the Epic Games Launcher - step 10") +10. You'll be prompted to choose a compatible engine version. Select your desired engine version from the list, then click `Install`. + +![Plugin installation via the Epic Games Launcher - Installing the SenseGlove Unreal Plugin to a specifc Engine version](epic-games-launcher-fab-install-plugin.png "Plugin installation via the Epic Games Launcher - Installing the SenseGlove Unreal Plugin to a specifc Engine version") + +11. The Epic Games Launcher will show the plugin's download and installation progress. Please wait for it to complete. + +![Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Plugin download and installation progress](epic-games-launcher-fab-senseglove-download-install-progress.png "Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Plugin download and installation progress") + +12. While the download and installation are in progress, you can see the progress in more details by clicking on the `Downloads` section on the sidebar. + +![Plugin installation via the Epic Games Launcher - Viewing the SenseGlove Unreal Plugin download and installation progress in details](epic-games-launcher-fab-senseglove-download-install-progress-details.png "Plugin installation via the Epic Games Launcher - Viewing the SenseGlove Unreal Plugin download and installation progress in details") + +13. Once the download and installation are complete, verify its installation by clicking `Installed Plugins` under the engine you've just installed it to. The SenseGlove plugin should appear as installed among other currently installed plugins. + +![Plugin installation via the Epic Games Launcher - Verifying the SenseGlove Unreal Plugin installation](epic-games-launcher-fab-verify-install.png "Plugin installation via the Epic Games Launcher - Verifying the SenseGlove Unreal Plugin installation") + +14. One last confirmation could be navigating to `YourEngineInstallationPath/Engine/Plugins/Marketplace` directory. The SenseGlove Unreal Engine Plugin source and binaries can be found inside this directory. This is especially useful in case one desires to copy the plugin for example to their own project's source code to run it at the project level instead of running it at the engine level. + +![Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Plugin installation path](epic-games-launcher-fab-install-path.png "Plugin installation via the Epic Games Launcher - The SenseGlove Unreal Plugin installation path") > [!WARNING] > Please note that it is best practice to install the plugin either at the diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-building-missing-modules.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-building-missing-modules.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-generate-visual-studio-project-files-progress.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-generate-visual-studio-project-files-progress.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-generate-visual-studio-project-files.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-generate-visual-studio-project-files.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-missing-modules.png b/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories-missing-modules.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md b/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md index ed15ae1..1de3eff 100644 --- a/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md +++ b/Plugins/SenseGlove/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md @@ -1,9 +1,9 @@ -# Plugin Installation through Microsoft Azure DevOps Repositories +# Plugin Installation via Microsoft Azure DevOps Repositories -While [plugin installation through the Epic Games Launcher](epic-games-launcher.md) is the most convenient method for most users to obtain and install the latest version of [the SenseGlove Unreal Engine Plugin marketplace page](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin), there might be valid reasons to instead download and install the plugin directly from [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps Repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal). These reasons may include: +While [plugin installation via the Epic Games Launcher](epic-games-launcher.md) is the most convenient method for most users to obtain and install the latest version of [the SenseGlove Unreal Engine Plugin via Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099), there might be valid reasons to instead download and install the plugin directly from [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps Repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal). These reasons may include: -- Downloading an older version that is no longer available on [the Unreal Engine Marketplace](https://www.unrealengine.com/marketplace/en-US/store). -- Downloading a recent version that has been submitted to the Unreal Engine Marketplace, but is still awaiting approval and publication by the Unreal Engine Marketplace Team. +- Downloading an older version that is no longer available on [Fab](https://www.fab.com/). +- Downloading a recent version that has been submitted to Fab, but is still awaiting approval and publication by the Fab Team. - Downloading an under-development, unstable release of the plugin for testing purposes. - Or, any other specific needs that require direct access to the repository. @@ -17,11 +17,11 @@ To download a specific version of the plugin, follow these steps: 2. Locate the branch dropdown menu at the top of the page, just below the navigation bar, and next to the `Copy to clipboard` icon. There you'll find a dropdown menu. By default, it usually selects the [master](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=%2F&version=GBmaster&_a=contents) branch. -![Plugin Installation through Microsoft Azure DevOps Repositories - The branch dropdown menu](microsoft-azure-devops-repositories-branch-dropdown.png "Plugin Installation through Microsoft Azure DevOps Repositories - The branch dropdown menu") +![Plugin Installation via Microsoft Azure DevOps Repositories - The branch dropdown menu](microsoft-azure-devops-repositories-branch-dropdown.png "Plugin Installation via Microsoft Azure DevOps Repositories - The branch dropdown menu") 3. Use the dropdown menu to choose a desired branch containing the source code for a specific version of Unreal Engine or a specific release of the plugin marked with a release tag. -![Plugin Installation through Microsoft Azure DevOps Repositories - Choosing a tag from the branch dropdown menu](microsoft-azure-devops-repositories-branch-dropdown-choose-tag.png "Plugin Installation through Microsoft Azure DevOps Repositories - Choosing a tag from the branch dropdown menu") +![Plugin Installation via Microsoft Azure DevOps Repositories - Choosing a tag from the branch dropdown menu](microsoft-azure-devops-repositories-branch-dropdown-choose-tag.png "Plugin Installation via Microsoft Azure DevOps Repositories - Choosing a tag from the branch dropdown menu") > [!NOTE] > A branch named with engine version numbers, such as `5.4`, `5.3`, etc., @@ -49,7 +49,7 @@ To download a specific version of the plugin, follow these steps: 4. After selecting your desired branch or tag, click on the kebab menu (three vertical dots) located at the top right of the screen and choose `Download as Zip` to obtain the source code for that branch or tag. -![Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a branch or tag as Zip](microsoft-azure-devops-repositories-download-branch-tag-zip.png "Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a branch or tag as Zip") +![Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a branch or tag as Zip](microsoft-azure-devops-repositories-download-branch-tag-zip.png "Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a branch or tag as Zip") ## Download a Specific Version for a Specifc Unreal Engine Version @@ -57,17 +57,17 @@ As mentioned earlier, due to breaking changes between Unreal Engine versions, it 1. First, choose the appropriate branch for your desired Unreal Engine version from the branch dropdown menu, as discussed earlier. Then navigate to the `History` tab. -![Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - History tab](microsoft-azure-devops-repositories-specific-version-history.png "Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - History tab") +![Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - History tab](microsoft-azure-devops-repositories-specific-version-history.png "Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - History tab") -2. Look through the commit history for a commit message that says `bump the plugin version to vX.X.X` as all releases are finalized with this exact commit message and the plugin version. Next, click on the commit message for the version you are looking for. +2. Look via the commit history for a commit message that says `bump the plugin version to vX.X.X` as all releases are finalized with this exact commit message and the plugin version. Next, click on the commit message for the version you are looking for. 3. Once you've selected the correct commit, click on the `Browse Files` button next to the kebab menu (three vertical dots) at the top right of the screen. -![Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Release commit](microsoft-azure-devops-repositories-specific-version-release-commit.png "Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Release commit") +![Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Release commit](microsoft-azure-devops-repositories-specific-version-release-commit.png "Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Release commit") 4. You should now be in the `Content` tab, with the branch dropdown menu displaying the commit hash instead of a branch name or tag. Click on the kebab menu (three vertical dots) again, and select `Download as Zip`. This will give you a zip file containing the exact release you need, compatible with your chosen Unreal Engine version. -![Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Download as Zip](microsoft-azure-devops-repositories-specific-version-download-zip.png "Plugin Installation through Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Download as Zip") +![Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Download as Zip](microsoft-azure-devops-repositories-specific-version-download-zip.png "Plugin Installation via Microsoft Azure DevOps Repositories - Downloading a specific version for a specifc Unreal Engine version - Download as Zip") ## Download the Bleeding-edge Development Branch @@ -86,7 +86,7 @@ As mentioned earlier, due to breaking changes between Unreal Engine versions, it Downloading the [`dev`](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=%2F&version=GBdev&_a=contents) branch is as easy as choosing the `dev` branch from the branch dropdown menu (as discussed earlier) and then choosing `Download as Zip` from the kebab menu (three vertical dots). -![Plugin Installation through Microsoft Azure DevOps Repositories - Downloading the bleeding-edge development branch](microsoft-azure-devops-repositories-download-dev.png "Plugin Installation through Microsoft Azure DevOps Repositories - Downloading the bleeding-edge development branch") +![Plugin Installation via Microsoft Azure DevOps Repositories - Downloading the bleeding-edge development branch](microsoft-azure-devops-repositories-download-dev.png "Plugin Installation via Microsoft Azure DevOps Repositories - Downloading the bleeding-edge development branch") ## Installation @@ -211,11 +211,11 @@ MyCppProject For a Blueprint-only project, on Microsoft Windows simply double-clicking the project's `.uproject` file should present you with a pop-up informing you that some binary modules are missing. -![Plugin Installation through Microsoft Azure DevOps Repositories - Missing Modules dialog](microsoft-azure-devops-repositories-missing-modules.png "Plugin Installation through Microsoft Azure DevOps Repositories - Missing Modules dialog") +![Plugin Installation via Microsoft Azure DevOps Repositories - Missing Modules dialog](microsoft-azure-devops-repositories-missing-modules.png "Plugin Installation via Microsoft Azure DevOps Repositories - Missing Modules dialog") After confirming, the build process will start automatically, and a dialog indicating the build progress will be shown: -![Plugin Installation through Microsoft Azure DevOps Repositories - Building missing modules progress dialog](microsoft-azure-devops-repositories-building-missing-modules.png "Plugin Installation through Microsoft Azure DevOps Repositories - Building missing modules progress dialog") +![Plugin Installation via Microsoft Azure DevOps Repositories - Building missing modules progress dialog](microsoft-azure-devops-repositories-building-missing-modules.png "Plugin Installation via Microsoft Azure DevOps Repositories - Building missing modules progress dialog") Once finished successfully, the project will be loaded. @@ -224,11 +224,11 @@ Once finished successfully, the project will be loaded. For C++ projects, on Microsoft Windows, right-click on your C++ `.uproject` file and choose `Generate Visual Studio project files`: -![Plugin Installation through Microsoft Azure DevOps Repositories - Generating Visual Studio project files](microsoft-azure-devops-repositories-generate-visual-studio-project-files.png "Plugin Installation through Microsoft Azure DevOps Repositories - Generating Visual Studio project files") +![Plugin Installation via Microsoft Azure DevOps Repositories - Generating Visual Studio project files](microsoft-azure-devops-repositories-generate-visual-studio-project-files.png "Plugin Installation via Microsoft Azure DevOps Repositories - Generating Visual Studio project files") A dialog will pop up shows you the progress of generating the Visual Studio project files: -![Plugin Installation through Microsoft Azure DevOps Repositories - Generating Visual Studio project files progress](microsoft-azure-devops-repositories-generate-visual-studio-project-files-progress.png "Plugin Installation through Microsoft Azure DevOps Repositories - Generating Visual Studio project files progress") +![Plugin Installation via Microsoft Azure DevOps Repositories - Generating Visual Studio project files progress](microsoft-azure-devops-repositories-generate-visual-studio-project-files-progress.png "Plugin Installation via Microsoft Azure DevOps Repositories - Generating Visual Studio project files progress") Once the project files are generated, open up the C++ project in your preferred C++ IDE and build the project. After this, the project can be loaded in the Unreal Editor. diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/enable-plugin-001.png b/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/enable-plugin-001.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/enable-plugin-002.png b/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/enable-plugin-002.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/verify-version-001.png b/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/verify-version-001.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/verify-version-002.png b/Plugins/SenseGlove/Handbook/src/getting-started/plugin-verify-version-enable/verify-version-002.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-confirm-pairing.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-confirm-pairing.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-paired.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-paired.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-search-button.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-search-button.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-searching.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-searching.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-verify-bluetooth-controller-status.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-verify-bluetooth-controller-status.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-version.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/blueman-version.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/successful-senscom-nova-glove-connection.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/gnu-linux/successful-senscom-nova-glove-connection.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-connect.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-connect.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-discover.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-discover.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-paired.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device-paired.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-add-bluetooth-device.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-bluetooth-settings-paired-devices-list.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-bluetooth-settings-paired-devices-list.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-bluetooth-settings.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-bluetooth-settings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-run-sensecom.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-run-sensecom.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-successful-senscom-nova-glove-connection.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/microsoft-windows-successful-senscom-nova-glove-connection.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/sensecom-github-download.png b/Plugins/SenseGlove/Handbook/src/getting-started/sensecom/sensecom-github-download.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/adding-sggrabcomponent.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/adding-sggrabcomponent.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/collision-generate-hit-overlap-events.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/collision-generate-hit-overlap-events.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/collision-presets-block-all.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/collision-presets-block-all.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/release-max-velocity-samples.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/release-max-velocity-samples.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/sggrabcomponent-settings.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-grab-release-system/sggrabcomponent-settings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/add-blueprint-class.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/add-blueprint-class.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggameinstance.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggameinstance.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggamemodebase.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggamemodebase.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggameusersettings.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sggameusersettings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sgpawn.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sgpawn.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sgplayercontroller.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class-sgplayercontroller.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/pick-parent-class.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/rename-new-blueprint.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/rename-new-blueprint.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggameinstance.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggameinstance.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggamemodebase.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggamemodebase.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggameusersettings.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sggameusersettings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sgpawn.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sgpawn.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sgplayercontroller.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/renamed-new-blueprint-sgplayercontroller.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggameinstance.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggameinstance.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggamemode.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggamemode.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggameusersettings.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsggameusersettings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsgpawn.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsgpawn.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsgplayercontroller.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-bpsgplayercontroller.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggameinstance.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggameinstance.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggamemodebase.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggamemodebase.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggameusersettings.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sggameusersettings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sgpawn.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sgpawn.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sgplayercontroller.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/set-default-class-sgplayercontroller.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/sgpawn-components.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/sgpawn-components.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/sgpawn-filtered-details-panel.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-senseglove-default-classes/sgpawn-filtered-details-panel.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/adding-sgtouchcomponent.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/adding-sgtouchcomponent.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/collision-generate-hit-overlap-events.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/collision-generate-hit-overlap-events.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/collision-presets-block-all.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/collision-presets-block-all.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/sgtouchcomponent-settings.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-touch-system/sgtouchcomponent-settings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-bulk-export.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-bulk-export.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-content-browser-location.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-content-browser-location.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-exported.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-exported.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-fbx-export-options.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-fbx-export-options.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-new-vrtemplate-project.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-new-vrtemplate-project.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-select-folder.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/export-virtual-hand-meshes-select-folder.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-assing-senseglove-material-left-hand-mesh.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-assing-senseglove-material-left-hand-mesh.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-assing-senseglove-material-right-hand-mesh.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-assing-senseglove-material-right-hand-mesh.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-create-empty-folder.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-create-empty-folder.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-delete-default-material-confirm.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-delete-default-material-confirm.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-delete-default-material.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-delete-default-material.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-import-logs.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-import-logs.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-import-options.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-import-options.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-save-all-confirm.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-save-all-confirm.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-save-all.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-fbx-save-all.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-imported.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-imported.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-select-fbx-files.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/import-virtual-hand-meshes-select-fbx-files.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-adjusted-physics-body.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-adjusted-physics-body.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-adjusting-physics-body.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-adjusting-physics-body.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-generate-box-physics-body.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-generate-box-physics-body.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-phat-editor.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/rigid-body-setup-phat-editor.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-confirmation.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-confirmation.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-failure-1.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-failure-1.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-failure-2.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-failure-2.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-success.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-add-sockets-success.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-added-sockets.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-added-sockets.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-clear-sockets-confirmation.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-clear-sockets-confirmation.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-clear-sockets-success.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-clear-sockets-success.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-failure-output-log.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-failure-output-log.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-failure-output-logs-socket-already-exists.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-failure-output-logs-socket-already-exists.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-content-browser-bulk-actions.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-content-browser-bulk-actions.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-content-browser.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-content-browser.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-skeleton-skeletal-mesh-editor-asset-menu.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-skeleton-skeletal-mesh-editor-asset-menu.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-skeleton-skeletal-mesh-editor-toolbar.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-from-skeleton-skeletal-mesh-editor-toolbar.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-sockets-cleared.png b/Plugins/SenseGlove/Handbook/src/getting-started/setup-virtual-hand-meshes/senseglove-sockets-editor-sockets-cleared.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/blueprint-function-get-game-user-settings.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/blueprint-function-get-game-user-settings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences-refresh-rate-120hz.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences-refresh-rate-120hz.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences-refresh-rate.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences-refresh-rate.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-advanced-graphics-preferences.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-selected.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-device-selected.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-devices.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/meta-quest-link-devices.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-culling.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-culling.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-default-settings.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-default-settings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-forward-renderer.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-forward-renderer.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-framerate.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-framerate.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-mobile.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-mobile.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-reflections.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-reflections.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-textures.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-textures.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-virtual-textures.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-virtual-textures.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-vr.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/project-rendering-settings-vr.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgbasicdemo-openxr-fps-engine-scalability-settings-umg-widget.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgbasicdemo-openxr-fps-engine-scalability-settings-umg-widget.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgpawn-bind-engine-scalability-settings-1.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgpawn-bind-engine-scalability-settings-1.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgpawn-bind-engine-scalability-settings-2.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/sgpawn-bind-engine-scalability-settings-2.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/unreal-editor-engine-scalability-settings.png b/Plugins/SenseGlove/Handbook/src/misc/optimize-higher-fps/unreal-editor-engine-scalability-settings.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Handbook/src/overview/README.md b/Plugins/SenseGlove/Handbook/src/overview/README.md index 47b158b..b009f24 100644 --- a/Plugins/SenseGlove/Handbook/src/overview/README.md +++ b/Plugins/SenseGlove/Handbook/src/overview/README.md @@ -7,8 +7,8 @@ To help you navigate the SenseGlove Unreal Engine Handbook, we have organized th This section covers the basics of the SenseGlove Unreal Engine Plugin: - [Installation](../getting-started/installation/) - - [Through the Epic Games Launcher](../getting-started/installation/epic-games-launcher.md) - - [Through Microsoft Azure DevOps Repositories](../getting-started/installation/microsoft-azure-devops-repositories.md) + - [Via the Epic Games Launcher](../getting-started/installation/epic-games-launcher.md) + - [Via Microsoft Azure DevOps Repositories](../getting-started/installation/microsoft-azure-devops-repositories.md) - [Enabling and Verifying the Plugin Version](../getting-started/plugin-verify-version-enable/) - [SenseCom](../getting-started/sensecom/) - [SenseCom on GNU/Linux](../getting-started/sensecom/gnu-linux/) @@ -65,6 +65,9 @@ For users familiar with the basics, this section explores advanced features of t - [Safe Glove Access in Blueprint](../advanced-topics/safe-glove-access-blueprint/) - [OpenXR](../advanced-topics/openxr/) + - [Consuming FXRHandTrackingState](../advanced-topics/openxr/consuming-fxrhandtrackingstate/) + - [Blueprint](../advanced-topics/openxr/consuming-fxrhandtrackingstate/blueprint.md) + - [C++](../advanced-topics/openxr/consuming-fxrhandtrackingstate/cpp.md) - [Consuming FXRMotionControllerData](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/) - [Blueprint](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md) - [C++](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md) diff --git a/Plugins/SenseGlove/Handbook/src/plugin-configuration/plugin-settings/tracking/wrist-tracking/wrist-tracking-settings-supported-hardware.png b/Plugins/SenseGlove/Handbook/src/plugin-configuration/plugin-settings/tracking/wrist-tracking/wrist-tracking-settings-supported-hardware.png old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Packager/sgum-packager b/Plugins/SenseGlove/Packager/sgum-packager old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Packager/sgum-packager.exe b/Plugins/SenseGlove/Packager/sgum-packager.exe old mode 100644 new mode 100755 diff --git a/Plugins/SenseGlove/Packager/sgum-packager.yml b/Plugins/SenseGlove/Packager/sgum-packager.yml index 18cc32c..ec82e68 100644 --- a/Plugins/SenseGlove/Packager/sgum-packager.yml +++ b/Plugins/SenseGlove/Packager/sgum-packager.yml @@ -42,6 +42,7 @@ Deploy: PasswordEnvVar: SGUM_PACKAGER_REPOSITORY_PASSWORD Branches: + - "5.5" - "5.4" - "5.3" - "5.2" @@ -181,11 +182,13 @@ Rocket: PackageDirectory: "%TEMP%\\SenseGlove-Unreal\\Rocket" EnginePaths: + - "5.5": "C:\\OPT\\UE_5.5" - "5.4": "C:\\OPT\\UE_5.4" - "5.3": "C:\\OPT\\UE_5.3" - "5.2": "C:\\OPT\\UE_5.2" NDKPaths: + - "5.5": "%LOCALAPPDATA%\\Android\\Sdk\\ndk\\25.1.8937393" - "5.4": "%LOCALAPPDATA%\\Android\\Sdk\\ndk\\25.1.8937393" - "5.3": "%LOCALAPPDATA%\\Android\\Sdk\\ndk\\25.1.8937393" - "5.2": "%LOCALAPPDATA%\\Android\\Sdk\\ndk\\25.1.8937393" diff --git a/Plugins/SenseGlove/README.md b/Plugins/SenseGlove/README.md index 11fd362..4c869d3 100644 --- a/Plugins/SenseGlove/README.md +++ b/Plugins/SenseGlove/README.md @@ -14,7 +14,7 @@ For examples, demo scenes, tutorials, and extra resources please check out [the Various instructions on [how to download and install the SenseGlove Unreal Engine Plugin](Handbook/src/getting-started/installation/README.md) are available. It could either be installed through [the Epic Games Launcher](Handbook/src/getting-started/installation/epic-games-launcher.md), or [through Microsoft Azure DevOps repositories](Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md). -For more information, visit [the SenseGlove Unreal Engine Handbook on the Epic Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin). +For more information, visit [the SenseGlove Unreal Engine Plugin on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099). ### Platform Support Matrix diff --git a/Plugins/SenseGlove/SenseGlove.uplugin b/Plugins/SenseGlove/SenseGlove.uplugin index 7d4b704..d5184db 100644 --- a/Plugins/SenseGlove/SenseGlove.uplugin +++ b/Plugins/SenseGlove/SenseGlove.uplugin @@ -1,7 +1,7 @@ { "FileVersion": 3, "Version": 1, - "VersionName": "2.1.4", + "VersionName": "2.3.0", "FriendlyName": "SenseGlove", "Description": "Integrating the SenseGlove haptic controller into Unreal Engine", "Category": "Virtual Reality", @@ -274,6 +274,10 @@ } ], "Plugins": [ + { + "Name": "AndroidPermission", + "Enabled": true + }, { "Name": "OpenXR", "Enabled": true, diff --git a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.cpp b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.cpp index 9c146a1..1968b60 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.cpp +++ b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.cpp @@ -44,10 +44,8 @@ #include "Containers/UnrealString.h" #include "Engine/SkeletalMesh.h" #include "Math/Rotator.h" -#include "Runtime/Launch/Resources/Version.h" #include "SenseGlove/Components/SGVirtualHandComponent.h" -#include "SGLog/SGLog.h" FSGVirtualHandAnimInstanceProxy::FSGVirtualHandAnimInstanceProxy() : FAnimInstanceProxy{} @@ -108,6 +106,16 @@ void FSGVirtualHandAnimInstanceProxy::PreEvaluateAnimation(UAnimInstance* InAnim return; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + const bool bGotHandTrackingState = VirtualHand->GetHandTrackingState( + EXRSpaceType::UnrealWorldSpace, HandTrackingState); + if (!bGotHandTrackingState || !HandTrackingState.bValid) + { + return; + } + ensureAlwaysMsgf(HandTrackingState.HandKeyLocations.Num() == HandTrackingState.HandKeyRotations.Num(), + TEXT("Mismatched hand tracking state locations and rotations!")); +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ const bool bGotMotionControllerData = VirtualHand->GetMotionControllerData(MotionControllerData); if (!bGotMotionControllerData || !MotionControllerData.bValid) { @@ -115,10 +123,18 @@ void FSGVirtualHandAnimInstanceProxy::PreEvaluateAnimation(UAnimInstance* InAnim } ensureAlwaysMsgf(MotionControllerData.HandKeyPositions.Num() == MotionControllerData.HandKeyRotations.Num(), TEXT("Mismatched motion controller data positions and rotations!")); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + BoneNamesMap.Empty(); for (TArray::SizeType HandKeyIndex = 0; - HandKeyIndex < MotionControllerData.HandKeyRotations.Num(); ++HandKeyIndex) + HandKeyIndex < +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + HandTrackingState.HandKeyRotations.Num() +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + MotionControllerData.HandKeyRotations.Num() +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + ; ++HandKeyIndex) { const FName& BoneName{VirtualHand->GetHandBoneName(HandKeyIndex)}; BoneNamesMap.Add(HandKeyIndex, BoneName); @@ -136,10 +152,17 @@ bool FSGVirtualHandAnimInstanceProxy::Evaluate(FPoseContext& Output) return FAnimInstanceProxy::Evaluate(Output); } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + if (!HandTrackingState.bValid) + { + return FAnimInstanceProxy::Evaluate(Output); + } +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ if (!MotionControllerData.bValid) { return FAnimInstanceProxy::Evaluate(Output); } +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ FComponentSpacePoseContext PoseContext{Output.AnimInstanceProxy}; PoseContext.Pose.InitPose(Output.Pose); @@ -164,9 +187,16 @@ bool FSGVirtualHandAnimInstanceProxy::Evaluate(FPoseContext& Output) BoneReference.BoneIndex = BoneIndex; BoneReference.bUseSkeletonIndex = true; +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + const FVector& HandKeyLocation{HandTrackingState.HandKeyLocations[HandKeyIndex]}; + const FQuat& HandKeyRotation{HandTrackingState.HandKeyRotations[HandKeyIndex]}; + const FTransform HandKeyTransform{HandKeyRotation, HandKeyLocation}; +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ const FVector& HandKeyPosition{MotionControllerData.HandKeyPositions[HandKeyIndex]}; const FQuat& HandKeyRotation{MotionControllerData.HandKeyRotations[HandKeyIndex]}; const FTransform HandKeyTransform{HandKeyRotation, HandKeyPosition}; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + const FTransform BoneTransform{AnimationBoneCorrectionOffsetTransform * HandKeyTransform}; FRotator BoneRotation{BoneTransform.GetRotation().Rotator()}; diff --git a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGVirtualHandComponent.cpp b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGVirtualHandComponent.cpp index 3389369..d44f624 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGVirtualHandComponent.cpp +++ b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGVirtualHandComponent.cpp @@ -236,7 +236,11 @@ USGVirtualHandComponent::USGVirtualHandComponent(const FObjectInitializer& Objec Super::SetCollisionResponseToChannel(ECC_Vehicle, ECR_Block); Super::SetCollisionResponseToChannel(ECC_Destructible, ECR_Block); +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + Super::SetAnimInstanceClass(USGVirtualHandAnimInstance::StaticClass()); +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ Super::SetAnimClass(USGVirtualHandAnimInstance::StaticClass()); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ bRight = true; @@ -291,6 +295,15 @@ FSGVirtualHandSettings USGVirtualHandComponent::GetVirtualHandSettings() const return VirtualHandSettings; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 +void USGVirtualHandComponent::SetAnimInstanceClass(UClass* NewClass) +{ + ensureAlwaysMsgf((TIsDerivedFrom::IsDerived), + TEXT("The AnimInstance class must be a subclass of USGVirtualHandAnimInstance!")); + + Super::SetAnimInstanceClass(NewClass); +} +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ void USGVirtualHandComponent::SetAnimClass(UClass* NewClass) { ensureAlwaysMsgf((TIsDerivedFrom::IsDerived), @@ -298,6 +311,7 @@ void USGVirtualHandComponent::SetAnimClass(UClass* NewClass) Super::SetAnimClass(NewClass); } +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ void USGVirtualHandComponent::PostInitProperties() { @@ -452,8 +466,10 @@ bool USGVirtualHandComponent::GetMotionControllerData(FXRMotionControllerData& O OutMotionControllerData.bValid = false; const EControllerHand Hand = IsRight() ? EControllerHand::Right : EControllerHand::Left; + PRAGMA_DISABLE_DEPRECATION_WARNINGS const bool bGotMotionControllerData = FSGXRTracker::GetMotionControllerData(this, Hand, OutMotionControllerData); + PRAGMA_ENABLE_DEPRECATION_WARNINGS if (!bGotMotionControllerData || !OutMotionControllerData.bValid) { return false; @@ -462,6 +478,46 @@ bool USGVirtualHandComponent::GetMotionControllerData(FXRMotionControllerData& O return OutMotionControllerData.bValid; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + +bool USGVirtualHandComponent::GetMotionControllerState( + const EXRSpaceType XRSpaceType, const EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState) +{ + OutMotionControllerState.bValid = false; + + const EControllerHand Hand = IsRight() ? EControllerHand::Right : EControllerHand::Left; + const bool bGotMotionControllerState = + FSGXRTracker::GetMotionControllerState( + this, XRSpaceType, Hand, XRControllerPoseType, OutMotionControllerState); + if (!bGotMotionControllerState || !OutMotionControllerState.bValid) + { + return false; + } + + return OutMotionControllerState.bValid; +} + +bool USGVirtualHandComponent::GetHandTrackingState( + const EXRSpaceType XRSpaceType, + FXRHandTrackingState& OutHandTrackingState) +{ + OutHandTrackingState.bValid = false; + + const EControllerHand Hand = IsRight() ? EControllerHand::Right : EControllerHand::Left; + const bool bGotHandTrackingState = + FSGXRTracker::GetHandTrackingState( + this, XRSpaceType, Hand, OutHandTrackingState); + if (!bGotHandTrackingState || !OutHandTrackingState.bValid) + { + return false; + } + + return OutHandTrackingState.bValid; +} + +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + const TArray& USGVirtualHandComponent::GetHandBoneNames() const { const TArray& Names{ @@ -747,12 +803,25 @@ void USGVirtualHandComponent::FImpl::SetVisibility(const bool bInVisible) void USGVirtualHandComponent::FImpl::UpdateVisibility() { +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + FXRHandTrackingState HandTrackingState; + const bool bGotHandTrackingState = + Owner->GetHandTrackingState(EXRSpaceType::UnrealWorldSpace, HandTrackingState); +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ FXRMotionControllerData MotionControllerData; const bool bGotMotionControllerData = Owner->GetMotionControllerData(MotionControllerData); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + const bool bHandDataAvailable = +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + bGotHandTrackingState + && HandTrackingState.bValid +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ bGotMotionControllerData && MotionControllerData.bValid - && MotionControllerData.DeviceVisualType == EXRVisualType::Hand; + && MotionControllerData.DeviceVisualType == EXRVisualType::Hand +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + ; const bool bHandVisible = Owner->IsVisible(); const bool bShouldBeVisibleWhenHandDataUnavailable = Owner->GetVirtualHandSettings().bVisibleWhenHandDataUnavailable; @@ -811,6 +880,16 @@ void USGVirtualHandComponent::FImpl::DrawDebugVirtualHand() const return; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + FXRHandTrackingState HandTrackingState; + const bool bGotHandTrackingState = Owner->GetHandTrackingState(EXRSpaceType::UnrealWorldSpace, HandTrackingState); + if (!bGotHandTrackingState || !HandTrackingState.bValid) + { + return; + } + + FSGDebugVirtualHand::Draw(World, HandTrackingState, Owner->GetVirtualHandSettings().DebuggingSettings); +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ FXRMotionControllerData MotionControllerData; const bool bGotMotionControllerData = Owner->GetMotionControllerData(MotionControllerData); if (!bGotMotionControllerData || !MotionControllerData.bValid) @@ -819,6 +898,7 @@ void USGVirtualHandComponent::FImpl::DrawDebugVirtualHand() const } FSGDebugVirtualHand::Draw(World, MotionControllerData, Owner->GetVirtualHandSettings().DebuggingSettings); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ } void USGVirtualHandComponent::FImpl::TriggerHandVisibilityChangedEvent(const bool bNewVisibility) const diff --git a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGWristTrackerComponent.cpp b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGWristTrackerComponent.cpp index ee09713..863fcb2 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGWristTrackerComponent.cpp +++ b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGlove/Components/SGWristTrackerComponent.cpp @@ -246,8 +246,11 @@ bool USGWristTrackerComponent::GetMotionControllerData(FXRMotionControllerData& OutMotionControllerData.bValid = false; const EControllerHand Hand = IsRight() ? EControllerHand::Right : EControllerHand::Left; + PRAGMA_DISABLE_DEPRECATION_WARNINGS const bool bGotMotionControllerData = FSGXRTracker::GetMotionControllerData(this, Hand, OutMotionControllerData); + PRAGMA_ENABLE_DEPRECATION_WARNINGS + if (!bGotMotionControllerData || !OutMotionControllerData.bValid) { return false; @@ -256,6 +259,46 @@ bool USGWristTrackerComponent::GetMotionControllerData(FXRMotionControllerData& return OutMotionControllerData.bValid; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + +bool USGWristTrackerComponent::GetMotionControllerState( + const EXRSpaceType XRSpaceType, const EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState) +{ + OutMotionControllerState.bValid = false; + + const EControllerHand Hand = IsRight() ? EControllerHand::Right : EControllerHand::Left; + const bool bGotMotionControllerState = + FSGXRTracker::GetMotionControllerState( + this, XRSpaceType, Hand, XRControllerPoseType, OutMotionControllerState); + if (!bGotMotionControllerState || !OutMotionControllerState.bValid) + { + return false; + } + + return OutMotionControllerState.bValid; +} + +bool USGWristTrackerComponent::GetHandTrackingState( + const EXRSpaceType XRSpaceType, + FXRHandTrackingState& OutHandTrackingState) +{ + OutHandTrackingState.bValid = false; + + const EControllerHand Hand = IsRight() ? EControllerHand::Right : EControllerHand::Left; + const bool bGotHandTrackingState = + FSGXRTracker::GetHandTrackingState( + this, XRSpaceType, Hand, OutHandTrackingState); + if (!bGotHandTrackingState || !OutHandTrackingState.bValid) + { + return false; + } + + return OutHandTrackingState.bValid; +} + +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + USGWristTrackerComponent::FImpl::FImpl(USGWristTrackerComponent* InOwner) : bOverridePluginSettingsPropertyAlreadyModified(false), Owner(InOwner) diff --git a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGloveModule.h b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGloveModule.h index 186b0a8..f458e46 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGloveModule.h +++ b/Plugins/SenseGlove/Source/SenseGlove/Private/SenseGloveModule.h @@ -33,8 +33,6 @@ */ -// Copyright Epic Games, Inc. All Rights Reserved. - #pragma once #include "Delegates/IDelegateInstance.h" diff --git a/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.h b/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.h index 2dd9760..0826a47 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.h +++ b/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Animation/SGVirtualHandAnimInstanceProxy.h @@ -40,6 +40,7 @@ #include "HeadMountedDisplayTypes.h" #include "Math/Quat.h" #include "Math/Transform.h" +#include "Runtime/Launch/Resources/Version.h" #include "Templates/UniquePtr.h" #include "UObject/NameTypes.h" @@ -67,7 +68,12 @@ private: bool bVirtualHandVisible; bool bMarkRenderStateDirty; +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + FXRHandTrackingState HandTrackingState; +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ FXRMotionControllerData MotionControllerData; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + TMap::SizeType, FName> BoneNamesMap; FTransform AnimationBoneCorrectionOffsetTransform; @@ -103,10 +109,17 @@ protected: return bMarkRenderStateDirty; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + FORCEINLINE const FXRHandTrackingState& GetHandTrackingState() const + { + return HandTrackingState; + } +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ FORCEINLINE const FXRMotionControllerData& GetMotionControllerData() const { return MotionControllerData; } +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ FORCEINLINE const TMap::SizeType, FName>& GetBoneNamesMap() const { diff --git a/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGVirtualHandComponent.h b/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGVirtualHandComponent.h index c0819df..2c11b6a 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGVirtualHandComponent.h +++ b/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGVirtualHandComponent.h @@ -44,6 +44,7 @@ #include "Math/Transform.h" #include "Misc/AssertionMacros.h" #include "ReferenceSkeleton.h" +#include "Runtime/Launch/Resources/Version.h" #include "Templates/UniquePtr.h" #include "UObject/NameTypes.h" @@ -145,7 +146,11 @@ public: } public: +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + virtual void SetAnimInstanceClass(class UClass* NewClass) override; +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ virtual void SetAnimClass(class UClass* NewClass) override; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ virtual void PostInitProperties() override; @@ -175,8 +180,19 @@ protected: public: bool IsGloveConnected() const; USGHapticGlove* GetConnectedGlove() const; + + UE_DEPRECATED(5.5, "Deprecated by UE 5.5 in favor of GetMotionControllerState and GetHandTrackingState") bool GetMotionControllerData(FXRMotionControllerData& OutMotionControllerData); +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + bool GetMotionControllerState( + EXRSpaceType XRSpaceType, EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState); + bool GetHandTrackingState( + EXRSpaceType XRSpaceType, + FXRHandTrackingState& OutHandTrackingState); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + public: const TArray& GetHandBoneNames() const; const FName& GetHandBoneName(int32 Joint) const; diff --git a/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGWristTrackerComponent.h b/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGWristTrackerComponent.h index 3ad5ee5..fc5e0eb 100644 --- a/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGWristTrackerComponent.h +++ b/Plugins/SenseGlove/Source/SenseGlove/Public/SenseGlove/Components/SGWristTrackerComponent.h @@ -40,6 +40,7 @@ #include "Math/Rotator.h" #include "Math/Vector.h" #include "MotionControllerComponent.h" +#include "Runtime/Launch/Resources/Version.h" #include "Templates/UniquePtr.h" #include "SGSettings/SGWristTrackingSettings.h" @@ -164,5 +165,15 @@ protected: FActorComponentTickFunction* ThisTickFunction); public: + UE_DEPRECATED(5.5, "Deprecated by UE 5.5 in favor of GetMotionControllerState and GetHandTrackingState") bool GetMotionControllerData(FXRMotionControllerData& OutMotionControllerData); + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + bool GetMotionControllerState( + EXRSpaceType XRSpaceType, EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState); + bool GetHandTrackingState( + EXRSpaceType XRSpaceType, + FXRHandTrackingState& OutHandTrackingState); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ }; \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SGAndroid/SGAndroidPermissions.cpp b/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SGAndroid/SGAndroidPermissions.cpp new file mode 100644 index 0000000..6138a5d --- /dev/null +++ b/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SGAndroid/SGAndroidPermissions.cpp @@ -0,0 +1,190 @@ +/** + * @file + * + * @author Mamadou Babaei + * + * @section LICENSE + * + * (The MIT License) + * + * Copyright (c) 2020 - 2024 SenseGlove + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * + * @section DESCRIPTION + * + * + */ + + +#include "SGAndroid/SGAndroidPermissions.h" + +#include "AndroidPermissionCallbackProxy.h" +#include "AndroidPermissionFunctionLibrary.h" +#include "Engine/Engine.h" + +#include "SGLog/SGLog.h" + +struct USGAndroidPermissions::FImpl +{ + /************************ + * Member variables + ************************/ + + TFunction&, const TArray&)> PermissionsGrantedCallback; + + /************************ + * Owner object + ************************/ + + USGAndroidPermissions* Owner; + + /************************ + * Constructor / Destructor + ************************/ + + explicit FImpl(USGAndroidPermissions* InOwner); + ~FImpl(); + + /************************ + * Default copy constructor & copy assignment operator + ************************/ + + FImpl(const FImpl& Rhs) = default; + FImpl& operator=(const FImpl& Rhs) = default; +}; + +USGAndroidPermissions* USGAndroidPermissions::GetInstance() +{ + if (!ensureAlwaysMsgf(GEngine, TEXT("The engine has not been initialized!"))) + { + return nullptr; + } + + USGAndroidPermissions* Instance{GEngine->GetEngineSubsystem()}; + return Instance; +} + +USGAndroidPermissions::USGAndroidPermissions() + : Pimpl(TUniquePtr(new FImpl{this}, PimplDeleter)) +{ +} + +void USGAndroidPermissions::Request( + const TFunction&, const TArray&)>& PermissionsGrantedCallback) +{ + TArray Permissions{ + "android.permission.ACCESS_BACKGROUND_LOCATION", + "android.permission.ACCESS_FINE_LOCATION", + "android.permission.BLUETOOTH", + "android.permission.BLUETOOTH_ADMIN", + "android.permission.BLUETOOTH_ADVERTISE", + "android.permission.BLUETOOTH_CONNECT", + "android.permission.BLUETOOTH_SCAN", + }; + + bool bHasAllRequiredPermissions = false; + for (const FString& Permission: Permissions) + { + const bool bHasPermission = UAndroidPermissionFunctionLibrary::CheckPermission(Permission); + bHasAllRequiredPermissions = bHasPermission; + if (!bHasAllRequiredPermissions) + { + break; + } + } + + if (!bHasAllRequiredPermissions) + { + Pimpl->PermissionsGrantedCallback = PermissionsGrantedCallback; + + UAndroidPermissionFunctionLibrary::AcquirePermissions( + MoveTemp(Permissions))->OnPermissionsGrantedDelegate.AddUObject( + this, &USGAndroidPermissions::OnPermissionsGranted); + } + else + { + TArray GrantedResults; + for (int32 i = 0; i < Permissions.Num(); ++i) + { + GrantedResults.Add(true); + } + PermissionsGrantedCallback(MoveTemp(Permissions), MoveTemp(GrantedResults)); + } +} + +void USGAndroidPermissions::OnPermissionsGranted(const TArray& Permissions, const TArray& GrantResults) +{ + if (!ensureAlwaysMsgf(Permissions.Num() == GrantResults.Num(), + TEXT("Mismatched number of Permissions and GrantedResults!"))) + { + return; + } + + for (int32 i = 0; i < Permissions.Num(); i++) + { + if (GrantResults[i]) + { + SGLOG("Permission Granted", Permissions[i]); + } + else + { + SGLOG("Permission Denied", Permissions[i]); + } + } + + Pimpl->PermissionsGrantedCallback(Permissions, GrantResults); +} + +bool USGAndroidPermissions::ShouldCreateSubsystem(UObject* Outer) const +{ + return true; +} + +void USGAndroidPermissions::Initialize(FSubsystemCollectionBase& Collection) +{ + SGLOG("Initializing the SenseGlove Android permissions singleton with the engine lifetime..."); + + Super::Initialize(Collection); + + SGLOG("The SenseGlove Android permissions singleton has been successfully initialized with the engine lifetime!"); +} + +void USGAndroidPermissions::Deinitialize() +{ + SGLOG("De-initializing the SenseGlove Android permissions singleton due to the engine lifetime expiration..."); + + Super::Deinitialize(); + + (void) Pimpl.Release(); + + SGLOG("The SenseGlove Android permissions singleton has been successfully de-initialized!"); +} + +USGAndroidPermissions::FImpl::FImpl(USGAndroidPermissions* InOwner) + : Owner(InOwner) +{ +} + +USGAndroidPermissions::FImpl::~FImpl() = default; + +void USGAndroidPermissions::FImplDeleter::operator()(const FImpl* P) const +{ + delete P; +} \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.cpp b/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.cpp index c481f0a..691fbab 100644 --- a/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.cpp @@ -35,6 +35,9 @@ #include "SenseGloveAndroidModule.h" +#include "Misc/CoreDelegates.h" + +#include "SGAndroid/SGAndroidPermissions.h" #include "SGAndroid/SGConnectJNI.h" #include "SGAndroid/SGCoreJNI.h" #include "SGLog/SGLog.h" @@ -45,16 +48,8 @@ void FSenseGloveAndroidModule::StartupModule() { SGLOG("Starting up the SenseGloveAndroid module..."); -#if PLATFORM_ANDROID - const int32 R1 = FSGConnectJNI::Initialize(); - const int32 R2 = FSGCoreJNI::Initialize(); - - ensureAlwaysMsgf(R1 == 0, - TEXT("Failed to initialize the SGConnect JNI bridge to SGConnect for Android! Status Code: %d"), R1); - - ensureAlwaysMsgf(R2 == 0, - TEXT("Failed to initialize the SGCore JNI bridge to SGConnect for Android! Status Code: %d"), R2); -#endif /* PLATFORM_ANDROID */ + OnPostEngineInitHandle = FCoreDelegates::OnPostEngineInit.AddRaw( + this, &FSenseGloveAndroidModule::OnPostEngineInit); } void FSenseGloveAndroidModule::PreUnloadCallback() @@ -72,4 +67,26 @@ void FSenseGloveAndroidModule::ShutdownModule() SGLOG("Shutting down the SenseGloveAndroid module..."); } +void FSenseGloveAndroidModule::OnPostEngineInit() const +{ +#if PLATFORM_ANDROID + USGAndroidPermissions::GetInstance()->Request( + [](const TArray& Permissions, const TArray& GrantResults) + { + const int32 R1 = FSGConnectJNI::Initialize(); + const int32 R2 = FSGCoreJNI::Initialize(); + + ensureAlwaysMsgf(R1 == 0, + TEXT( + "Failed to initialize the SGConnect JNI bridge to SGConnect for Android! Status Code: %d" + ), R1); + + ensureAlwaysMsgf(R2 == 0, + TEXT("Failed to initialize the SGCore JNI bridge to SGConnect for Android! Status Code: %d" + ), R2); + + }); +#endif /* PLATFORM_ANDROID */ +} + #undef LOCTEXT_NAMESPACE \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.h b/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.h index af62a29..b22a0a1 100644 --- a/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.h +++ b/Plugins/SenseGlove/Source/SenseGloveAndroid/Private/SenseGloveAndroidModule.h @@ -35,17 +35,24 @@ #pragma once +#include "Delegates/IDelegateInstance.h" #include "Modules/ModuleInterface.h" #define LOCTEXT_NAMESPACE "SenseGloveAndroid" class FSenseGloveAndroidModule : public IModuleInterface { +private: + FDelegateHandle OnPostEngineInitHandle; + public: virtual void StartupModule() override; virtual void PreUnloadCallback() override; virtual void PostLoadCallback() override; virtual void ShutdownModule() override; + +private: + void OnPostEngineInit() const; }; #undef LOCTEXT_NAMESPACE \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveAndroid/Public/SGAndroid/SGAndroidPermissions.h b/Plugins/SenseGlove/Source/SenseGloveAndroid/Public/SGAndroid/SGAndroidPermissions.h new file mode 100644 index 0000000..ad883bc --- /dev/null +++ b/Plugins/SenseGlove/Source/SenseGloveAndroid/Public/SGAndroid/SGAndroidPermissions.h @@ -0,0 +1,82 @@ +/** + * @file + * + * @author Mamadou Babaei + * + * @section LICENSE + * + * (The MIT License) + * + * Copyright (c) 2020 - 2024 SenseGlove + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * + * @section DESCRIPTION + * + * + */ + + +#pragma once + +#include "Containers/Array.h" +#include "Containers/UnrealString.h" +#include "Subsystems/EngineSubsystem.h" +#include "Templates/Function.h" +#include "Templates/SharedPointer.h" +#include "UObject/ObjectMacros.h" + +#include "SGAndroidPermissions.generated.h" + +UCLASS() +class SENSEGLOVEANDROID_API USGAndroidPermissions : public UEngineSubsystem +{ + GENERATED_BODY() + +public: + static USGAndroidPermissions* GetInstance(); + +private: + struct FImpl; + + struct FImplDeleter + { + void operator()(const FImpl* P) const; + }; + + TUniquePtr Pimpl; + FImplDeleter PimplDeleter; + +private: + USGAndroidPermissions(); + +public: + void Request( + const TFunction&, const TArray&)>& PermissionsGrantedCallback); + +private: + void OnPermissionsGranted( + const TArray& Permissions, const TArray& GrantResults); + +public: + virtual bool ShouldCreateSubsystem(UObject* Outer) const override; + + virtual void Initialize(FSubsystemCollectionBase& Collection) override; + virtual void Deinitialize() override; +}; \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid.Build.cs b/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid.Build.cs index 809ab0f..2f27d2a 100644 --- a/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid.Build.cs +++ b/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid.Build.cs @@ -46,6 +46,7 @@ public class SenseGloveAndroid : ModuleRules PrivateDependencyModuleNames.AddRange( new string[] { + "AndroidPermission", "Core", "CoreUObject", "Engine", diff --git a/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid_UPL.xml b/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid_UPL.xml index 72c166c..f8ddd8c 100644 --- a/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid_UPL.xml +++ b/Plugins/SenseGlove/Source/SenseGloveAndroid/SenseGloveAndroid_UPL.xml @@ -116,13 +116,13 @@ + + - - diff --git a/Plugins/SenseGlove/Source/SenseGloveBackend/Public/SGBackend/SGBackend.h b/Plugins/SenseGlove/Source/SenseGloveBackend/Public/SGBackend/SGBackend.h index ec4d59a..179219f 100644 --- a/Plugins/SenseGlove/Source/SenseGloveBackend/Public/SGBackend/SGBackend.h +++ b/Plugins/SenseGlove/Source/SenseGloveBackend/Public/SGBackend/SGBackend.h @@ -44,7 +44,7 @@ #include "SGBackend.generated.h" -UCLASS(config = SenseGloveBackend) +UCLASS() class SENSEGLOVEBACKEND_API USGBackend : public UEngineSubsystem { GENERATED_BODY() @@ -67,7 +67,7 @@ private: TUniquePtr Pimpl; FImplDeleter PimplDeleter; -public: +private: USGBackend(); public: diff --git a/Plugins/SenseGlove/Source/SenseGloveDebug/Private/SGDebug/SGDebugVirtualHand.cpp b/Plugins/SenseGlove/Source/SenseGloveDebug/Private/SGDebug/SGDebugVirtualHand.cpp index 7205d96..8634955 100644 --- a/Plugins/SenseGlove/Source/SenseGloveDebug/Private/SGDebug/SGDebugVirtualHand.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveDebug/Private/SGDebug/SGDebugVirtualHand.cpp @@ -72,4 +72,36 @@ void FSGDebugVirtualHand::Draw(const UWorld* World, FSGDebugGizmo::Draw(World, HandKeyPosition, HandKeyRotation, Settings.DebugGizmoHandSettings); } } -} \ No newline at end of file +} + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 +void FSGDebugVirtualHand::Draw(const UWorld* World, + const FXRHandTrackingState& HandTrackingState, + const FSGVirtualHandDebuggingSettings& Settings) +{ + ensureAlwaysMsgf(Settings.DrawingMode != ESGDebugVirtualHandDrawingMode::None, + TEXT("Invalid virtual hand drawing mode!")); + + ensureAlwaysMsgf(HandTrackingState.bValid, + TEXT("Invalid hand tracking state!")); + + ensureAlwaysMsgf(HandTrackingState.HandKeyLocations.Num() == HandTrackingState.HandKeyRotations.Num(), + TEXT("Mismatched hand tracking state locations and rotations!")); + + for (TArray::SizeType HandKeyIndex = 0; + HandKeyIndex < HandTrackingState.HandKeyLocations.Num(); ++HandKeyIndex) + { + const FVector& HandKeyLocation{HandTrackingState.HandKeyLocations[HandKeyIndex]}; + const FQuat& HandKeyRotation{HandTrackingState.HandKeyRotations[HandKeyIndex]}; + + if (Settings.DrawingMode == ESGDebugVirtualHandDrawingMode::CubicJoints) + { + FSGDebugCube::Draw(World, HandKeyLocation, HandKeyRotation, Settings.DebugCubicHandSettings); + } + else if (Settings.DrawingMode == ESGDebugVirtualHandDrawingMode::GizmoJoints) + { + FSGDebugGizmo::Draw(World, HandKeyLocation, HandKeyRotation, Settings.DebugGizmoHandSettings); + } + } +} +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveDebug/Public/SGDebug/SGDebugVirtualHand.h b/Plugins/SenseGlove/Source/SenseGloveDebug/Public/SGDebug/SGDebugVirtualHand.h index 56abdfa..9b8d181 100644 --- a/Plugins/SenseGlove/Source/SenseGloveDebug/Public/SGDebug/SGDebugVirtualHand.h +++ b/Plugins/SenseGlove/Source/SenseGloveDebug/Public/SGDebug/SGDebugVirtualHand.h @@ -39,6 +39,7 @@ #include "HeadMountedDisplayTypes.h" #include "Math/Rotator.h" #include "Math/Vector.h" +#include "Runtime/Launch/Resources/Version.h" #include "SGSettings/SGVirtualHandDebuggingSettings.h" @@ -47,11 +48,19 @@ class UWorld; class SENSEGLOVEDEBUG_API FSGDebugVirtualHand final { public: + UE_DEPRECATED(5.5, "Deprecated in favor of the variant that accepts FXRHandTrackingState") static void Draw( const UWorld* World, const FXRMotionControllerData& MotionControllerData, const FSGVirtualHandDebuggingSettings& Settings); +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + static void Draw( + const UWorld* World, + const FXRHandTrackingState& HandTrackingState, + const FSGVirtualHandDebuggingSettings& Settings); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + public: FSGDebugVirtualHand() = delete; virtual ~FSGDebugVirtualHand() = delete; diff --git a/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Private/SGDebugKismet/SGDebugVirtualHandKismetLibrary.cpp b/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Private/SGDebugKismet/SGDebugVirtualHandKismetLibrary.cpp index 2f2cb34..8545d14 100644 --- a/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Private/SGDebugKismet/SGDebugVirtualHandKismetLibrary.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Private/SGDebugKismet/SGDebugVirtualHandKismetLibrary.cpp @@ -37,11 +37,24 @@ #include "SGDebug/SGDebugVirtualHand.h" -void USGDebugVirtualHandKismetLibrary::Draw( +void USGDebugVirtualHandKismetLibrary::Draw_FXRMotionControllerData( UObject* WorldContextObject, - const FXRMotionControllerData& MotionControllerData, const FSGVirtualHandDebuggingSettings& Settings) + const FXRMotionControllerData& MotionControllerData, + const FSGVirtualHandDebuggingSettings& Settings) { ensureAlwaysMsgf(WorldContextObject, TEXT("Invalid world context object!")); + PRAGMA_DISABLE_DEPRECATION_WARNINGS FSGDebugVirtualHand::Draw(WorldContextObject->GetWorld(), MotionControllerData, Settings); + PRAGMA_ENABLE_DEPRECATION_WARNINGS +} + +void USGDebugVirtualHandKismetLibrary::Draw_FXRHandTrackingState( + UObject* WorldContextObject, + const FXRHandTrackingState& HandTrackingState, + const FSGVirtualHandDebuggingSettings& Settings) +{ + ensureAlwaysMsgf(WorldContextObject, TEXT("Invalid world context object!")); + + FSGDebugVirtualHand::Draw(WorldContextObject->GetWorld(), HandTrackingState, Settings); } \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Public/SGDebugKismet/SGDebugVirtualHandKismetLibrary.h b/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Public/SGDebugKismet/SGDebugVirtualHandKismetLibrary.h index 03da3f4..ede3c80 100644 --- a/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Public/SGDebugKismet/SGDebugVirtualHandKismetLibrary.h +++ b/Plugins/SenseGlove/Source/SenseGloveDebugKismet/Public/SGDebugKismet/SGDebugVirtualHandKismetLibrary.h @@ -35,8 +35,10 @@ #pragma once +#include "UObject/ObjectMacros.h" +#include "HeadMountedDisplayTypes.h" + #include "SGKismet/SGBlueprintFunctionLibrary.h" -#include "SGDebug/SGDebugVirtualHand.h" #include "SGDebugVirtualHandKismetLibrary.generated.h" @@ -48,10 +50,17 @@ class SENSEGLOVEDEBUGKISMET_API USGDebugVirtualHandKismetLibrary final : public GENERATED_BODY() public: - UFUNCTION(BlueprintCallable, Category="SenseGlove | Debug | Virtual Hand", + UFUNCTION(BlueprintCallable, DisplayName="Draw", Category="SenseGlove | Debug | Virtual Hand", meta=(WorldContext="WorldContextObject")) - static void Draw( + static void Draw_FXRMotionControllerData( UObject* WorldContextObject, const FXRMotionControllerData& MotionControllerData, const FSGVirtualHandDebuggingSettings& Settings); + + UFUNCTION(BlueprintCallable, DisplayName="Draw", Category="SenseGlove | Debug | Virtual Hand", + meta=(WorldContext="WorldContextObject")) + static void Draw_FXRHandTrackingState( + UObject* WorldContextObject, + const FXRHandTrackingState& HandTrackingState, + const FSGVirtualHandDebuggingSettings& Settings); }; \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGVirtualHandComponentKismetLibrary.cpp b/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGVirtualHandComponentKismetLibrary.cpp index 2ffceb9..49c9987 100644 --- a/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGVirtualHandComponentKismetLibrary.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGVirtualHandComponentKismetLibrary.cpp @@ -113,7 +113,23 @@ USGHapticGlove* UVirtualHandComponentKismetLibrary::GetConnectedGlove( bool UVirtualHandComponentKismetLibrary::GetMotionControllerData( USGVirtualHandComponent* VirtualHandComponent, FXRMotionControllerData& OutMotionControllerData) { + PRAGMA_DISABLE_DEPRECATION_WARNINGS return VirtualHandComponent->GetMotionControllerData(OutMotionControllerData); + PRAGMA_ENABLE_DEPRECATION_WARNINGS +} + +bool UVirtualHandComponentKismetLibrary::GetMotionControllerState(USGVirtualHandComponent* VirtualHandComponent, + const EXRSpaceType XRSpaceType, const EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState) +{ + return VirtualHandComponent->GetMotionControllerState( + XRSpaceType, XRControllerPoseType, OutMotionControllerState); +} + +bool UVirtualHandComponentKismetLibrary::GetHandTrackingState(USGVirtualHandComponent* VirtualHandComponent, + const EXRSpaceType XRSpaceType, FXRHandTrackingState& OutHandTrackingState) +{ + return VirtualHandComponent->GetHandTrackingState(XRSpaceType, OutHandTrackingState); } const TArray& UVirtualHandComponentKismetLibrary::GetHandBoneNames( diff --git a/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGWristTrackerComponentKismetLibrary.cpp b/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGWristTrackerComponentKismetLibrary.cpp index 0e83ee7..33339ad 100644 --- a/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGWristTrackerComponentKismetLibrary.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveKismet/Private/SGKismet/SGWristTrackerComponentKismetLibrary.cpp @@ -93,5 +93,24 @@ const FRotator& UWristTrackerComponentKismetLibrary::GetWristRotation( bool UWristTrackerComponentKismetLibrary::GetMotionControllerData( USGWristTrackerComponent* WristTrackerComponent, FXRMotionControllerData& OutMotionControllerData) { + PRAGMA_DISABLE_DEPRECATION_WARNINGS return WristTrackerComponent->GetMotionControllerData(OutMotionControllerData); + PRAGMA_ENABLE_DEPRECATION_WARNINGS +} + +bool UWristTrackerComponentKismetLibrary::GetMotionControllerState( + USGWristTrackerComponent* WristTrackerComponent, + const EXRSpaceType XRSpaceType, const EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState) +{ + return WristTrackerComponent->GetMotionControllerState( + XRSpaceType, XRControllerPoseType, OutMotionControllerState); +} + +bool UWristTrackerComponentKismetLibrary::GetHandTrackingState( + USGWristTrackerComponent* WristTrackerComponent, + const EXRSpaceType XRSpaceType, FXRHandTrackingState& OutHandTrackingState) +{ + return WristTrackerComponent->GetHandTrackingState( + XRSpaceType, OutHandTrackingState); } \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGVirtualHandComponentKismetLibrary.h b/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGVirtualHandComponentKismetLibrary.h index 6906c19..f83d706 100644 --- a/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGVirtualHandComponentKismetLibrary.h +++ b/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGVirtualHandComponentKismetLibrary.h @@ -106,6 +106,16 @@ public: static bool GetMotionControllerData(UPARAM(ref) USGVirtualHandComponent* VirtualHandComponent, FXRMotionControllerData& OutMotionControllerData); + UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Virtual Hand Component") + static bool GetMotionControllerState(UPARAM(ref) USGVirtualHandComponent* VirtualHandComponent, + EXRSpaceType XRSpaceType, EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState); + + UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Virtual Hand Component") + static bool GetHandTrackingState(UPARAM(ref) USGVirtualHandComponent* VirtualHandComponent, + EXRSpaceType XRSpaceType, + FXRHandTrackingState& OutHandTrackingState); + UFUNCTION(BlueprintPure, Category="SenseGlove | Components | Virtual Hand Component") static const TArray& GetHandBoneNames(const USGVirtualHandComponent* VirtualHandComponent); diff --git a/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGWristTrackerComponentKismetLibrary.h b/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGWristTrackerComponentKismetLibrary.h index 91b3e82..e2540b7 100644 --- a/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGWristTrackerComponentKismetLibrary.h +++ b/Plugins/SenseGlove/Source/SenseGloveKismet/Public/SGKismet/SGWristTrackerComponentKismetLibrary.h @@ -86,4 +86,14 @@ public: UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component") static bool GetMotionControllerData(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent, FXRMotionControllerData& OutMotionControllerData); + + UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component") + static bool GetMotionControllerState(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent, + EXRSpaceType XRSpaceType, EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState); + + UFUNCTION(BlueprintCallable, Category="SenseGlove | Components | Wrist Tracker Component") + static bool GetHandTrackingState(UPARAM(ref) USGWristTrackerComponent* WristTrackerComponent, + EXRSpaceType XRSpaceType, + FXRHandTrackingState& OutHandTrackingState); }; \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveSettings/Public/SGSettings/SGGloveTrackingSettings.h b/Plugins/SenseGlove/Source/SenseGloveSettings/Public/SGSettings/SGGloveTrackingSettings.h index 914b4d8..a68d1dc 100644 --- a/Plugins/SenseGlove/Source/SenseGloveSettings/Public/SGSettings/SGGloveTrackingSettings.h +++ b/Plugins/SenseGlove/Source/SenseGloveSettings/Public/SGSettings/SGGloveTrackingSettings.h @@ -51,7 +51,7 @@ struct SENSEGLOVESETTINGS_API FSGGloveTrackingSettings public: /** - * The interval in which the tracking module checks for glove connectivity. + * The interval in which the tracking module checks for glove connectivity (in milliseconds). * * The default is 16.666666f which means 60 times per second. */ diff --git a/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGGloveTracker.cpp b/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGGloveTracker.cpp index 421f815..c32ca06 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGGloveTracker.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGGloveTracker.cpp @@ -58,7 +58,7 @@ struct USGGloveTracker::FImpl { const USGSettings* Settings{USGSettings::GetInstance()}; ensureAlwaysMsgf(Settings, TEXT("The settings subsystem has not been initialized!")); - return Settings->GetTrackingSettings().GloveTrackingSettings.GloveConnectivityCheckInterval; + return Settings->GetTrackingSettings().GloveTrackingSettings.GloveConnectivityCheckInterval * 0.001f; } /************************ @@ -137,7 +137,16 @@ void USGGloveTracker::Initialize(FSubsystemCollectionBase& Collection) Pimpl->GloveConnectivityCheckTimer, GloveConnectivityCheckHandler, GloveConnectivityCheckInterval, true, -1.0f); - SGLOG("The glove connectivity check timer has been started successfully!"); + if (ensureAlwaysMsgf(TimerManager.IsTimerActive(Pimpl->GloveConnectivityCheckTimer), + TEXT("GloveConnectivityCheckTimer is not active"))) + { + SGLOG("The glove connectivity check timer has been started successfully!"); + SGLOG("The glove connectivity timer interval is: ", GloveConnectivityCheckInterval); + } + else + { + SGLOG_ERROR("The glove connectivity check timer has failed to start!"); + } } SGLOG("The SenseGlove tracking singleton has been successfully initialized with the world lifetime!"); diff --git a/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRHandState.cpp b/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRHandState.cpp index 037f57b..a9ad0aa 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRHandState.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRHandState.cpp @@ -43,7 +43,8 @@ FSGXRHandState::FSGXRHandState() Locations{XR_TYPE_HAND_JOINT_LOCATIONS_EXT}, KeypointTransforms{}, Radii{}, - bReceivedJointPoses(false) + bHasReceivedJointPoses(false), + bTracked(false) { Velocities.jointCount = XR_HAND_JOINT_COUNT_EXT; Velocities.jointVelocities = JointVelocities; @@ -60,7 +61,7 @@ bool FSGXRHandState::GetTransform(const EHandKeypoint Keypoint, FTransform& OutT check(static_cast(Keypoint) < EHandKeypointCount); OutTransform = KeypointTransforms[static_cast(Keypoint)]; - return bReceivedJointPoses; + return bHasReceivedJointPoses; } const FTransform& FSGXRHandState::GetTransform(const EHandKeypoint Keypoint) const diff --git a/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRTracker.cpp b/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRTracker.cpp index 1c73246..6106994 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRTracker.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveTracking/Private/SGTracking/SGXRTracker.cpp @@ -998,7 +998,9 @@ FTransform FSGXRTracker::FImpl::GetMeshFingerStartBoneRefTransform( } bool FSGXRTracker::GetMotionControllerData( - UObject* WorldContextObject, const EControllerHand Hand, FXRMotionControllerData& OutMotionControllerData) + UObject* WorldContextObject, + const EControllerHand Hand, + FXRMotionControllerData& OutMotionControllerData) { OutMotionControllerData.DeviceName = NAME_None; OutMotionControllerData.ApplicationInstanceID = FApp::GetInstanceId(); @@ -1163,16 +1165,14 @@ bool FSGXRTracker::GetMotionControllerData( { OutMotionControllerData.DeviceVisualType = EXRVisualType::Hand; - /// TODO - // This is a just a temporary workaround to silence a UE 5.5 deprecation warning. - // Should be refactored with a proper implementation when migrating away from the deprecated - // `FXRMotionControllerData` in favor of newly introduced - // `FXRMotionControllerState` and `FXRHandTrackingState` structs. #if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 bool bTracked = false; #endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + OutMotionControllerData.bValid = HandTracker->GetAllKeypointStates( - Hand, OutMotionControllerData.HandKeyPositions, OutMotionControllerData.HandKeyRotations, + Hand, + OutMotionControllerData.HandKeyPositions, + OutMotionControllerData.HandKeyRotations, OutMotionControllerData.HandKeyRadii #if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 , bTracked @@ -1180,10 +1180,25 @@ bool FSGXRTracker::GetMotionControllerData( ); #if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 - if (!bTracked) + // Unused! + (void) bTracked; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + // TODO + // Begin backward compatibility with the deprecated function, remove this block along with the deprecated + // GetAllKeypointStates (though it should be time to remove this entire function as well)! + if (!OutMotionControllerData.bValid) { - return false; + PRAGMA_DISABLE_DEPRECATION_WARNINGS + OutMotionControllerData.bValid = HandTracker->GetAllKeypointStates( + Hand, + OutMotionControllerData.HandKeyPositions, + OutMotionControllerData.HandKeyRotations, + OutMotionControllerData.HandKeyRadii); + PRAGMA_ENABLE_DEPRECATION_WARNINGS } + // End backward compability. #endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ if (!ensureAlwaysMsgf( @@ -1204,13 +1219,293 @@ bool FSGXRTracker::GetMotionControllerData( OutMotionControllerData.TrackingStatus = ETrackingStatus::Tracked; } - /// TODO - // This is reportedly a WMR-specific convenience function for rapid prototyping. Not sure if it's useful for OpenXR. - OutMotionControllerData.bIsGrasped = false; - return OutMotionControllerData.bValid; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + +bool FSGXRTracker::GetMotionControllerState( + UObject* WorldContextObject, + const EXRSpaceType XRSpaceType, const EControllerHand Hand, const EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState) +{ + auto ToMotionSourceName = []( + const EControllerHand Hand, const EXRControllerPoseType XRControllerPoseType) -> FLazyName + { + static FLazyName LeftAim = "LeftAim"; + static FLazyName LeftGrip = "LeftGrip"; + static FLazyName LeftPalm = "LeftPalm"; + static FLazyName RightAim = "RightAim"; + static FLazyName RightGrip = "RightGrip"; + static FLazyName RightPalm = "RightPalm"; + if (Hand == EControllerHand::Left) + { + switch (XRControllerPoseType) + { + case EXRControllerPoseType::Aim: + return LeftAim; + case EXRControllerPoseType::Grip: + return LeftGrip; + case EXRControllerPoseType::Palm: + return LeftPalm; + default: + check(false); + return LeftGrip; + } + } + else + { + switch (XRControllerPoseType) + { + case EXRControllerPoseType::Aim: + return RightAim; + case EXRControllerPoseType::Grip: + return RightGrip; + case EXRControllerPoseType::Palm: + return RightPalm; + default: + check(false); + return RightGrip; + } + } + }; + + OutMotionControllerState.DeviceName = NAME_None; + OutMotionControllerState.ApplicationInstanceID = FApp::GetInstanceId(); + OutMotionControllerState.TrackingStatus = ETrackingStatus::NotTracked; + OutMotionControllerState.Hand = Hand; + OutMotionControllerState.XRSpaceType = XRSpaceType; + OutMotionControllerState.bValid = false; + + if (!IsValid(WorldContextObject)) + { + return false; + } + + if (!IsValid(WorldContextObject)) + { + return false; + } + + IXRTrackingSystem* XRTrackingSystem{GEngine ? GEngine->XRSystem.Get() : nullptr}; + if (!XRTrackingSystem) + { + return false; + } + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 4 + IOpenXRHMD* OpenXRHMD{XRTrackingSystem->GetIOpenXRHMD()}; +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 4 */ + FOpenXRHMD* OpenXRHMD{static_cast(GEngine->XRSystem.Get())}; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 4 */ + if (!OpenXRHMD) + { + return false; + } + + TArray Devices; + const int32 HandIndex = static_cast(Hand); + const bool bGotDevices = + XRTrackingSystem->EnumerateTrackedDevices(Devices, EXRTrackedDeviceType::Controller); + if (bGotDevices && Devices.IsValidIndex(HandIndex)) + { + const XrSession Session{OpenXRHMD->GetSession()}; + if (Session) + { + XrInteractionProfileState Profile = {XR_TYPE_INTERACTION_PROFILE_STATE}; + const XrPath TopLevelUserPath{OpenXRHMD->GetTrackedDevicePath(Devices[HandIndex])}; + const XrResult CurrentInteractionProfile{ + xrGetCurrentInteractionProfile(Session, TopLevelUserPath, &Profile) + }; + if (XR_SUCCEEDED(CurrentInteractionProfile) && Profile.interactionProfile != XR_NULL_PATH) + { + OutMotionControllerState.DeviceName = FOpenXRPath(Profile.interactionProfile); + } + } + } + + if ((Hand == EControllerHand::Left) || (Hand == EControllerHand::Right)) + { + static const FName MotionControllerName("OpenXR"); + TArray MotionControllers{ + IModularFeatures::Get().GetModularFeatureImplementations( + IMotionController::GetModularFeatureName()) + }; + IMotionController* MotionController{nullptr}; + for (IMotionController* MotionControllerIterator: MotionControllers) + { + if (!MotionControllerIterator) + { + continue; + } + + const FName DeviceTypeName{MotionControllerIterator->GetMotionControllerDeviceTypeName()}; + if (DeviceTypeName != MotionControllerName) + { + continue; + } + + MotionController = MotionControllerIterator; + break; + } + + if (MotionController) + { + { + // Handle the pose that is actually being requested. + + const FName MotionSource{ToMotionSourceName(Hand, XRControllerPoseType)}; + const FTransform TrackingToWorld{ + XRSpaceType == EXRSpaceType::UnrealWorldSpace + ? XRTrackingSystem->GetTrackingToWorldTransform() + : FTransform::Identity + }; + const float WorldToMeters = XRSpaceType == EXRSpaceType::UnrealWorldSpace + ? XRTrackingSystem->GetWorldToMetersScale() + : 100.0f; + + FVector Position{FVector::ZeroVector}; + FRotator Rotation{FRotator::ZeroRotator}; + + bool bGotMotionControllerOrientationAndPosition = MotionController->GetControllerOrientationAndPosition( + 0, MotionSource, Rotation, Position, WorldToMeters); + + if (bGotMotionControllerOrientationAndPosition) + { + OutMotionControllerState.ControllerLocation = TrackingToWorld.TransformPosition(Position); + OutMotionControllerState.ControllerRotation = TrackingToWorld.TransformRotation(FQuat{Rotation}); + } + + OutMotionControllerState.bValid |= bGotMotionControllerOrientationAndPosition; + OutMotionControllerState.TrackingStatus = + MotionController->GetControllerTrackingStatus(0, MotionSource); + } + + { + // We always provide the grip transform in Unreal space for XRVisualizationFunctionLibrary; + // The bValid and TrackingStatus above are also valid for this pose. + + const FName MotionSource = ToMotionSourceName(Hand, EXRControllerPoseType::Grip); + const FTransform TrackingToWorld{XRTrackingSystem->GetTrackingToWorldTransform()}; + const float WorldToMeters = XRTrackingSystem->GetWorldToMetersScale(); + + FVector Position = FVector::ZeroVector; + FRotator Rotation = FRotator::ZeroRotator; + + bool bGotMotionControllerOrientationAndPosition = MotionController->GetControllerOrientationAndPosition( + 0, MotionSource, Rotation, Position, WorldToMeters); + + if (bGotMotionControllerOrientationAndPosition) + { + OutMotionControllerState.GripUnrealSpaceLocation = TrackingToWorld.TransformPosition(Position); + OutMotionControllerState.GripUnrealSpaceRotation = + TrackingToWorld.TransformRotation(FQuat(Rotation)); + } + } + } + } + + return OutMotionControllerState.bValid; +} + +bool FSGXRTracker::GetHandTrackingState( + UObject* WorldContextObject, + const EXRSpaceType XRSpaceType, const EControllerHand Hand, + FXRHandTrackingState& OutHandTrackingState) +{ + OutHandTrackingState.ApplicationInstanceID = FApp::GetInstanceId(); + OutHandTrackingState.TrackingStatus = ETrackingStatus::NotTracked; + OutHandTrackingState.Hand = Hand; + OutHandTrackingState.XRSpaceType = XRSpaceType; + OutHandTrackingState.bValid = false; + + if (!IsValid(WorldContextObject)) + { + return false; + } + + IXRTrackingSystem* XRTrackingSystem{GEngine ? GEngine->XRSystem.Get() : nullptr}; + if (!XRTrackingSystem) + { + return false; + } + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 4 + IOpenXRHMD* OpenXRHMD{XRTrackingSystem->GetIOpenXRHMD()}; +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 4 */ + FOpenXRHMD* OpenXRHMD{static_cast(GEngine->XRSystem.Get())}; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 4 */ + if (!OpenXRHMD) + { + return false; + } + + FName HandTrackerName("OpenXRHandTracking"); + TArray HandTrackers = IModularFeatures::Get().GetModularFeatureImplementations( + IHandTracker::GetModularFeatureName()); + IHandTracker* HandTracker = nullptr; + for (auto Itr: HandTrackers) + { + if (Itr->GetHandTrackerDeviceTypeName() == HandTrackerName) + { + HandTracker = Itr; + break; + } + } + + if ((Hand == EControllerHand::Left) || (Hand == EControllerHand::Right)) + { + const bool bHandTrackingStateValid = HandTracker && HandTracker->IsHandTrackingStateValid(); + if (bHandTrackingStateValid) + { + bool bTracked = false; + OutHandTrackingState.bValid = HandTracker->GetAllKeypointStates( + Hand, + OutHandTrackingState.HandKeyLocations, + OutHandTrackingState.HandKeyRotations, + OutHandTrackingState.HandKeyRadii, + bTracked); + + /// TODO + // Begin backward compatibility with the deprecated function, remove this block along with the deprecated + // GetAllKeypointStates. + if (!OutHandTrackingState.bValid) + { + PRAGMA_DISABLE_DEPRECATION_WARNINGS + OutHandTrackingState.bValid = HandTracker->GetAllKeypointStates( + Hand, + OutHandTrackingState.HandKeyLocations, + OutHandTrackingState.HandKeyRotations, + OutHandTrackingState.HandKeyRadii); + PRAGMA_ENABLE_DEPRECATION_WARNINGS + bTracked = OutHandTrackingState.bValid; + // The inability to distinguish this is the reason for the deprecation. + } + // End backward compability. + + if (!ensureAlwaysMsgf( + !OutHandTrackingState.bValid + || (OutHandTrackingState.HandKeyLocations.Num() == EHandKeypointCount + && OutHandTrackingState.HandKeyRotations.Num() == EHandKeypointCount + && OutHandTrackingState.HandKeyRadii.Num() == EHandKeypointCount), + TEXT("Corrupted OutHandTrackingState!"))) + { + OutHandTrackingState.bValid = false; + return false; + } + + if (OutHandTrackingState.bValid) + { + OutHandTrackingState.TrackingStatus = bTracked ? ETrackingStatus::Tracked : ETrackingStatus::NotTracked; + } + } + } + + return OutHandTrackingState.bValid; +} + +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ + FSGXRTracker::FSGXRTracker(const TSharedRef& InMessageHandler) : Pimpl(TUniquePtr(new FImpl{this}, PimplDeleter)) { @@ -1480,7 +1775,7 @@ ETrackingStatus FSGXRTracker::GetControllerTrackingStatus(const int32 Controller if (bFallbackToHandTrackingIfNoGloveDetected) { const FSGXRHandState& HandState{bRight ? GetRightHandState() : GetLeftHandState()}; - return HandState.bReceivedJointPoses ? ETrackingStatus::Tracked : ETrackingStatus::NotTracked; + return HandState.bTracked ? ETrackingStatus::Tracked : ETrackingStatus::NotTracked; } return ETrackingStatus::NotTracked; @@ -1606,9 +1901,17 @@ bool FSGXRTracker::GetKeypointState( return bGotTransform; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 +bool FSGXRTracker::GetAllKeypointStates( + const EControllerHand Hand, + TArray& OutPositions, TArray& OutRotations, TArray& OutRadii, + bool& OutIsTracked) const +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ bool FSGXRTracker::GetAllKeypointStates( const EControllerHand Hand, TArray& OutPositions, TArray& OutRotations, TArray& OutRadii) const +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5*/ + { if (!IsHandTrackingStateValid()) { @@ -1629,11 +1932,17 @@ bool FSGXRTracker::GetAllKeypointStates( Hand == EControllerHand::Left ? GetLeftHandState() : GetRightHandState() }; - if (!HandState.bReceivedJointPoses) + if (!HandState.bHasReceivedJointPoses) { return false; } +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + OutIsTracked = HandState.bTracked; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5*/ + + // If we ever received poses we return the last data we received, even if not currently tracking to avoid poping + // back to (0.0f, 0.0f, 0.0f) and the like. OutPositions.Empty(EHandKeypointCount); OutRotations.Empty(EHandKeypointCount); OutRadii.Empty(EHandKeypointCount); @@ -1765,8 +2074,9 @@ bool FSGXRTracker::FImpl::UpdateXRHandTrackingData( XR_ENSURE(XRLocateHandJointsEXT(OutHandState.HandTracker, &LocateInfo, &OutHandState.Locations)); - OutHandState.bReceivedJointPoses = OutHandState.Locations.isActive == XR_TRUE; - if (!OutHandState.bReceivedJointPoses) + OutHandState.bTracked = OutHandState.Locations.isActive == XR_TRUE; + OutHandState.bHasReceivedJointPoses |= HandStates->bTracked; + if (!OutHandState.bTracked) { return false; } @@ -1893,21 +2203,16 @@ bool FSGXRTracker::FImpl::GetControllerTransform( if (!bTracked && bFallbackToHandTrackingIfNoGloveDetected) { const FSGXRHandState& HandState{bRight ? Owner->GetRightHandState() : Owner->GetLeftHandState()}; - if (!HandState.bReceivedJointPoses) + if (!HandState.bHasReceivedJointPoses) { return false; } const EHandKeypoint KeyPoint = KeyPointInfoPtr->Key; - const FTransform& ControllerTransform{ - bRight - ? GetRightHandState().GetTransform(KeyPoint) - : GetLeftHandState().GetTransform(KeyPoint) - }; - + const FTransform& ControllerTransform{HandStates->GetTransform(KeyPoint)}; OutTransform = ControllerTransform; bOutMotionSourceHandTracking = true; - bTracked = true; + bTracked = HandState.bTracked; } return bTracked; @@ -2404,7 +2709,8 @@ bool FSGXRTracker::FImpl::UpdateSGHandState(const bool bRight, FSGXRHandState& O return false; } - OutHandState.bReceivedJointPoses = true; + OutHandState.bHasReceivedJointPoses = true; + OutHandState.bTracked = true; const TArray> JointLocations{HandPose->GetJointPositions()}; const TArray> JointRotations{HandPose->GetJointRotationsQ()}; diff --git a/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRHandState.h b/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRHandState.h index 66378d7..3326d36 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRHandState.h +++ b/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRHandState.h @@ -51,12 +51,16 @@ public: XrHandJointVelocitiesEXT Velocities; XrHandJointLocationsEXT Locations; - // Transforms are cached in Unreal Tracking Space + // Transforms are cached in Unreal Tracking Space. FTransform KeypointTransforms[EHandKeypointCount]; float Radii[EHandKeypointCount]; - bool bReceivedJointPoses; + // true if this hand has ever been tracked, and therefore its poses are valid. + bool bHasReceivedJointPoses; + + // true if tracked right now. + bool bTracked; public: FSGXRHandState(); diff --git a/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRTracker.h b/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRTracker.h index 2cf9319..c35a5f0 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRTracker.h +++ b/Plugins/SenseGlove/Source/SenseGloveTracking/Public/SGTracking/SGXRTracker.h @@ -55,8 +55,22 @@ class SENSEGLOVETRACKING_API FSGXRTracker final : public IOpenXRExtensionPlugin, public IHandTracker { public: - static bool GetMotionControllerData(UObject* WorldContextObject, EControllerHand Hand, - FXRMotionControllerData& OutMotionControllerData); + UE_DEPRECATED(5.5, "Deprecated by UE 5.5 in favor of GetMotionControllerState and GetHandTrackingState") + static bool GetMotionControllerData( + UObject* WorldContextObject, + EControllerHand Hand, + FXRMotionControllerData& OutMotionControllerData); + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + static bool GetMotionControllerState( + UObject* WorldContextObject, + EXRSpaceType XRSpaceType, EControllerHand Hand, EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState); + static bool GetHandTrackingState( + UObject* WorldContextObject, + EXRSpaceType XRSpaceType, EControllerHand Hand, + FXRHandTrackingState& OutHandTrackingState); +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ private: struct FImpl; @@ -158,7 +172,15 @@ public: virtual bool GetKeypointState( EControllerHand Hand, EHandKeypoint Keypoint, FTransform& OutTransform, float& OutRadius) const override; + +#if ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 + virtual bool GetAllKeypointStates( + EControllerHand Hand, + TArray& OutPositions, TArray& OutRotations, TArray& OutRadii, + bool& OutIsTracked) const override; +#else /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ virtual bool GetAllKeypointStates( EControllerHand Hand, TArray& OutPositions, TArray& OutRotations, TArray& OutRadii) const override; +#endif /* ENGINE_MAJOR_VERSION >= 5 && ENGINE_MINOR_VERSION >= 5 */ }; \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Private/SGTrackingKismet/SGXRTrackerKismetLibrary.cpp b/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Private/SGTrackingKismet/SGXRTrackerKismetLibrary.cpp index 138db9f..d98a71c 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Private/SGTrackingKismet/SGXRTrackerKismetLibrary.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Private/SGTrackingKismet/SGXRTrackerKismetLibrary.cpp @@ -42,5 +42,24 @@ bool USGXRTrackerKismetLibrary::GetMotionControllerData( UObject* WorldContextObject, const EControllerHand Hand, FXRMotionControllerData& OutMotionControllerData) { + PRAGMA_DISABLE_DEPRECATION_WARNINGS return FSGXRTracker::GetMotionControllerData(WorldContextObject, Hand, OutMotionControllerData); + PRAGMA_ENABLE_DEPRECATION_WARNINGS +} + +bool USGXRTrackerKismetLibrary::GetMotionControllerState( + UObject* WorldContextObject, + const EXRSpaceType XRSpaceType, const EControllerHand Hand, const EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState) +{ + return FSGXRTracker::GetMotionControllerState( + WorldContextObject, XRSpaceType, Hand, XRControllerPoseType, OutMotionControllerState); +} + +bool USGXRTrackerKismetLibrary::GetHandTrackingState( + UObject* WorldContextObject, + const EXRSpaceType XRSpaceType, const EControllerHand Hand, + FXRHandTrackingState& OutHandTrackingState) +{ + return FSGXRTracker::GetHandTrackingState(WorldContextObject, XRSpaceType, Hand, OutHandTrackingState); } \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Public/SGTrackingKismet/SGXRTrackerKismetLibrary.h b/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Public/SGTrackingKismet/SGXRTrackerKismetLibrary.h index 32a0b0e..b6d5b06 100644 --- a/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Public/SGTrackingKismet/SGXRTrackerKismetLibrary.h +++ b/Plugins/SenseGlove/Source/SenseGloveTrackingKismet/Public/SGTrackingKismet/SGXRTrackerKismetLibrary.h @@ -53,6 +53,22 @@ class SENSEGLOVETRACKINGKISMET_API USGXRTrackerKismetLibrary final : public USGB public: UFUNCTION(BlueprintCallable, Category="SenseGlove | Tracking | XR Tracker", meta=(WorldContext="WorldContextObject")) - static bool GetMotionControllerData(UObject* WorldContextObject, EControllerHand Hand, - FXRMotionControllerData& OutMotionControllerData); -}; + static bool GetMotionControllerData( + UObject* WorldContextObject, + EControllerHand Hand, + FXRMotionControllerData& OutMotionControllerData); + + UFUNCTION(BlueprintCallable, Category="SenseGlove | Tracking | XR Tracker", + meta=(WorldContext="WorldContextObject")) + static bool GetMotionControllerState( + UObject* WorldContextObject, + EXRSpaceType XRSpaceType, EControllerHand Hand, EXRControllerPoseType XRControllerPoseType, + FXRMotionControllerState& OutMotionControllerState); + + UFUNCTION(BlueprintCallable, Category="SenseGlove | Tracking | XR Tracker", + meta=(WorldContext="WorldContextObject")) + static bool GetHandTrackingState( + UObject* WorldContextObject, + EXRSpaceType XRSpaceType, EControllerHand Hand, + FXRHandTrackingState& OutHandTrackingState); +}; \ No newline at end of file diff --git a/Plugins/SenseGlove/Source/SenseGloveUtils/Private/SGUtils/SGEngineUtils.cpp b/Plugins/SenseGlove/Source/SenseGloveUtils/Private/SGUtils/SGEngineUtils.cpp index 1772496..eaa2fed 100644 --- a/Plugins/SenseGlove/Source/SenseGloveUtils/Private/SGUtils/SGEngineUtils.cpp +++ b/Plugins/SenseGlove/Source/SenseGloveUtils/Private/SGUtils/SGEngineUtils.cpp @@ -42,6 +42,7 @@ #include "Engine/Engine.h" #include "Engine/GameViewportClient.h" #include "Engine/World.h" +#include "Runtime/Launch/Resources/Version.h" #include "Subsystems/EngineSubsystem.h" UWorld* FSGEngineUtils::GetWorld() diff --git a/Plugins/SenseGlove/Source/ThirdParty/include/boost/interprocess/smart_ptr/intrusive_ptr.hpp b/Plugins/SenseGlove/Source/ThirdParty/include/boost/interprocess/smart_ptr/intrusive_ptr.hpp old mode 100644 new mode 100755