Skip to content

Commit cd679ad

Browse files
authored
Merge pull request #3856 from wiwei/imagefixes
Fix the image paths so that the github.io page also works correctly
2 parents 069a9f4 + 92e568d commit cd679ad

15 files changed

+40
-40
lines changed

Documentation/GettingStartedWithTheMRTK.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,17 +165,17 @@ For more information on the rest of the toolkit, please check the following guid
165165
* [Guide to Pointers documentation]() (Coming Soon)
166166

167167
## Building blocks for UI and Interactions
168-
| [![Button](/External/ReadMeImages/Button/MRTK_Button_Main.png)](/Documentation/README_Button.md) [Button](/Documentation/README_Button.md) | [![Bounding Box](/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Main.png)](/Documentation/README_BoundingBox.md) [Bounding Box](/Documentation/README_BoundingBox.md) | [![Manipulation Handler](/External/ReadMeImages/ManipulationHandler/MRTK_Manipulation_Main.png)](/Documentation/README_ManipulationHandler.md) [Manipulation Handler](/Documentation/README_ManipulationHandler.md) |
168+
| [![Button](../External/ReadMeImages/Button/MRTK_Button_Main.png)](/Documentation/README_Button.md) [Button](/Documentation/README_Button.md) | [![Bounding Box](../External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Main.png)](/Documentation/README_BoundingBox.md) [Bounding Box](/Documentation/README_BoundingBox.md) | [![Manipulation Handler](../External/ReadMeImages/ManipulationHandler/MRTK_Manipulation_Main.png)](/Documentation/README_ManipulationHandler.md) [Manipulation Handler](/Documentation/README_ManipulationHandler.md) |
169169
|:--- | :--- | :--- |
170170
| A button control which supports various input methods including HoloLens2's articulated hand | Standard UI for manipulating objects in 3D space | Script for manipulating objects with one or two hands |
171-
| [![Slate](/External/ReadMeImages/Slate/MRTK_Slate_Main.png)](/Documentation/README_Slate.md) [Slate](/Documentation/README_Slate.md) | [![System Keyboard](/External/ReadMeImages/SystemKeyboard/MRTK_SystemKeyboard_Main.png)](/Documentation/README_SystemKeyboard.md) [System Keyboard](/Documentation/README_SystemKeyboard.md) | [![Interactable](/External/ReadMeImages/Interactable/InteractableExamples.png)](/Documentation/README_Interactable.md) [Interactable](/Documentation/README_Interactable.md) |
171+
| [![Slate](../External/ReadMeImages/Slate/MRTK_Slate_Main.png)](/Documentation/README_Slate.md) [Slate](/Documentation/README_Slate.md) | [![System Keyboard](../External/ReadMeImages/SystemKeyboard/MRTK_SystemKeyboard_Main.png)](/Documentation/README_SystemKeyboard.md) [System Keyboard](/Documentation/README_SystemKeyboard.md) | [![Interactable](../External/ReadMeImages/Interactable/InteractableExamples.png)](/Documentation/README_Interactable.md) [Interactable](/Documentation/README_Interactable.md) |
172172
| 2D style plane which supports scrolling with articulated hand input | Example script of using the system keyboard in Unity | A script for making objects interactable with visual states and theme support |
173-
| [![Solver](/External/ReadMeImages/Solver/MRTK_Solver_Main.png)](/Documentation/README_Solver.md) [Solver](/Documentation/README_Solver.md) | [![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Main.png)](/Documentation/README_ObjectCollection.md) [Object Collection](/Documentation/README_ObjectCollection.md) | [![Tooltip](/External/ReadMeImages/Tooltip/MRTK_Tooltip_Main.png)](/Documentation/README_Tooltip.md) [Tooltip](/Documentation/README_Tooltip.md) |
173+
| [![Solver](../External/ReadMeImages/Solver/MRTK_Solver_Main.png)](/Documentation/README_Solver.md) [Solver](/Documentation/README_Solver.md) | [![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Main.png)](/Documentation/README_ObjectCollection.md) [Object Collection](/Documentation/README_ObjectCollection.md) | [![Tooltip](../External/ReadMeImages/Tooltip/MRTK_Tooltip_Main.png)](/Documentation/README_Tooltip.md) [Tooltip](/Documentation/README_Tooltip.md) |
174174
| Various object positioning behaviors such as tag-along, body-lock, constant view size and surface magnetism | Script for lay out an array of objects in a three-dimensional shape | Annotation UI with flexible anchor/pivot system which can be used for labeling motion controllers and object. |
175-
| [![App Bar](/External/ReadMeImages/AppBar/MRTK_AppBar_Main.png)](/Documentation/README_AppBar.md) [App Bar](/Documentation/README_AppBar.md) | [![Pointers](/External/ReadMeImages/Pointers/MRTK_Pointer_Main.png)](/Documentation/README_Pointers.md) [Pointers](/Documentation/README_Pointers.md) | [![Fingertip Visualization](/External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_Main.png)](/Documentation/README_FingertipVisualization.md) [Fingertip Visualization](/Documentation/README_FingertipVisualization.md) |
175+
| [![App Bar](../External/ReadMeImages/AppBar/MRTK_AppBar_Main.png)](/Documentation/README_AppBar.md) [App Bar](/Documentation/README_AppBar.md) | [![Pointers](../External/ReadMeImages/Pointers/MRTK_Pointer_Main.png)](/Documentation/README_Pointers.md) [Pointers](/Documentation/README_Pointers.md) | [![Fingertip Visualization](../External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_Main.png)](/Documentation/README_FingertipVisualization.md) [Fingertip Visualization](/Documentation/README_FingertipVisualization.md) |
176176
| UI for Bounding Box's manual activation | Learn about various types of pointers | Visual affordance on the fingertip which improves the confidence for the direct interaction |
177177

