addressed documentation feedback, added null check to prefabs

Author: radicalad

Assets/MixedRealityToolkit.Extensions/HandPhysicsService/Examples/PhysicsTriggerEventReadout.cs

@@ -9,7 +9,7 @@
 namespace Microsoft.MixedReality.Toolkit.Extensions.HandPhysics.Examples
 {
     /// <summary>
-    /// Writes Collider Trigger from Articulated hands events to a TextMeshPro object
+    /// Writes collider trigger from articulated hands events to a TextMeshPro object
     /// </summary>
     public class PhysicsTriggerEventReadout : MonoBehaviour
     {
@@ -74,7 +74,7 @@ private void WriteText(bool clear = false)
             {
                 text.Append(joint.name + " is touching. <br>");
             }
-                textField.text = text + "<br>";
+            textField.text = text + "<br>";
         }
     }
 }

Assets/MixedRealityToolkit.Extensions/HandPhysicsService/HandPhysicsService.cs

@@ -49,6 +49,10 @@ public GameObject FingerTipKinematicBodyPrefab
                 {
                     CreateKinematicBodies();
                 }
+                else
+                {
+                    DestroyKinematicBodies();
+                }
                 fingerTipKinematicBodyPrefab = value;
             }
         }
@@ -65,6 +69,10 @@ public GameObject PalmKinematicBodyPrefab
                 {
                     CreateKinematicBodies();
                 }
+                else
+                {
+                    DestroyKinematicBodies();
+                }
 
                 palmKinematicBodyPrefab = value;
             }
@@ -146,14 +154,7 @@ public override void Update()
         /// </summary>
         private void CreateKinematicBodies()
         {
-            if(jointKinematicBodies.Count > 0)
-            {
-                //Tear down the old kinematicBodies
-                foreach (JointKinematicBody jointKinematicBody in jointKinematicBodies)
-                {
-                    UnityEngine.Object.Destroy(jointKinematicBody.gameObject);
-                }
-            }
+            DestroyKinematicBodies();
 
             // Create joint kinematic bodies.
             for (int i = 0; i < handednessTypes.Length; ++i)
@@ -178,16 +179,31 @@ private void CreateKinematicBodies()
             }
         }
 
+        /// <summary>
+        /// Destroys the existing joints
+        /// </summary>
+        private void DestroyKinematicBodies()
+        {
+            if(jointKinematicBodies.Count > 0)
+            {
+                //Tear down the old kinematicBodies
+                foreach (JointKinematicBody jointKinematicBody in jointKinematicBodies)
+                {
+                    UnityEngine.Object.Destroy(jointKinematicBody.gameObject);
+                }
+            }
+        }
+
         /// <summary>
         /// Instantiates <see cref="FingerTipKinematicBodyPrefab"/>s for all <see cref="fingerTipTypes"/>.
         /// </summary>
         /// <remarks>
         /// Optionally instantiates <see cref="PalmKinematicBodyPrefab"/>.
         /// </remarks>
-        /// <param name="rigidBodyPrefab">The prefab to intantiate.</param>
+        /// <param name="rigidBodyPrefab">The prefab to instantiate.</param>
         /// <param name="layer">the layer to put the prefab on.</param>
         /// <param name="handednessType">the specified <see cref="Handedness"/> for the joint.</param>
-        /// <param name="jointType">the specified <see cref="TrackedHandJoint"/> to intantiate against.</param>
+        /// <param name="jointType">the specified <see cref="TrackedHandJoint"/> to instantiate against.</param>
         /// <param name="parent">The root <see href="https://docs.unity3d.com/ScriptReference/GameObject.html"> for the joints.</param>
         /// <param name="jointKinematicBody">When successful, the generated <see cref="JointKinematicBody"/>.</param>
         /// <returns>True when able to successfully intantiate and create a <see cref="JointKinematicBody"/>.</returns>

Assets/MixedRealityToolkit.Extensions/HandPhysicsService/HandPhysicsServiceProfile.cs

@@ -6,32 +6,46 @@
 namespace Microsoft.MixedReality.Toolkit.Extensions.HandPhysics
 {
     /// <summary>
-    /// Configuration profile for <see cref="HandPhysicsService"/> Extension service.
+    /// Configuration profile for <see cref="HandPhysicsService"/> extension service.
     /// </summary>
 	[MixedRealityServiceProfile(typeof(IHandPhysicsService))]
 	[CreateAssetMenu(fileName = "HandPhysicsServiceProfile", menuName = "MixedRealityToolkit/Hand Physics Service Configuration Profile")]
 	public class HandPhysicsServiceProfile : BaseMixedRealityProfile
 	{
+        /// <summary>
+        /// Whether make the Palm a physics joint
+        /// </summary>
         public bool UsePalmKinematicBody => usePalmKinematicBody;
+
+        /// <summary>
+        /// The prefab to represent each physics joint
+        /// </summary>
         public GameObject FingerTipKinematicBodyPrefab => fingerTipKinematicBodyPrefab;
+
+        /// <summary>
+        /// The prefab to represent the palm physics joint
+        /// </summary>
         public GameObject PalmKinematicBodyPrefab => palmKinematicBodyPrefab;
 
+        /// <summary>
+        /// The Layer the physics joints will be on
+        /// </summary>
         public int HandPhysicsLayer => handPhysicsLayer;
 
         [SerializeField]
-        [Tooltip("The Layer the PhysicsJoints will be on")]
+        [Tooltip("The Layer the physics joints will be on")]
         private int handPhysicsLayer = 0;
 
         [SerializeField]
-        [Tooltip("The prefab to represent each PhysicsJoint")]
+        [Tooltip("The prefab to represent each physics joint")]
         private GameObject fingerTipKinematicBodyPrefab = null;
 
         [SerializeField]
-        [Tooltip("Whether make the Palm a PhysicsJoint")]
+        [Tooltip("Whether make the Palm a physics joint")]
         private bool usePalmKinematicBody = false;
 
         [SerializeField]
-        [Tooltip("The prefab to represent the Palm PhysicsJoint")]
+        [Tooltip("The prefab to represent the palm physics joint")]
         private GameObject palmKinematicBodyPrefab = null;
     }
 }

