Skip to content

Commit 5c87d69

Browse files
committed
updated Docs to include Extensions sub foldout and HandPhysicsService
1 parent e9c6fb9 commit 5c87d69

File tree

3 files changed

+37
-4
lines changed

3 files changed

+37
-4
lines changed

Documentation/Extensions/ExtensionServices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Extension services are components that extend the functionality of the Mixed Reality Toolkit. These services may be provided
44
by the MRTK or by other parties.
55

6-
## Creating an extenison service
6+
## Creating an extension service
77

88
The most efficient way to create an extension service is to use the [extension service creation wizard](../Tools/ExtensionServiceCreationWizard.md).
99
To start the extension service creation wizard, select **Mixed Reality Toolkit > Utilities > Create Extension Service**.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Hand Physics Extension Service
2+
The Hand Physics service enables rigid body collision events and interactions with articulated hands.
3+
4+
## Enabling the extension
5+
To enable the extension, open your RegisteredServiceProvider profile. Click Register a new Service Provider to add a new configuration. In the Component Type field, select HandPhysicsService. In the Configuration Profile field, select the default hand physics profile included with the extension.
6+
7+
## Profile Options
8+
### Hand Physics Layer
9+
Controls the layer the instantiated hand joints will go to.
10+
11+
While the service defaults to the "default" layer (0), it is recommended to use a separate layer for Hand Physics objects. Otherwise there may be unwanted collisions and/or inaccurate raycasts.
12+
13+
### Finger Tip Kinematic Body Prefab
14+
Controls which prefab is instantiated on fingertips. In order for the service to work as expected, the prefab requires:
15+
- A rigidbody component, with isKinematic enabled
16+
- A collider
17+
- `JointKinematicBody` component
18+
19+
### Use Palm Kinematic Body
20+
Controls whether the service will attempt to instantiate a prefab on the palm joint.
21+
22+
### Palm Kinematic Body Prefab
23+
When UsePalmKinematicBody is enabled, this is the prefab it will instantiate. Just like `FingerTipKinematicBodyPrefab`, this prefab requires:
24+
- A rigidbody component, with isKinematic enabled
25+
- A collider
26+
- `JointKinematicBody` component
27+
28+
## How to use the service
29+
Once enabled, use any collider's `IsTrigger` property to receive collision events from all 10 digits (and palms if they're enabled).

Documentation/toc.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,13 @@
175175
- name: Runtime tools
176176
items:
177177
- name: Controller Mapping tool
178-
href: Tools/ControllerMappingTool.md
179-
- name: Scene Transition Service
180-
href: Extensions/SceneTransitionService/SceneTransitionServiceOverview.md
178+
href: Tools/ControllerMappingTool.md
179+
- name: Extensions
180+
items:
181+
- name: Scene Transition Service
182+
href: Extensions/SceneTransitionService/SceneTransitionServiceOverview.md
183+
- name: Hand Physics Service
184+
href: Extensions/HandPhysicsService/HandPhysicsServiceOverview.md
181185
- name: Contributing
182186
items:
183187
- name: Contributing Overview

0 commit comments

Comments
 (0)