Merge pull request #6899 from keveleigh/header-casing-3

Header capitalization phase 3

Author: David Kline

Documentation/Input/HandTracking.md

@@ -1,12 +1,12 @@
-# Hand Tracking
+# Hand tracking
 
-## Hand Tracking Profile
+## Hand tracking profile
 
 The _Hand Tracking profile_ is found under the _Input System profile_. It contains settings for customizing hand representation.
 
 <img src="../../Documentation/Images/Input/HandTrackingProfile.png" width="650px" style="display:block;">
 
-## Joint Prefabs
+## Joint prefabs
 
 Joint prefabs are visualized using simple prefabs. The _Palm_ and _Index Finger_ joints are of special importance and have their own prefab, while all other joints share the same prefab.
 
@@ -17,7 +17,7 @@ By default the hand joint prefabs are simple geometric primitives. These can be
 
 <img src="../../Documentation/Images/InputSimulation/MRTK_Core_Input_Hands_JointVisualizerPrefabs.png" width="350px"  style="display:block;">
 
-## Hand Mesh Prefab
+## Hand mesh prefab
 
 The hand mesh is used if fully defined mesh data is provided by the hand tracking device. The mesh renderable in the prefab is replaced by data from the device, so a dummy mesh such as a cube is sufficient. The material of the prefab is used for the hand mesh.
 
@@ -47,11 +47,11 @@ Available joints are listed in the [`TrackedHandJoint`](xref:Microsoft.MixedReal
 > [!NOTE]
 > Joint object are destroyed when hand tracking is lost! Make sure that any scripts using the joint object handle the `null` case gracefully to avoid errors!
 
-### Accessing a given Hand Controller
+### Accessing a given hand controller
 
 A specific hand controller is often available, e.g. when handling input events. In this case the joint data can be requested directly from the device, using the [`IMixedRealityHand`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityHand) interface.
 
-#### Polling Joint Pose from Controller
+#### Polling joint pose from controller
 
 The [`TryGetJoint`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityHand.TryGetJoint*) function returns `false` if the requested joint is not available for some reason. In that case the resulting pose will be [`MixedRealityPose.ZeroIdentity`](xref:Microsoft.MixedReality.Toolkit.Utilities.MixedRealityPose.ZeroIdentity).
 
@@ -69,7 +69,7 @@ public void OnSourceDetected(SourceStateEventData eventData)
 }
 ```
 
-#### Joint Transform from Hand Visualizer
+#### Joint transform from hand visualizer
 
 Joint objects can be requested from the [controller visualizer](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityController.Visualizer).
 
@@ -91,7 +91,7 @@ public void OnSourceDetected(SourceStateEventData eventData)
 
 If no specific controller is given then utility classes are provided for convenient access to hand joint data. These functions request joint data from the first available hand device currently tracked.
 
-#### Polling Joint Pose from HandJointUtils
+#### Polling joint pose from HandJointUtils
 
 [`HandJointUtils`](xref:Microsoft.MixedReality.Toolkit.Input.HandJointUtils) is a static class that queries the first active hand device.
 
@@ -102,7 +102,7 @@ if (HandJointUtils.TryGetJointPose(TrackedHandJoint.IndexTip, Handedness.Right,
 }
 ```
 
-#### Joint Transform from Hand Joint Service
+#### Joint transform from hand joint service
 
 [`IMixedRealityHandJointService`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityHandJointService) keeps a persistent set of [GameObjects](https://docs.unity3d.com/ScriptReference/GameObject.html) for tracking joints.
 
@@ -124,11 +124,11 @@ if (handJointService != null)
 }
 ```
 
-### Hand Tracking Events
+### Hand tracking events
 
 The input system provides events as well, if polling data from controllers directly is not desirable.
 
-#### Joint Events
+#### Joint events
 
 [`IMixedRealityHandJointHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityHandJointHandler) handles updates of joint positions.
 
@@ -150,7 +150,7 @@ public class MyHandJointEventHandler : IMixedRealityHandJointHandler
 }
 ```
 
-#### Mesh Events
+#### Mesh events
 
 [`IMixedRealityHandMeshHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityHandMeshHandler) handles changes of the articulated hand mesh.
 
