Immerse

The Handle component is a core part of the Interaction. These are what allow a user to 'grab' an object.

Handle component as it appears in the InspectorHandle component as it appears in the Inspector

Handle component as it appears in the Inspector

Description

Rigidbody

The Rigidbody that forces should be applied to. This can be on the same GameObject but is often found on a parent.

Physics Settings

Physics configuration to use for this interaction

Keep Hand Offset

If the positional and rotational offset of the hand should be retained when engaging the Handle.

Haptic Feedback

Haptic feedback settings (see Haptic Feedback)

Events

On Hover Enter - Triggered when a Handle enters range to be grabbed
On Hover Exit - Triggered when a Handle leaves range to be grabbed
On Grab - Triggered when the Handle is grabbed
On Release - Triggered when the Handle is released

Creating a Handle

Add Component

The most common way to add a Handle to a GameObject is by using the Add Component menu. The Handle can be in the Component menu: Component > Immerse > Interaction > Interactable > Handle

Add GameObject

An alternative way to add a Handle to a GameObject is by using the GameObject menu entry: GameObject > Create Other > Immerse > Interaction > Handle With the object you wish to pick up selected in the Unity editor, this menu item will create a new child with a Handle component targeting the Rigidbody in the parent.

Updated about a month ago

Handles


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.