Skip to content

Commit

Permalink
fix(DOCUMENTATION): add missing controls content handler docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
thestonefox committed Sep 19, 2016
1 parent eb1a0a5 commit 63ed7b6
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Slider|Controls3D|0080
// Content Handler|Controls3D|0090
namespace VRTK
{
using UnityEngine;
Expand Down
21 changes: 21 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2774,6 +2774,7 @@ All 3D controls extend the `VRTK_Control` abstract class which provides common m
* [Lever](#lever-vrtk_lever)
* [Spring Lever](#spring-lever-vrtk_spring_lever)
* [Slider](#slider-vrtk_slider)
* [Content Handler](#content-handler-vrtk_contenthandler)

---

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

---

## Content Handler (VRTK_ContentHandler)

### Overview

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.

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.

### Inspector Parameters

* **Control:** The 3D control responsible for the content.
* **Inside:** The transform containing the meshes or colliders that define the inside of the control.
* **Outside:** Any transform that will act as the parent while the object is not inside the control.

### Example

`VRTK/Examples/025_Controls_Overview` has a drawer with a collection of items that adhere to this concept.

---

Expand Down

0 comments on commit 63ed7b6

Please sign in to comment.