Skip to content

Commit 7f56c6b

Browse files
author
David Kline
authored
Merge pull request #8709 from thalbern/user/bethalha/readme_bc_update
Replaced mentions of bounding box with bounds control
2 parents 3825f2e + 5f0e59a commit 7f56c6b

8 files changed

+13
-13
lines changed

Documentation/Contributing/DocumentationGuide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ General rule of thumb: Try to **sound professional**. That usually means to avoi
113113

114114
* Use **Sentence case for headlines**. Ie. capitalize the first letter and names, but nothing else.
115115
* Use regular English for everything else. That means **do not capitalize arbitrary words**, even if they hold a special meaning in that context. Prefer *italic text* for highlighting certain words, [see below](#emphasis-and-highlighting).
116-
* When a link is embedded in a sentence (which is the preferred method), the standard chapter name always uses capital letters, thus breaking the rule of no arbitrary capitalization inside text. Therefore use a custom link name to fix the capitalization. As an example, here is a link to the [bounding box](../README_BoundingBox.md) documentation.
116+
* When a link is embedded in a sentence (which is the preferred method), the standard chapter name always uses capital letters, thus breaking the rule of no arbitrary capitalization inside text. Therefore use a custom link name to fix the capitalization. As an example, here is a link to the [bounds control](../README_BoundsControl.md) documentation.
117117
* Do capitalize names, such as *Unity*.
118118
* Do NOT capitalize "editor" when writing *Unity editor*.
119119

Documentation/README_AppBar.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
![App bar](../Documentation/Images/AppBar/MRTK_AppBar_Main.png)
44

5-
App bar is a UI component that is used together with the [bounding box](README_BoundingBox.md) script. It adds button controls to an object with the intent to manipulate it. Using the 'Adjust' button, the bounding box interface for an object can be de- / activated. The "Remove" button should remove the object from the scene.
5+
App bar is a UI component that is used together with the [bounds control](README_BoundsControl.md) script. It adds button controls to an object with the intent to manipulate it. Using the 'Adjust' button, the bounds control interface for an object can be de- / activated. The "Remove" button should remove the object from the scene.
66

77
## How to use app bar
88

9-
Drag and drop `AppBar` (Assets/MRTK/SDK/Features/UX/Prefabs/AppBar/AppBar.prefab) into the scene hierarchy. In the inspector panel of the component, assign any object with a bounding box as the *Target Bounding Box* to add the app bar to it.
9+
Drag and drop `AppBar` (Assets/MRTK/SDK/Features/UX/Prefabs/AppBar/AppBar.prefab) into the scene hierarchy. In the inspector panel of the component, assign any object with a bounds control as the *Target Bounding Box* to add the app bar to it.
1010

11-
**Important:** The bounding box activation option for the target object should be 'Activate Manually'.
11+
**Important:** The bounds control activation option for the target object should be 'Activate Manually'.
1212

1313
<img src="../Documentation/Images/AppBar/MRTK_AppBar_Setup1.png" width="450">
1414

Documentation/README_HandInteractionExamples.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ If you see large text after the TextMesh Pro import, open another Unity scene an
1818
See [button](README_Button.md) page for the details.
1919
![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_PressTouch.png)
2020

21-
## Bounding box
21+
## Bounds Control
2222

23-
See [bounding box](README_BoundingBox.md) page for the details.
23+
See [bounds control](README_BoundsControl.md) page for the details.
2424
![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_BoundingBox.png)
2525

2626
## Manipulation handler

Documentation/README_ManipulationHandler.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Specifies how the object will rotate when it is being grabbed with one hand.
5151

5252
* *Maintain original rotation*: Does not rotate object as it is being moved
5353
* *Maintain rotation to user*: Maintains the object's original rotation for X/Y axis to the user
54-
* *Gravity aligned maintain rotation to user*: Maintains object's original rotation to user, but makes the object vertical. Useful for bounding boxes.
54+
* *Gravity aligned maintain rotation to user*: Maintains object's original rotation to user, but makes the object vertical. Useful for objects with a bounds control.
5555
* *Face user*: Ensures object always faces the user. Useful for slates/panels.
5656
* *Face away from user*: Ensures object always faces away from user. Useful for slates/panels that are configured backwards.
5757
* *Rotate about object center*: Only works for articulated hands/controllers. Rotate object using rotation of the hand/controller, but about the object center point. Useful for inspecting at a distance.

Documentation/README_NearMenu.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Adjust the size of the `Quad` under `Backplate` object. The width and height of
6565
## See also
6666

6767
- [**Buttons**](README_Button.md)
68-
- [**Bounding Box**](README_BoundingBox.md)
68+
- [**Bounds Control**](README_BoundsControl.md)
6969
- [**Slider**](README_Sliders.md)
7070
- [**Grid Object Collection**](README_ObjectCollection.md)
7171
- [**Manipulation Handler**](README_ManipulationHandler.md)

Documentation/README_Slate.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ A slate control is composed of the following elements:
1616

1717
<img src="../Documentation/Images/Slate/MRTK_SlateStructure.jpg" width="650">
1818

19-
## Bounding box
19+
## Bounds control
2020

21-
A slate control contains a bounding box script for scaling and rotating. For more information on bounding box, please see the [Bounding box](README_BoundingBox.md) page.
21+
A slate control contains a bounds control script for scaling and rotating. For more information on bounds control, please see the [bounds control](README_BoundsControl.md) page.
2222

2323
<img src="../Documentation/Images/Slate/MRTK_Slate_BB.jpg" width="650">
2424

Documentation/README_Toolbox.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Toolbox UI
22

3-
The MRTK Toolbox is a Unity editor window utility that makes it easy to discover and spawn MRTK UX prefab components into the current scene. Items can be filtered in view by using the search bar at the top of the window. The toolbox window is designed to spawn MRTK out-of-box prefabs into the current scene. There are additional "UX" components that can be added as script components such as the [Bounding Box](README_BoundingBox.md) or [Manipulation Handler](README_ManipulationHandler.md) controls.
3+
The MRTK Toolbox is a Unity editor window utility that makes it easy to discover and spawn MRTK UX prefab components into the current scene. Items can be filtered in view by using the search bar at the top of the window. The toolbox window is designed to spawn MRTK out-of-box prefabs into the current scene. There are additional "UX" components that can be added as script components such as the [bounds control](README_BoundsControl.md) or [object manipulator](README_ObjectManipulator.md) controls.
44

55
![MRTK Toolbox](Images/Tools/MRTKToolboxWindow.png)
66

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If you're an experienced Mixed Reality or MRTK developer, check the links in the
5050

5151
# UX building blocks
5252

53-
| [![Button](Documentation/Images/Button/MRTK_Button_Main.png)](Documentation/README_Button.md) [Button](Documentation/README_Button.md) | [![Bounding Box](Documentation/Images/BoundingBox/MRTK_BoundingBox_Main.png)](Documentation/README_BoundingBox.md) [Bounding Box](Documentation/README_BoundingBox.md) | [![Object Manipulator](Documentation/Images/ManipulationHandler/MRTK_Manipulation_Main.png)](Documentation/README_ObjectManipulator.md) [Object Manipulator](Documentation/README_ObjectManipulator.md) |
53+
| [![Button](Documentation/Images/Button/MRTK_Button_Main.png)](Documentation/README_Button.md) [Button](Documentation/README_Button.md) | [![Bounds Control](Documentation/Images/BoundsControl/MRTK_BoundsControl_Main.png)](Documentation/README_BoundsControl.md) [Bounds Control](Documentation/README_BoundsControl.md) | [![Object Manipulator](Documentation/Images/ManipulationHandler/MRTK_Manipulation_Main.png)](Documentation/README_ObjectManipulator.md) [Object Manipulator](Documentation/README_ObjectManipulator.md) |
5454
|:--- | :--- | :--- |
5555
| A button control which supports various input methods, including HoloLens 2's articulated hand | Standard UI for manipulating objects in 3D space | Script for manipulating objects with one or two hands |
5656
| [![Slate](Documentation/Images/Slate/MRTK_Slate_Main.png)](Documentation/README_Slate.md) [Slate](Documentation/README_Slate.md) | [![System Keyboard](Documentation/Images/SystemKeyboard/MRTK_SystemKeyboard_Main.png)](Documentation/README_SystemKeyboard.md) [System Keyboard](Documentation/README_SystemKeyboard.md) | [![Interactable](Documentation/Images/Interactable/InteractableExamples.png)](Documentation/README_Interactable.md) [Interactable](Documentation/README_Interactable.md) |
@@ -60,7 +60,7 @@ If you're an experienced Mixed Reality or MRTK developer, check the links in the
6060
| [![Slider](Documentation/Images/Slider/MRTK_UX_Slider_Main.jpg)](Documentation/README_Sliders.md) [Slider](Documentation/README_Sliders.md) | [![MRTK Standard Shader](Documentation/Images/MRTKStandardShader/MRTK_StandardShader.jpg)](Documentation/README_MRTKStandardShader.md) [MRTK Standard Shader](Documentation/README_MRTKStandardShader.md) | [![Hand Menu](Documentation/Images/Solver/MRTK_UX_HandMenu.png)](Documentation/README_HandMenu.md) [Hand Menu](Documentation/README_HandMenu.md) |
6161
| Slider UI for adjusting values supporting direct hand tracking interaction | MRTK's Standard shader supports various Fluent design elements with performance | Hand-locked UI for quick access, using the Hand Constraint Solver |
6262
| [![App Bar](Documentation/Images/AppBar/MRTK_AppBar_Main.png)](Documentation/README_AppBar.md) [App Bar](Documentation/README_AppBar.md) | [![Pointers](Documentation/Images/Pointers/MRTK_Pointer_Main.png)](Documentation/Input/Pointers.md) [Pointers](Documentation/Input/Pointers.md) | [![Fingertip Visualization](Documentation/Images/Fingertip/MRTK_FingertipVisualization_Main.png)](Documentation/README_FingertipVisualization.md) [Fingertip Visualization](Documentation/README_FingertipVisualization.md) |
63-
| 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 |
63+
| UI for Bounds Control's manual activation | Learn about various types of pointers | Visual affordance on the fingertip which improves the confidence for the direct interaction |
6464
| [![Near Menu](Documentation/Images/NearMenu/MRTK_UX_NearMenu.png)](Documentation/README_NearMenu.md) [Near Menu](Documentation/README_NearMenu.md) | [![Spatial Awareness](Documentation/Images/SpatialAwareness/MRTK_SpatialAwareness_Main.png)](Documentation/SpatialAwareness/SpatialAwarenessGettingStarted.md) [Spatial Awareness](Documentation/SpatialAwareness/SpatialAwarenessGettingStarted.md) | [![Voice Command](Documentation/Images/Input/MRTK_Input_Speech.png)](Documentation/Input/Speech.md) [Voice Command](Documentation/Input/Speech.md) / [Dictation](Documentation/Input/Dictation.md) |
6565
| Floating menu UI for the near interactions | Make your holographic objects interact with the physical environments | Scripts and examples for integrating speech input |
6666
| [![Progress Indicator](Documentation/Images/ProgressIndicator/MRTK_ProgressIndicator_Main.png)](Documentation/README_ProgressIndicator.md) [Progress Indicator](Documentation/README_ProgressIndicator.md) | [![Dialog](Documentation/Images/Dialog/MRTK_UX_Dialog_Main.png)](Assets/MRTK/SDK/Experimental/Dialog/README_Dialog.md) [Dialog [Experimental]](Assets/MRTK/SDK/Experimental/Dialog/README_Dialog.md) | [![Hand Coach](Documentation/Images/HandCoach/MRTK_UX_HandCoach_Main.jpg)](Assets/MRTK/SDK/Experimental/HandCoach/README_HandCoach.md) [Hand Coach [Experimental]](Assets/MRTK/SDK/Experimental/HandCoach/README_HandCoach.md) |

0 commit comments

Comments
 (0)