Assets/MixedRealityToolkit.Extensions/HandPhysicsService/Interfaces/IHandPhysicsService.cs

@@ -6,32 +6,32 @@
 namespace Microsoft.MixedReality.Toolkit.Extensions.HandPhysics
 {
     /// <summary>
-    /// Generic interface for applying rigidbodies to handJoints
+    /// Generic interface for applying rigidbodies to hand joints
     /// </summary>
     public interface IHandPhysicsService : IMixedRealityExtensionService
     {
         /// <summary>
-        /// The Parent GameObject that contains all the PhysicsJoints
+        /// The parent GameObject that contains all the physics joints
         /// </summary>
         GameObject HandPhysicsServiceRoot { get; }
 
         /// <summary>
-        /// The LayerMask the PhysicsJoints will be on
+        /// The LayerMask the physics joints will be on
         /// </summary>
         int HandPhysicsLayer { get; set; }
 
         /// <summary>
-        /// Whether to make the Palm a PhysicsJoint
+        /// Whether to make the palm a physics joint
         /// </summary>
         bool UsePalmKinematicBody { get; set; }
 
         /// <summary>
-        /// The prefab to represent each PhysicsJoint
+        /// The prefab to represent each physics joints
         /// </summary>
         GameObject FingerTipKinematicBodyPrefab { get; set; }
 
         /// <summary>
-        /// The prefab to represent the Palm PhysicsJoint
+        /// The prefab to represent the Palm physics joints
         /// </summary>
         GameObject PalmKinematicBodyPrefab { get; set; }
     }

Assets/MixedRealityToolkit.Extensions/HandPhysicsService/JointKinematicBody.cs

@@ -8,7 +8,7 @@
 namespace Microsoft.MixedReality.Toolkit.Extensions.HandPhysics
 {
     /// <summary>
-    /// Updates a Rigidbody Transform against another Transform.
+    /// Updates a rigidbody transform against another transform.
     /// </summary>
     public class JointKinematicBody : MonoBehaviour
     {
@@ -18,7 +18,7 @@ public class JointKinematicBody : MonoBehaviour
         public Transform Joint { get; set; }
 
         /// <summary>
-        /// What hand this component lives one.
+        /// What hand this component lives on.
         /// </summary>
         public Handedness HandednessType { get; set; }
 

Assets/MixedRealityToolkit.Extensions/HandPhysicsService/README.md

@@ -1,9 +1,9 @@
-# Hand Physics Extension Service
+# Hand physics extension service
 
-The Hand Physics service enables rigid body collision events and interactions with articulated hands.
+The hand physics service enables rigid body collision events and interactions with articulated hands.
 
-## Getting started with Hand Physics Extension Service
-Add the Hand Physics service to the list of extension services and use the default profile.
+## Getting started with hand physics extension service
+Add the hand physics service to the list of extension services and use the default profile.
 
 Once enabled, use any collider's IsTrigger property to receive collision events from all 10 digits (and palms if they're enabled).
 

Documentation/Extensions/HandPhysicsService/HandPhysicsServiceOverview.md

@@ -1,26 +1,26 @@
-# Hand Physics Extension Service
-The Hand Physics service enables rigid body collision events and interactions with articulated hands.
+# Hand physics extension service
+The hand physics service enables rigid body collision events and interactions with articulated hands.
 
 ## Enabling the extension
-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.
+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.
 
-## Profile Options
-### Hand Physics Layer
+## Profile options
+### Hand physics layer
 Controls the layer the instantiated hand joints will go to.
 
-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.
+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.
 
-### Finger Tip Kinematic Body Prefab
+### Finger tip kinematic body prefab
 Controls which prefab is instantiated on fingertips. In order for the service to work as expected, the prefab requires:
 - A rigidbody component, with isKinematic enabled
 - A collider
 - `JointKinematicBody` component
 
-### Use Palm Kinematic Body
+### Use palm kinematic body
 Controls whether the service will attempt to instantiate a prefab on the palm joint.
 
-### Palm Kinematic Body Prefab
-When UsePalmKinematicBody is enabled, this is the prefab it will instantiate. Just like `FingerTipKinematicBodyPrefab`, this prefab requires:
+### Palm kinematic body prefab
+When `UsePalmKinematicBody` is enabled, this is the prefab it will instantiate. Just like `FingerTipKinematicBodyPrefab`, this prefab requires:
 - A rigidbody component, with isKinematic enabled
 - A collider
 - `JointKinematicBody` component