Guides
These docs are for v3.2.0. Click to read the latest docs for v3.3.0.

VRTK_Drawer

extends VRTK_Control

Overview

Transforms a game object into a drawer. The direction can be freely set and also auto-detected with very high reliability.

The script will instantiate the required Rigidbody, Interactable and Joint components automatically in case they do not exist yet. There are situations when it can be very hard to automatically calculate the correct axis for the joint. If this situation is encountered simply add the configurable joint manually and set the axis. All the rest will still be handled by the script.

It will expect two distinct game objects: a body and a handle. These should be independent and not children of each other. The distance to which the drawer can be pulled out will automatically set depending on the length of it. If no body is specified the current object is assumed to be the body.

It is possible to supply a third game object which is the root of the contents inside the drawer. When this is specified the VRTK_InteractableObject components will be automatically deactivated in case the drawer is closed or not yet far enough open. This eliminates the issue that a user could grab an object inside a drawer although it is closed.

Inspector Parameters

  • Connected To: An optional game object to which the drawer will be connected. If the game object moves the drawer will follow along.
  • Direction: The axis on which the drawer should open. All other axis will be frozen.
  • Body: The game object for the body.
  • Handle: The game object for the handle.
  • Content: The parent game object for the drawer content elements.
  • Hide Content: Makes the content invisible while the drawer is closed.
  • Min Snap Close: If the extension of the drawer is below this percentage then the drawer will snap shut.
  • Max Extend: The maximum percentage of the drawer's total length that the drawer will open to.

Example

VRTK/Examples/025_Controls_Overview shows a drawer with contents that can be opened and closed freely and the contents can be removed from the drawer.