@@ -181,7 +181,7 @@ public class MyHandMeshEventHandler : IMixedRealityHandMeshHandler
 }
 ```
 
-## Known Issues
+## Known issues
 
 ### .NET Native
 

Documentation/Input/InputActions.md

@@ -1,8 +1,8 @@
-# Input Actions
+# Input actions
 
 [**Input Actions**](InputActions.md) are abstractions over raw inputs meant to help isolating application logic from the specific input sources producing an input. It can be useful, for example, to define a *Select* action and map it to the left mouse button, a button in a gamepad and a trigger in a 6 DOF controller. You can then have your application logic listen for *Select* input action events instead of having to be aware of all the different inputs that can produce it.
 
-## Creating An Input Action
+## Creating an input action
 
 Input actions are configured in the **Input Actions Profile**, inside the *Input System Profile* in the Mixed Reality Toolkit component, specifying a name for the action and the type of inputs (*Axis Constraint*) it can be mapped to:
 
@@ -19,11 +19,11 @@ Six Dof | 3D pose with translation and rotation like the one produced by 6 DOF c
 
 You can find the full list in [`AxisType`](xref:Microsoft.MixedReality.Toolkit.Utilities.AxisType).
 
-## Mapping Inputs To Actions
+## Mapping input to actions
 
 The way you map an input to and action depends on the type of the input source:
 
-### Controller Inputs
+### Controller input
 
 Go to the **Controller Input Mapping Profile**, under the *Input System Profile*. There you will find a list of all supported controllers:
 
@@ -33,22 +33,22 @@ Select the one you want to configure and a dialog window will appear with all th
 
 <img src="../../Documentation/Images/Input/InputActionAssignment.PNG" style="max-width:100%;">
 
-### Speech Inputs
+### Speech input
 
 In the **Speech Command Profile**, under the *Input System Profile*, you'll find the list of currently defined speech commands. To map one of them to an action, just select it in the *Action* drop down.
 
 <img src="../../Documentation/Images/Input/SpeechCommandsProfile.png" style="max-width:100%;">
 
-### Gesture Inputs
+### Gesture input
 
 The **Gestures Profile**, under the *Input System Profile*, contains all defined gestures. You can map each of them to an action by selecting it in the *Action* drop down.
 
 <img src="../../Documentation/Images/Input/GestureProfile.png" style="max-width:100%;">
 
-## Handling Input Actions
+## Handling input actions
 
 > [!WARNING]
-> Currently only input actions of *Digital* type can be handled using the methods described in this section. For other action types, you'll have to handle directly the events for the corresponding inputs instead. For example, to handle a 6 DOF  action mapped to controller inputs, you'll have to use [`IMixedRealityGestureHandler<T>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityGestureHandler`1) with T = [`MixedRealityPose`](xref:Microsoft.MixedReality.Toolkit.Utilities.MixedRealityPose).
+> Currently only input actions of *Digital* type can be handled using the methods described in this section. For other action types, you'll have to handle directly the events for the corresponding inputs instead. For example, to handle a 6 DOF action mapped to controller inputs, you'll have to use [`IMixedRealityGestureHandler<T>`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityGestureHandler`1) with T = [`MixedRealityPose`](xref:Microsoft.MixedReality.Toolkit.Utilities.MixedRealityPose).
 
 The easiest way to handle input actions is to make use of the [`InputActionHandler`](xref:Microsoft.MixedReality.Toolkit.Input.InputActionHandler) script. This allows you to define the action you want to listen to and react to action started and ended events using Unity Events.
 

Documentation/Input/InputProviders.md

@@ -1,4 +1,4 @@
-# Input Providers
+# Input providers
 
 Input providers are registered in the **Registered Service Providers Profile**, found in the Mixed Reality Toolkit component:
 

Documentation/Input/InputState.md

@@ -1,4 +1,4 @@
-# Accessing Input State in MRTK
+# Accessing input state in MRTK
 
 It's possible to directly query the state of all inputs in MRTK by iterating over the controllers attached to the input sources. MRTK also provides convenience methods for accessing the position and rotation of the eyes, hands, head, and motion controller.
 
@@ -49,7 +49,7 @@ foreach(var controller in CoreServices.InputSystem.DetectedControllers)
 }
 ```
 
-## See Also
+## See also
 
 - [InputEvents](InputEvents.md)
 - [Pointers](Pointers.md)

Documentation/Input/Overview.md

@@ -1,4 +1,4 @@
-# Input Overview
+# Input overview
 
 The Input System in MRTK allows you to:
 
@@ -22,4 +22,4 @@ Controllers can have [**Pointers**](Pointers.md) attached to them that query the
 
 While you can handle [input events directly in UI components](InputEvents.md), it is recommended to use [pointer events](pointers.md#pointer-event-interfaces) to keep the implementation device-independent.
 
-MRTK also provides several convenience methods to query input state directly in a device-independent way. See [Accessing Input State in MRTK](InputState.md) for more details.
+MRTK also provides several convenience methods to query input state directly in a device-independent way. See [Accessing input state in MRTK](InputState.md) for more details.

Documentation/Input/Pointers.md

@@ -114,7 +114,7 @@ Useful Sphere Pointer properties:
 
 <img src="../../Documentation/Images/Pointers/MRTK_Pointers_Parabolic.png" width="400">
 
-## Pointer support for Mixed Reality Platforms
+## Pointer support for mixed reality platforms
 
 The following table details the pointer types that are typically used for the common platforms in MRTK. NOTE:
 it's possible to add different pointer types to these platforms. For example, you could add a Poke pointer or Sphere pointer to VR. Additionally, VR devices with a gamepad could use the GGV pointer.
@@ -196,7 +196,7 @@ public class ColorTap : MonoBehaviour, IMixedRealityFocusHandler, IMixedRealityP
 }
 ```
 