178178
## Example Scene
179179
You can find various types of interactions and UI controls in this example scene.
180180

181-
[![Button](/External/ReadMeImages/MRTK_Examples.png)](/Documentation/README_HandInteractionExamples.md)
181+
[![Button](../External/ReadMeImages/MRTK_Examples.png)](/Documentation/README_HandInteractionExamples.md)

Documentation/README_AppBar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# App Bar
2-
![App Bar](/External/ReadMeImages/AppBar/MRTK_AppBar_Main.png)
2+
![App Bar](../External/ReadMeImages/AppBar/MRTK_AppBar_Main.png)
33

44
App Bar is a UI component used with Bounding Box. Using the 'Adjust' button, you can turn on/off the Bounding Box interface for manipulating object.
55

Documentation/README_BoundingBox.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Bounding Box #
2-
![Bounding Box](/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Main.png)
2+
![Bounding Box](../External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Main.png)
33

44
The `BoundingBox` script provides basic functionality for transforming objects in Windows Mixed Reality. Using handles on the corners and edges, you can scale or rotate the object. On HoloLens 2, the bounding box responds to your finger's proximity. It shows visual feedback to help perceive the distance from the object. MRTK's bounding box provides various options which allow you to easily customize the interactions and visuals. 
55

@@ -8,15 +8,15 @@ For more information please see [App Bar and Bounding Box](https://docs.microso
88
### How to use Bounding Box ###
99
You can enable Bounding Box by simply assigning the `BoundingBox` script to any GameObject.
1010

11-
![Bounding Box](/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Assign.png)
11+
![Bounding Box](../External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Assign.png)
1212

1313
### Example Scene ###
1414
You can find bounding box examples in the *HandInteractionExamples.unity* scene:
1515

1616
<img src="/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Examples.png" width="550">
1717

1818
### Inspector Properties ###
19-
![Bounding Box](/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Structure.png)
19+
![Bounding Box](../External/ReadMeImages/BoundingBox/MRTK_BoundingBox_Structure.png)
2020

2121
#### Target Object ####
2222
This specifies which object will get transformed by the bounding box manipulation. If no object is set, the bounding box defaults to the owner object.

Documentation/README_Button.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Button #
2-
![Button](/External/ReadMeImages/Button/MRTK_Button_Main.png)
2+
![Button](../External/ReadMeImages/Button/MRTK_Button_Main.png)
33
The button supports all available input methods including articulated hand input for the near interactions and gaze + air-tap for the far interactions. You can also use voice command to trigger the button.
44

55
## How to use the Pressable Button prefab
@@ -25,7 +25,7 @@ In the idle state, the button's front plate is not visible. As a finger approach
2525
The subtle pulse effect is triggered by the `PressableButton.` The `PressableButton` looks for `ProximityLight(s)` that live on the currently interacting pointer. If any `ProximityLight(s)` are found, the ProximityLight.Pulse method is called which automatically animates shader parameters to display a pulse.
2626

2727
## Property Inspector of PressableButton
28-
![Button](/External/ReadMeImages/Button/MRTK_Button_Structure.png)
28+
![Button](../External/ReadMeImages/Button/MRTK_Button_Structure.png)
2929

3030
The Pressable Button prefab is consists of the following elements:
3131

@@ -48,7 +48,7 @@ Unity `Audio Source` for the audio feedback clips
4848
Required to make any object touchable with articulated hand input.
4949

5050
### Prefab Layout
51-
![Button](/External/ReadMeImages/Button/MRTK_Button_Layout.png)
51+
![Button](../External/ReadMeImages/Button/MRTK_Button_Layout.png)
5252

5353
The *ButtonContent* object contains front plate, text label and icon. The *FrontPlate* responds to the proximity of the index fingertip using the *Button_Box* shader. It shows glowing borders, proximity light, and a pulse effect on touch. The text label is made with TextMesh Pro. *SeeItSayItLabel*'s visibility is controlled by [`Interactable`](README_Interactable.md)'s theme.
5454

Documentation/README_FingertipVisualization.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Fingertip Visualization
2-
![Fingertip Visualization](/External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_Main.png)
2+
![Fingertip Visualization](../External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_Main.png)
33

44
The fingertip affordance helps the user recognize the distance from the target object. The ring shape visual adjusts its size based on the distance from the fingertip to the object. The fingertip visualization is primarily controlled by the `FingerCursor` prefab (and script) which is spawned as the cursor prefab of the `PokePointer`. Other components of the visualization include the `ProximityLight` script, and `MixedRealityStandard` shader.
55

@@ -18,7 +18,7 @@ At a high level the fingertip visualization works by using a proximity light to
1818

1919
You can find fingertip visualization examples in almost any scene that works with articulated hands, but is prominent in the HandInteractionExamples.unity scene.
2020

21-
![Fingertip Visualization](/External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_States.png)
21+
![Fingertip Visualization](../External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_States.png)
2222

2323
### Inspector Properties ###
2424

@@ -28,7 +28,7 @@ You can find fingertip visualization examples in almost any scene that works wit
2828
Many of the FingerCursor properties are inherited from the BaseCursor class. Important properties include the far/near surface margins and widths which drive the finger ring animation in the MixedRealityStandard shader. For other properties please hover over the inspector tool tips.
2929

3030
#### ProximityLight ####
31-
![Fingertip Visualization](/External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_Proximity_Light_Inspector.png)
31+
![Fingertip Visualization](../External/ReadMeImages/Fingertip/MRTK_FingertipVisualization_Proximity_Light_Inspector.png)
3232

3333
The proximity light settings control how the light looks when near and far from a surface. The center, middle, and outer colors control the gradient look of the light and can be custom tailored for the color palette of your application. Note, the colors are HDR (High Dynamic Range) to allow users to brighten the proximity light to values above one. For other properties please hover over the inspector tool tips.
3434

Documentation/README_HandInteractionExamples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Hand Interaction Examples scene
2-
![Hand Interaction Examples](/External/ReadMeImages/MRTK_Examples.png)
2+
![Hand Interaction Examples](../External/ReadMeImages/MRTK_Examples.png)
33

44
In this example scene, you can find various types of interactions and UI controls that supports HoloLens2's articulated hand input.
55
You can find the **HandInteractionExamples.unity** scene under **Assets\MixedRealityToolkit.Examples\Demos\HandTracking\Scenes**
@@ -15,20 +15,20 @@ You can find the **HandInteractionExamples.unity** scene under **Assets\MixedRea
1515

1616
## Pressable Button
1717
See [Button](README_Button.md) page for the details.
18-
![Hand Interaction Examples](/External/ReadMeImages/HandInteractionExamples/MRTK_Examples_PressTouch.png)
18+
![Hand Interaction Examples](../External/ReadMeImages/HandInteractionExamples/MRTK_Examples_PressTouch.png)
1919

2020
## Bounding Box
2121
See [Bounding Box](README_BoundingBox.md) page for the details.
22-
![Hand Interaction Examples](/External/ReadMeImages/HandInteractionExamples/MRTK_Examples_BoundingBox.png)
22+
![Hand Interaction Examples](../External/ReadMeImages/HandInteractionExamples/MRTK_Examples_BoundingBox.png)
2323

2424
## Manipulation Handler
2525
See [Manipulation Handler](README_ManipulationHandler.md) page for the details.
26-
![Hand Interaction Examples](/External/ReadMeImages/HandInteractionExamples/MRTK_Examples_Manipulation.png)
26+
![Hand Interaction Examples](../External/ReadMeImages/HandInteractionExamples/MRTK_Examples_Manipulation.png)
2727

2828
## Slate
2929
See [Slate](README_Slate.md) page for the details.
30-
![Hand Interaction Examples](/External/ReadMeImages/HandInteractionExamples/MRTK_Examples_Slate.png)
30+
![Hand Interaction Examples](../External/ReadMeImages/HandInteractionExamples/MRTK_Examples_Slate.png)
3131

3232
## System Keyboard
3333
See [System Keyboard](README_SystemKeyboard.md) page for the details.
34-
![Hand Interaction Examples](/External/ReadMeImages/HandInteractionExamples/MRTK_Examples_Keyboard.png)
34+
![Hand Interaction Examples](../External/ReadMeImages/HandInteractionExamples/MRTK_Examples_Keyboard.png)

Documentation/README_Interactable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Interactable
2-
![Interactable](/External/ReadMeImages/Interactable/InteractableExamples.png)
2+
![Interactable](../External/ReadMeImages/Interactable/InteractableExamples.png)
33

44
## How to use Interactable
55
Add the Interactable Component to a GameObject
66

7-
![Interactable](/External/ReadMeImages/Interactable/InteractableInspector_basicSteps.png)
7+
![Interactable](../External/ReadMeImages/Interactable/InteractableInspector_basicSteps.png)
88

99
1. A Collider must exist on the GameObject with the Interactable or the child of the Interactable for it to receive input.
1010
2. Use the OnClick event to make something happen.

Documentation/README_ManipulationHandler.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Manipulation Handler
2-
![Manipulation Handler](/External/ReadMeImages/ManipulationHandler/MRTK_Manipulation_Main.png)
2+
![Manipulation Handler](../External/ReadMeImages/ManipulationHandler/MRTK_Manipulation_Main.png)
33

44
The ManipulationHandler script allows for an object to be made movable, scalable, and rotatable using one or two hands. Manipulation can be restricted so that it only allows certain kinds of transformation.
55
The script works with various types of inputs including HoloLens 2 articulated hand input, hand-rays, HoloLens gesture input, and immersive headset motion controller input.
@@ -9,7 +9,7 @@ The script works with various types of inputs including HoloLens 2 articulated h
99

1010
In the inspector panel, you will be able to find various options that you can configure. Make sure to add a Collidable to your object -- the collidable should match the grabbable bounds of the object. To make it respond to near articulated hand input, you need to add the NearInteractionGrabbable.cs script as well. 
1111

12-
![Manipulation Handler](/External/ReadMeImages/ManipulationHandler/MRTK_ManipulationHandler_Howto.png)
12+
![Manipulation Handler](../External/ReadMeImages/ManipulationHandler/MRTK_ManipulationHandler_Howto.png)
1313

1414

1515
## Inspector Properties
@@ -26,7 +26,7 @@ Specifies whether the object can be manipulated using one hand, two hands, or bo
2626

2727
### Two Handed Manipulation Type
2828

29-
![Manipulation Handler](/External/ReadMeImages/ManipulationHandler/MRTK_ManipulationHandler_TwoHanded.jpg)
29+
![Manipulation Handler](../External/ReadMeImages/ManipulationHandler/MRTK_ManipulationHandler_TwoHanded.jpg)
3030

3131
* Scale
3232
* Rotate
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Object Collection
2-
![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Main.png)
2+
![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Main.png)
33

44
Object collection is a script which helps you lay out an array of objects in predefined three-dimensional shapes. It supports five different surface styles - plane, cylinder, sphere, scatter, and radial. You can adjust the radius, size and the space between the items. Since it supports any object in Unity, you can use it to layout both 2D and 3D objects.
55

66
## Object collection examples ##
77
Periodic Table of the Elements is an example app that demonstrates how Object collection works. It uses Object collection to layout the 3D element boxes in different shapes.
88

9-
![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Types.jpg)
9+
![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Types.jpg)
1010

1111
### 3D Objects ###
1212

1313
You can use Object collection to layout imported 3D objects. The example below shows the plane and cylindrical layouts of 3D chair model objects using Object collection.
1414

15-
![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_3DObjects.jpg)
15+
![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_3DObjects.jpg)
1616

1717
### 2D Objects ###
1818

1919
You can also use 2D images with Object collection. For example, you can easily display multiple images in grid style using Object collection.
2020

21-
![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Layout_2DImages.jpg)
21+
![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Layout_2DImages.jpg)
2222

2323
## Ways to use Object collection ##
2424
You can find the examples in the scene **ObjectCollection_Examples.unity**. In this scene, you can find the **ObjectCollection.cs** script under **MixedRealityToolkit.SDK\Features\UX\Scripts\Collections**
@@ -28,6 +28,6 @@ You can find the examples in the scene **ObjectCollection_Examples.unity**. In t
2828
3. Once you finished adding a child object, click the **Update Collection** button in the Inspector Panel.
2929
4. You will then see the object(s) laid out in selected Surface Type.
3030

31-
![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Unity.jpg)
31+
![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_Unity.jpg)
3232

33-
![Object Collection](/External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_ExampleScene1.jpg)
33+
![Object Collection](../External/ReadMeImages/ObjectCollection/MRTK_ObjectCollection_ExampleScene1.jpg)

Documentation/README_Pointers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Pointers
2-
![Pointer](/External/ReadMeImages/Pointers/MRTK_Pointer_Main.png)
2+
![Pointer](../External/ReadMeImages/Pointers/MRTK_Pointer_Main.png)
33

44
A pointer is something attached to a controller that gives focus and dispatches inputs to the game object it is pointing to <sup>[1](https://github.com/luis-valverde-ms/MixedRealityToolkit-Unity/blob/feature/input_docs/Documentation/Input/InputSystem.md)</sup>.
55

@@ -9,7 +9,7 @@ Pointers are instantiated automatically at runtime when a new controller is dete
99

1010
MRTK provides a set of pointer prefabs in _Assets/MixedRealityToolkit.SDK/Features/UX/Prefabs/Pointers_. You can use your own prefabs as long as they contain one of the pointer scripts in _Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Pointers_ or any other script implementing `IMixedRealityPointer`.
1111

12-
![Pointer Profile](/External/ReadMeImages/Pointers/MRTK_PointerProfile.jpg)
12+
![Pointer Profile](../External/ReadMeImages/Pointers/MRTK_PointerProfile.jpg)
1313

1414
## MRTK Pointer Prefabs
1515

@@ -59,7 +59,7 @@ Poke pointer is for near interactions, specifically for touching objects via the
5959

6060

6161
### Mouse pointer
62-
![Mouse Pointer](/External/ReadMeImages/Pointers/MRTK_MousePointer.jpg)
62+
![Mouse Pointer](../External/ReadMeImages/Pointers/MRTK_MousePointer.jpg)
6363

6464
Mouse pointer is used for interacting with the mouse.
6565

0 commit comments

Comments
 (0)