Skip to content

Commit 63ed7b6

Browse files
committed
fix(DOCUMENTATION): add missing controls content handler docs
The documentation for the 3D controls content handler was missing due to the header of the file being named incorrectly. This has now been updated and the documentation regenerated.
1 parent eb1a0a5 commit 63ed7b6

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

Assets/VRTK/Scripts/Controls/3D/Utilities/VRTK_ContentHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Slider|Controls3D|0080
1+
// Content Handler|Controls3D|0090
22
namespace VRTK
33
{
44
using UnityEngine;

DOCUMENTATION.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2774,6 +2774,7 @@ All 3D controls extend the `VRTK_Control` abstract class which provides common m
27742774
* [Lever](#lever-vrtk_lever)
27752775
* [Spring Lever](#spring-lever-vrtk_spring_lever)
27762776
* [Slider](#slider-vrtk_slider)
2777+
* [Content Handler](#content-handler-vrtk_contenthandler)
27772778

27782779
---
27792780

@@ -3033,3 +3034,23 @@ The script will instantiate the required Rigidbody and Interactable components a
30333034

30343035
---
30353036

3037+
## Content Handler (VRTK_ContentHandler)
3038+
3039+
### Overview
3040+
3041+
Manages objects defined as content. When taking out an object from a drawer and closing the drawer this object would otherwise disappear even if outside the drawer.
3042+
3043+
The script will use the boundaries of the control to determine if it is in or out and re-parent the object as necessary. It can be put onto individual objects or the parent of multiple objects. Using the latter way all interactable objects under that parent will become managed by the script.
3044+
3045+
### Inspector Parameters
3046+
3047+
* **Control:** The 3D control responsible for the content.
3048+
* **Inside:** The transform containing the meshes or colliders that define the inside of the control.
3049+
* **Outside:** Any transform that will act as the parent while the object is not inside the control.
3050+
3051+
### Example
3052+
3053+
`VRTK/Examples/025_Controls_Overview` has a drawer with a collection of items that adhere to this concept.
3054+
3055+
---
3056+

0 commit comments

Comments
 (0)