-### Query Pointers
+### Query pointers
 
 It is possible to gather all pointers currently active by looping through the available input sources (i.e controllers and inputs available) to discover which pointers are attached to them.
 
@@ -216,7 +216,7 @@ foreach (var inputSource in CoreServices.InputSystem.DetectedInputSources)
 }
 ```
 
-#### Primary Pointer
+#### Primary pointer
 
 Developers can subscribe to the FocusProviders PrimaryPointerChanged event to be notified when the primary pointer in focus has changed. This can be extremely useful to identify if the user is currently interacting with a scene via gaze or a hand ray or other input source.
 
@@ -246,7 +246,7 @@ The [PrimaryPointerExample scene](https://github.com/microsoft/MixedRealityToolk
 
 <img src="../../Documentation/Images/Pointers/PrimaryPointerExample.png" style="max-width:100%;">
 
-### Pointer Result
+### Pointer result
 
 The pointer [`Result`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealityPointer.Result) property contains the current result for the scene query used to determine the object with focus. For a raycast pointer, like the ones created by default for motion controllers, gaze input and hand rays, it will contain the location and normal of the raycast hit.
 
@@ -264,7 +264,7 @@ The [PointerResultExample scene](https://github.com/microsoft/MixedRealityToolki
 
 <img src="../../Documentation/Images/Input/PointerResultExample.png" style="max-width:100%;">
 
-### Disable Pointers
+### Disable pointers
 
 To turn enable and disable pointers (for example, to disable the hand ray), set the [`PointerBehavior`](xref:Microsoft.MixedReality.Toolkit.Input.PointerBehavior) for a given pointer type via [`PointerUtils`](xref:Microsoft.MixedReality.Toolkit.Input.PointerUtils).
 
@@ -297,7 +297,7 @@ For pointer events handled by [`IMixedRealityPointerHandler`](xref:Microsoft.Mix
 
 <img src="../../Documentation/Images/Pointers/PointerHandler.png" style="max-width:100%;">
 
-## Pointer Extent
+## Pointer extent
 
 Far pointers have settings which limit how far they will raycast and interact with other objects in the scene.
 By default, this value is set to 10 meters. This value was chosen to remain consistent with the behavior
@@ -312,7 +312,7 @@ fields:
 *Default Pointer Extent* - This controls the length of the pointer ray/line that will
 render when the pointer is not interacting with anything.
 
-## See Also
+## See also
 
 - [Pointer Architecture](../Architecture/InputSystem/ControllersPointersAndFocus.md)
 - [Input Events](InputEvents.md)

Documentation/Input/Speech.md

@@ -8,7 +8,7 @@ Speech input providers, like *Windows Speech Input*, don't create any controller
 
 <img src="../../Documentation/Images/Input/SpeechCommandsProfile.png" width="450px">
 
-## Handling Speech Input
+## Handling speech input
 
 The [**`Speech Input Handler`**](xref:Microsoft.MixedReality.Toolkit.Input.SpeechInputHandler) script can be added to a GameObject to handle speech commands using [**UnityEvents**](https://docs.unity3d.com/Manual/UnityEvents.html). It automatically shows the list of the defined keywords from the **Speech Commands Profile**.
 
@@ -20,7 +20,7 @@ Assign optional **SpeechConfirmationTooltip.prefab** to display animated confirm
 
 Alternatively, developers can implement the [`IMixedRealitySpeechHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealitySpeechHandler) interface in a custom script component to [handle speech input events](InputEvents.md#input-event-interface-example).
 
-## Example Scene
+## Example scene
 
 The **SpeechInputExample** scene, in `MixedRealityToolkit.Examples\Demos\Input\Scenes\Speech`, shows how to use speech. You can also listen to speech command events directly in your own script by implementing [`IMixedRealitySpeechHandler`](xref:Microsoft.MixedReality.Toolkit.Input.IMixedRealitySpeechHandler) (see table of [event handlers](InputEvents.md)).
 

Documentation/InputSimulation/InputAnimationFileFormat.md

@@ -1,4 +1,4 @@
-# Input Animation Binary File Format Specification
+# Input animation binary file format specification
 
 ## Overall structure
 
@@ -29,7 +29,7 @@ The input animation data consists of a sequence of animation curves. The number
 | Hand Joints Left | [Joint Pose Curves](#joint-pose-curves) |
 | Hand Joints Right | [Joint Pose Curves](#joint-pose-curves) |
 
-### Joint Pose Curves
+### Joint pose curves
 
 For each hand a sequence of joint animation curves is stored. The number of joints is fixed, and a set of pose curves is stored for each joint.
 
@@ -63,7 +63,7 @@ For each hand a sequence of joint animation curves is stored. The number of join
 | PinkyDistalJoint | [Pose Curves](#pose-curves) |
 | PinkyTip | [Pose Curves](#pose-curves) |
 
-### Pose Curves
+### Pose curves
 
 Pose curves are a sequence of 3 animation curves for the position vector, followed by 4 animation curves for the rotation quaternion.
 
@@ -77,7 +77,7 @@ Pose curves are a sequence of 3 animation curves for the position vector, follow
 | Rotation Z | [Float Curve](#float-curve) |
 | Rotation W | [Float Curve](#float-curve) |
 
-### Float Curve
+### Float curve
 
 Floating point curves are fully fledged Bézier curves with a variable number of keyframes. Each keyframe stores a time and a curve value, as well as tangents and weights on the left and right side of each keyframe.
 
@@ -88,7 +88,7 @@ Floating point curves are fully fledged Bézier curves with a variable number of
 | Number of keyframes | Int32 |
 | Keyframes | [Float Keyframe](#float-keyframe) |
 
-### Float Keyframe
+### Float keyframe
 
 A float keyframe stores tangent and weight values alongside the basic time and value.
 
@@ -102,7 +102,7 @@ A float keyframe stores tangent and weight values alongside the basic time and v
 | OutWeight | Float32 |
 | WeightedMode | Int32, [Weighted Mode](#weighted-mode) |
 
-### Boolean Curve
+### Boolean curve
 
 Boolean curves are simple sequences of on/off values. On every keyframe the value of the curve flips immediately.
 
@@ -113,7 +113,7 @@ Boolean curves are simple sequences of on/off values. On every keyframe the valu
 | Number of keyframes | Int32 |
 | Keyframes | [Boolean Keyframe](#boolean-keyframe) |
 
-### Boolean Keyframe
+### Boolean keyframe
 
 A boolean keyframe only stores a time and value.
 
@@ -122,7 +122,7 @@ A boolean keyframe only stores a time and value.
 | Time | Float32 |
 | Value | Float32 |
 
-### Wrap Mode
+### Wrap mode
 
 The semantics of Pre- and Post-Wrap modes follow the [Unity WrapMode](https://docs.unity3d.com/ScriptReference/WrapMode.html) definition. They are a combination of the following bits:
 
@@ -134,7 +134,7 @@ The semantics of Pre- and Post-Wrap modes follow the [Unity WrapMode](https://do
 | 4 | PingPong: When time reaches the end of the animation clip, time will ping pong back between beginning and end. |
 | 8 | ClampForever: Plays back the animation. When it reaches the end, it will keep playing the last frame and never stop playing. |
 
-### Weighted Mode
+### Weighted mode
 
 The semantics of the Weighted mode follow the [Unity WeightedMode](https://docs.unity3d.com/ScriptReference/WeightedMode.html) definition.
 

Documentation/InputSimulation/InputAnimationRecording.md

@@ -1,4 +1,4 @@
-# Input Animation Recording
+# Input animation recording
 
 MRTK features an recording system by which head movement and hand tracking data can be stored in animation files. The recorded data can then be played back using the [input simulation system](InputSimulationService.md).
 
@@ -12,11 +12,11 @@ Recording input is a useful tool in a variety of situations:
   The recording system supports a "rolling buffer" concept that allows recording recent input in the background.
   See [Input Recording Service](#input-recording-service).
 
-## Recording and Playback services
+## Recording and playback services
 
 Two input system services are provided to record and play back input respectively.
 
-### Input Recording Service
+### Input recording service
 
 [`InputRecordingService`](xref:Microsoft.MixedReality.Toolkit.Input.InputRecordingService) takes data from the main camera transform and active hand controllers and stores it in an internal buffer. When requested this data is then serialized into binary files for storage and later replay.
 
@@ -32,7 +32,7 @@ The data in the recording buffer can be saved in a binary file using the [SaveIn
 
 For details on the binary file format see [Input Animation File Format Specification](InputAnimationFileFormat.md).
 
-### Input Playback Service
+### Input playback service
 
 [`InputPlaybackService`](xref:Microsoft.MixedReality.Toolkit.Input.InputPlaybackService) reads a binary file with input animation data and then applies this data through the [InputSimulationService](xref:Microsoft.MixedReality.Toolkit.Input.InputSimulationService) to recreate the recorded movements.