fix documentation typos
This commit is contained in:
@@ -64,7 +64,7 @@ Welcom to the SenseGlove Unreal Engine Handbook!
|
|||||||
- [Safe Glove Access in Blueprint](advanced-topics/safe-glove-access-blueprint/README.md)
|
- [Safe Glove Access in Blueprint](advanced-topics/safe-glove-access-blueprint/README.md)
|
||||||
- [OpenXR](advanced-topics/openxr/README.md)
|
- [OpenXR](advanced-topics/openxr/README.md)
|
||||||
- [Consuming FXRMotionControllerData](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/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)
|
- [C++](advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md)
|
||||||
|
|
||||||
# 🔌 Low-Level API
|
# 🔌 Low-Level API
|
||||||
|
|||||||
@@ -19,7 +19,7 @@
|
|||||||
│
|
│
|
||||||
├── SenseGloveBackend (responsible for initialization and deinitialization of the backend libraries)
|
├── 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)
|
├── 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)
|
├── 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++)
|
├── SenseGloveCore (exposes part of the SGCoreCpp low-level API to C++)
|
||||||
│
|
│
|
||||||
├── SenseGloveCoreImpl (uses Exceptions and RTTI, intended for internal use only)
|
├── 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)
|
├── 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)
|
├── SenseGloveEditor (the Editor module)
|
||||||
│
|
│
|
||||||
├── SenseGloveInterop (internally used for interoperability between RTTI disabled/enabled modules)
|
├── 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)
|
├── SenseGloveLog (the internal log module)
|
||||||
│
|
│
|
||||||
├── SenseGloveSettings (the plugin's settings manager)
|
├── 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)
|
├── 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)
|
├── SenseGloveTypes (exposes various enums from the backend libraries and also types from the SenseGlove module)
|
||||||
│
|
│
|
||||||
|
|||||||
@@ -26,7 +26,7 @@
|
|||||||
- [X] Easy wrist/hand tracking debugging using the SenseGlove Debug module.
|
- [X] Easy wrist/hand tracking debugging using the SenseGlove Debug module.
|
||||||
- [X] A generic Settings module with the ability to override settings.
|
- [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] 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] OpenXR-compatible hand tracking (XR_EXT_hand_tracking) support.
|
||||||
- [X] FXRMotionControllerData compatible hand animation system.
|
- [X] FXRMotionControllerData compatible hand animation system.
|
||||||
- [X] FXRMotionControllerData compatible wrist tracking system.
|
- [X] FXRMotionControllerData compatible wrist tracking system.
|
||||||
@@ -43,7 +43,7 @@
|
|||||||
|
|
||||||
- [ ] Get tracking input from sources other than a SenseGlove device.
|
- [ ] 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).
|
- [ ] 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).
|
- [ ] 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).
|
- [ ] 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).
|
- [ ] Ensure that our virtual hands (and the objects they hold) do not phase through other physics objects (e.g. walls and tables).
|
||||||
|
|||||||
@@ -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/)
|
- [Safe Glove Access in Blueprint](../advanced-topics/safe-glove-access-blueprint/)
|
||||||
- [OpenXR](../advanced-topics/openxr/)
|
- [OpenXR](../advanced-topics/openxr/)
|
||||||
- [Consuming FXRMotionControllerData](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/)
|
- [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)
|
- [C++](../advanced-topics/openxr/consuming-fxrmotioncontrollerdata/cpp.md)
|
||||||
|
|
||||||
## 🔌 Low-Level API
|
## 🔌 Low-Level API
|
||||||
|
|
||||||
This section delves into the SenseGlove 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)
|
- [Low-Level C++ API](../low-level-api/cpp.md)
|
||||||
|
|
||||||
## 📑 Appendix
|
## 📑 Appendix
|
||||||
|
|||||||
Reference in New Issue
Block a user