From 105053e442c9286220866f103c38aa347923b483 Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Sun, 18 Aug 2024 01:44:56 +0200 Subject: [PATCH] fix documentation typos --- Handbook/src/SUMMARY.md | 2 +- Handbook/src/appendix/directory-structure.md | 14 +++++++------- .../appendix/planned-features-completion-status.md | 4 ++-- Handbook/src/overview/README.md | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Handbook/src/SUMMARY.md b/Handbook/src/SUMMARY.md index cca2460a..ad6442a9 100644 --- a/Handbook/src/SUMMARY.md +++ b/Handbook/src/SUMMARY.md @@ -64,7 +64,7 @@ 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 FXRMotionControllerData](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/README.md) - - [Blueprints](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md) + - [Blueprint](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md) - [C++](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md) # 🔌 Low-Level API diff --git a/Handbook/src/appendix/directory-structure.md b/Handbook/src/appendix/directory-structure.md index 29597524..6b2844fb 100644 --- a/Handbook/src/appendix/directory-structure.md +++ b/Handbook/src/appendix/directory-structure.md @@ -19,7 +19,7 @@ │ ├── SenseGloveBackend (responsible for initialization and deinitialization of the backend libraries) │ - ├── SenseGloveBackendKismet (exposes Blueprints-specific functionality from the SenseGloveBackend module) + ├── SenseGloveBackendKismet (exposes Blueprint-specific functionality from the SenseGloveBackend module) │ ├── SenseGloveBuildHacks (uses Exceptions and RTTI, internally used for compiler-specific build hacks) │ @@ -27,33 +27,33 @@ │ ├── SenseGloveConnectImpl (uses Exceptions and RTTI, intended for internal use only) │ - ├── SenseGloveConnectKismet (SGConnect functionality exposed to Blueprints) + ├── SenseGloveConnectKismet (SGConnect functionality exposed to Blueprint) │ ├── SenseGloveCore (exposes part of the SGCoreCpp low-level API to C++) │ ├── SenseGloveCoreImpl (uses Exceptions and RTTI, intended for internal use only) │ - ├── SenseGloveCoreKismet (SGCoreCpp functionality exposed to Blueprints) + ├── SenseGloveCoreKismet (SGCoreCpp functionality exposed to Blueprint) │ ├── SenseGloveDebug (a utility debug module) │ - ├── SenseGloveDebugKismet (exposes Blueprints-specific functionality from the SenseGloveDebug module) + ├── SenseGloveDebugKismet (exposes Blueprint-specific functionality from the SenseGloveDebug module) │ ├── SenseGloveEditor (the Editor module) │ ├── SenseGloveInterop (internally used for interoperability between RTTI disabled/enabled modules) │ - ├── SenseGloveKismet (exposes Blueprints-specific functionality from the SenseGlove module) + ├── SenseGloveKismet (exposes Blueprint-specific functionality from the SenseGlove module) │ ├── SenseGloveLog (the internal log module) │ ├── SenseGloveSettings (the plugin's settings manager) │ - ├── SenseGloveSettingsKismet (exposes Blueprints-specific functionality from the SenseGloveSettings module) + ├── SenseGloveSettingsKismet (exposes Blueprint-specific functionality from the SenseGloveSettings module) │ ├── SenseGloveTracking (provides XR_EXT_hand_tracking support, HMD auto-detection, and SenseGlove device tracking) │ - ├── SenseGloveTrackingKismet (exposes Blueprints-specific functionality from the SenseGloveTracking module) + ├── SenseGloveTrackingKismet (exposes Blueprint-specific functionality from the SenseGloveTracking module) │ ├── SenseGloveTypes (exposes various enums from the backend libraries and also types from the SenseGlove module) │ diff --git a/Handbook/src/appendix/planned-features-completion-status.md b/Handbook/src/appendix/planned-features-completion-status.md index a9eb6d5c..4390faea 100644 --- a/Handbook/src/appendix/planned-features-completion-status.md +++ b/Handbook/src/appendix/planned-features-completion-status.md @@ -26,7 +26,7 @@ - [X] Easy wrist/hand tracking debugging using the SenseGlove Debug module. - [X] A generic Settings module with the ability to override settings. - [X] C++/Blueprint interaction events such as OnGrabStateUpdated, OnTouchStateUpdated, OnActorGrabbed, OnActorReleased, OnActorBeginTouch, and OnActorEndTouch. -- [X] A fallback to HMD and wrist tracker hardware auto-detection mechanism when automatic detection of the wrist tracker hardware is desired. +- [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. @@ -43,7 +43,7 @@ - [ ] Get tracking input from sources other than a SenseGlove device. - [ ] Be able to assign behaviors to different objects (meshes) in the scene (e.g. Slider, Hinge, basic Grabables, etc). -- [ ] Make it so developers can define or extend their own behavior(s) to an object through Code / Blueprints (e.g. I want a car door that is like a slider, but follows a path rather than a straight line). +- [ ] Make it so developers can define or extend their own behavior(s) to an object through Code / Blueprint (e.g. I want a car door that is like a slider, but follows a path rather than a straight line). - [ ] Make the hand(s) able to push around physics-driven objects (for as much as their behaviors allow) (in backlog). - [ ] Be able to grab objects with up to 2 hands (and move them around with both hands at the same time in a way that seems realistic). - [ ] Ensure that our virtual hands (and the objects they hold) do not phase through other physics objects (e.g. walls and tables). diff --git a/Handbook/src/overview/README.md b/Handbook/src/overview/README.md index 8c836ba0..2271d483 100644 --- a/Handbook/src/overview/README.md +++ b/Handbook/src/overview/README.md @@ -66,14 +66,14 @@ 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 FXRMotionControllerData](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/) - - [Blueprints](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md) + - [Blueprint](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/blueprint.md) - [C++](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md) ## 🔌 Low-Level API This section delves into the SenseGlove low-level API: -- [Low-Level Blueprints API](../low-level-api/blueprint.md) +- [Low-Level Blueprint API](../low-level-api/blueprint.md) - [Low-Level C++ API](../low-level-api/cpp.md) ## 📑 Appendix